Collections
Create Collection
Common Guides
API Reference
- Courses
- Users
- Content
- Completions
- Categories
- Skills
- Assignments
- Collections
Collections
Create Collection
POST
/
unified
/
lms
/
collections
curl --request POST \
--url https://api.stackone.com/unified/lms/collections \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"external_reference": "SOFTWARE-ENG-LV1-TRAINING-collection-1",
"learning_object_ids": [
"16873-SOFTWARE-ENG-COURSE",
"16874-SOFTWARE-ENG-COURSE"
],
"remote_learning_object_ids": [
"e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"e3cb75bf-aa84-466e-a6c1-b8322b257a49"
],
"title": "Software Engineer Lv 1 Collection",
"description": "This collection acts as learning pathway for software engineers.",
"languages": [
"<string>"
],
"cover_url": "https://www.googledrive.com/?v=16873",
"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",
"hierarchy": {
"value": "primary",
"source_value": "<string>"
},
"level": {
"value": "primary",
"source_value": "<string>"
},
"language": {
"value": "en_GB",
"source_value": "<string>"
}
}
],
"skills": [
{
"id": "16873-IT345",
"name": "Information-Technology",
"hierarchy": {
"value": "primary",
"source_value": "<string>"
},
"language": {
"value": "en_GB",
"source_value": "<string>"
},
"level": {
"value": "primary",
"source_value": "<string>"
}
}
]
}'
{
"statusCode": 201,
"message": "Record created successfully.",
"timestamp": "2021-01-01T01:01:01.000Z",
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
}
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Body
application/json
Response
201
application/json
The collection was created successfully.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.stackone.com/unified/lms/collections \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"external_reference": "SOFTWARE-ENG-LV1-TRAINING-collection-1",
"learning_object_ids": [
"16873-SOFTWARE-ENG-COURSE",
"16874-SOFTWARE-ENG-COURSE"
],
"remote_learning_object_ids": [
"e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"e3cb75bf-aa84-466e-a6c1-b8322b257a49"
],
"title": "Software Engineer Lv 1 Collection",
"description": "This collection acts as learning pathway for software engineers.",
"languages": [
"<string>"
],
"cover_url": "https://www.googledrive.com/?v=16873",
"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",
"hierarchy": {
"value": "primary",
"source_value": "<string>"
},
"level": {
"value": "primary",
"source_value": "<string>"
},
"language": {
"value": "en_GB",
"source_value": "<string>"
}
}
],
"skills": [
{
"id": "16873-IT345",
"name": "Information-Technology",
"hierarchy": {
"value": "primary",
"source_value": "<string>"
},
"language": {
"value": "en_GB",
"source_value": "<string>"
},
"level": {
"value": "primary",
"source_value": "<string>"
}
}
]
}'
{
"statusCode": 201,
"message": "Record created successfully.",
"timestamp": "2021-01-01T01:01:01.000Z",
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
}
}