Get CourseItemDocument

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (CourseItemDocument)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CourseItemDocument

Example:

CourseItemDocument

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "CourseItemDocument",
        "attributes": {
            "title": "string",
            "description": "string",
            "customLabel": "string",
            "type": "document",
            "isReviewRequired": true,
            "shouldPreview": true,
            "allowDownload": true
        },
        "relationships": {
            "course": {
                "data": {
                    "id": "FID001",
                    "type": "Course"
                }
            },
            "folder": {
                "data": {
                    "id": "FID001",
                    "type": "CourseFolder"
                }
            },
            "document": {
                "data": {
                    "id": "FID001",
                    "type": "Content"
                }
            }
        }
    },
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Request

Request samples

Responses