v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

External IDs

Replace an ID mapping

🔑

Required OAuth scope: externalIds:write.

Replaces an existing external ID mapping with the provided data.

put/api/v2/external-ids/{mappingId}

Path parameters

mappingIdstring ObjectId required

Example:507f1f77bcf86cd799439011

The unique ID that identifies the resources mapping.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

platformstring required

The name of the platform where the external ID comes from.

targetIdstring ObjectId required

The resource ID to which the external ID is linked.

targetType'attempt' | 'classroom' | 'classroomAttendance' | 'classroomAttendanceSheet' | 'classroomSlot' | 'classroomSlotRegistration' | 'course' | 'group' | 'learningNeed' | 'path' | 'pathEnrollment' | 'pathSession' | 'pathTracking' | 'registrationRequest' | 'user' required

The resource type to which the external ID is linked.

valuestring required

The value of the external ID.

Example request

{
  "platform": "external catalog",
  "targetId": "507f1f77bcf86cd799439011",
  "targetType": "course",
  "value": "945628-01"
}

Response

Returns the updated external ID mapping.

platformstring required

The name of the platform where the external ID comes from.

targetIdstring ObjectId required

The resource ID to which the external ID is linked.

targetType'attempt' | 'classroom' | 'classroomAttendance' | 'classroomAttendanceSheet' | 'classroomSlot' | 'classroomSlotRegistration' | 'course' | 'group' | 'learningNeed' | 'path' | 'pathEnrollment' | 'pathSession' | 'pathTracking' | 'registrationRequest' | 'user' required

The resource type to which the external ID is linked.

valuestring required

The value of the external ID.

_idstring ObjectId required

The unique ID that identifies the resources mapping.

Example response

{
  "platform": "external catalog",
  "targetId": "507f1f77bcf86cd799439011",
  "targetType": "course",
  "value": "945628-01",
  "_id": "507f1f77bcf86cd799439011"
}