v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Contents

Get Lms Content By Id

Returns an LMS Content object with the given id.

get/api/lms/v1/contents/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required

remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

titlestring nullable

The title of the content

descriptionstring nullable

The description of the content

languagesstring[] nullable

The languages of the content as locale codes (e.g. en_US, fr_FR, de_DE).

cover_imagestring nullable

The URL of the cover image of the content

urlstring nullable

The URL of the content

durationstring nullable

The duration of the content in ISO 8601 format

orderinteger nullable

Order of the content inside a course

providerstring nullable

The provider of the content

status'ACTIVE' | 'PENDING' | 'INACTIVE' nullable

The status of the content. If the value is not one of the defined enum values, the original value passed through will be returned.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "title": "NumPy Basics",
  "description": "Array manipulation",
  "languages": [
    "en_US",
    "en_GB"
  ],
  "cover_image": "https://img.example.com/numpy.png",
  "url": "https://lms.example.com/content/numpy",
  "duration": "PT45M",
  "order": 1,
  "provider": "Coursera",
  "status": "ACTIVE"
}