Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
External IDs

List all ID mappings

🔑

Required OAuth scope: externalIds:read.

📖

This endpoint is paginated with a page size of 5,000 external IDs. For more information, see the Pagination guide.

Lists all external ID mappings that link resources together.

get/api/v2/external-ids

Query parameters

eqstring

Filter on values equal to the given one

nestring

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on platform property with LHS bracket notation.

Expected value format is a string.

{
  "eq": "loremIpsum",
  "ne": "loremIpsum",
  "in": [
    "loremIpsum"
  ],
  "nin": [
    "loremIpsum"
  ]
}
eq'attempt' | 'classroom' | 'classroomAttendance' | 'classroomAttendanceSheet' | 'classroomSlot' | 'classroomSlotRegistration' | 'course' | 'group' | 'learningNeed' | 'path' | 'pathEnrollment' | 'pathSession' | 'pathTracking' | 'registrationRequest' | 'user'

Filter on values equal to the given one

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

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on type property with LHS bracket notation.

Expected value format is a string (attempt, classroom, classroomAttendance, classroomAttendanceSheet, classroomSlot, classroomSlotRegistration, course, group, learningNeed, path, pathEnrollment, pathSession, pathTracking, registrationRequest, user).

{
  "eq": "attempt",
  "ne": "attempt",
  "in": [
    "attempt"
  ],
  "nin": [
    "attempt"
  ]
}
eqstring

Filter on values equal to the given one

nestring

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on value property with LHS bracket notation.

Expected value format is a string.

{
  "eq": "loremIpsum",
  "ne": "loremIpsum",
  "in": [
    "loremIpsum"
  ],
  "nin": [
    "loremIpsum"
  ]
}
eqstring ObjectId

Filter on values equal to the given one

nestring ObjectId

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on targetId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011",
  "ne": "507f1f77bcf86cd799439011",
  "in": [
    "507f1f77bcf86cd799439011"
  ],
  "nin": [
    "507f1f77bcf86cd799439011"
  ]
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 5000 external IDs.

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"
  }
]