v1

latestOpenAPI 3.1.02026-07-122360148.3 KB

External Linking Learning Objects

Batch Upsert External Linking Learning Objects

Batch upsert multiple external linking learning objects that redirect users to a provider platform for consumption and progress tracking.

Note: Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content.

See here for more information about external linking learning objects.

post/unified/lms/content/batch

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

Example request

{
  "items": [
    {
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "title": "Software Engineer Lv 1",
      "description": "This video acts as learning content for software engineers.",
      "languages": [
        {
          "value": "en_GB"
        }
      ],
      "content_url": "https://www.youtube.com/watch?v=16873",
      "mobile_launch_content_url": "https://www.mobile.youtube.com/watch?v=16873",
      "cover_url": "https://www.googledrive.com/?v=16873",
      "duration": "P3Y6M4DT12H30M5S",
      "skills": [
        {
          "id": "12345",
          "name": "Sales Techniques"
        }
      ],
      "order": 1,
      "short_description": "This course is a valuable resource and acts as learning content for...",
      "localizations": [
        {
          "title": "Software Engineer Lv 1",
          "description": "This course acts as learning resource for software engineers.",
          "languages": {
            "value": "en-GB",
            "source_value": "string"
          }
        },
        {
          "title": "Software Engineer: A comprehensive guide",
          "description": "This course acts as learning resource for software engineers.",
          "languages": {
            "value": "en-US",
            "source_value": "string"
          }
        }
      ],
      "tags": [
        "Sales Techniques",
        "Customer Service"
      ],
      "authors": [
        {
          "id": "123",
          "name": "John Doe"
        }
      ],
      "updated_at": "2021-07-21T14:00:00.000Z",
      "created_at": "2021-07-21T14:00:00.000Z",
      "passthrough": {
        "other_known_names": "John Doe"
      },
      "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1",
      "categories": [
        {
          "id": "16873-IT345",
          "unified_custom_fields": {
            "my_project_custom_field_1": "REF-1236",
            "my_project_custom_field_2": "some other value"
          },
          "name": "Information-Technology",
          "language": {
            "value": "en_GB"
          }
        }
      ],
      "additional_data": [
        {
          "id": "learning_outcomes",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
        }
      ]
    }
  ]
}

Response

Batch operation accepted

statusCodenumber nullable

messagestring nullable

timestampstring date-time nullable

Example response

{
  "statusCode": 202,
  "message": "Batch operation accepted",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "errors": [
    [
      "Missing field: name"
    ],
    [],
    []
  ]
}