Common Guides
API Reference
- Assignments
- Categories
- Collections
- Completions
- Content
- Courses
- Skills
- Users
Get Completion
curl --request GET \
--url https://api.stackone.com/unified/lms/completions/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'x-account-id: <x-account-id>'
{
"data": {
"id": "123456",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"external_reference": "e3gd34-23tr21-er234-345er56",
"result": {
"value": "Pass",
"source_value": "<string>"
},
"completed_at": "2021-07-21T14:00:00.000Z",
"created_at": "2021-07-21T14:00:00.000Z",
"updated_at": "2021-07-21T14:00:00.000Z",
"learning_object_type": {
"value": "content",
"source_value": "<string>"
},
"learning_object_id": "e3gd34-23tr21-er234-345er56",
"remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49",
"learning_object_external_reference": "learning-content-123",
"user_id": "c28xyrc55866bvuv",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"external_id": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION",
"content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT",
"remote_external_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"content_id": "16873-ENG-VIDEO-1",
"remote_content_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"course_id": "16873-ENG-COURSE-1",
"remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Path Parameters
Query Parameters
Indicates that the raw request result is returned
Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
The comma separated list of fields to return in the response (if empty, all fields are returned)
Response
The ID associated with this completion
"123456"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Custom Unified Fields configured in your StackOne project
{
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
}
The external reference associated with this completion
"e3gd34-23tr21-er234-345er56"
The date the content was completed
"2021-07-21T14:00:00.000Z"
The created date of the completion
"2021-07-21T14:00:00.000Z"
The updated date of the completion
"2021-07-21T14:00:00.000Z"
The id of the learning object associated with this completion. This is not required unless specified in an integration.
"e3gd34-23tr21-er234-345er56"
Provider's unique identifier of the learning object related to the completion
"e3cb55bf-aa84-466e-a6c1-b8302b257a49"
The external reference of the learning object associated with this completion, this is the main identifier for creating completions.
"learning-content-123"
The user ID associated with this completion
"c28xyrc55866bvuv"
Provider's unique identifier of the user related to the completion
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
The external ID associated with this completion
"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION"
The external reference associated with this content
"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT"
Provider's unique identifier of the content external reference
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
The content ID associated with this completion
"16873-ENG-VIDEO-1"
Provider's unique identifier of the content associated with the completion
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
The course ID associated with this completion
"16873-ENG-COURSE-1"
Provider's unique identifier of the course associated with the completion
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
Was this page helpful?
curl --request GET \
--url https://api.stackone.com/unified/lms/completions/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'x-account-id: <x-account-id>'
{
"data": {
"id": "123456",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"external_reference": "e3gd34-23tr21-er234-345er56",
"result": {
"value": "Pass",
"source_value": "<string>"
},
"completed_at": "2021-07-21T14:00:00.000Z",
"created_at": "2021-07-21T14:00:00.000Z",
"updated_at": "2021-07-21T14:00:00.000Z",
"learning_object_type": {
"value": "content",
"source_value": "<string>"
},
"learning_object_id": "e3gd34-23tr21-er234-345er56",
"remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49",
"learning_object_external_reference": "learning-content-123",
"user_id": "c28xyrc55866bvuv",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"external_id": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION",
"content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT",
"remote_external_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"content_id": "16873-ENG-VIDEO-1",
"remote_content_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"course_id": "16873-ENG-COURSE-1",
"remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}