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"
    },
    "learning_object_external_reference": "learning-content-123",
    "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",
    "user_id": "c28xyrc55866bvuv",
    "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "time_spent": "PT1H30M45S",
    "certificate_url": "https://example.com/certificate/12345",
    "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",
    "score": {
      "percentage": 87,
      "raw_value": "87 / 100"
    }
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

lms

completions

{id}

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"
    },
    "learning_object_external_reference": "learning-content-123",
    "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",
    "user_id": "c28xyrc55866bvuv",
    "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "time_spent": "PT1H30M45S",
    "certificate_url": "https://example.com/certificate/12345",
    "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",
    "score": {
      "percentage": 87,
      "raw_value": "87 / 100"
    }
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy

object

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields to return in the response (if empty, all fields are returned)

Response

The completion with the given identifier was retrieved.

data

object

required

Show child attributes

data.id

string | null

The ID associated with this completion

Example:

"123456"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.learning_object_external_reference

string | null

The external reference of the learning object associated with this completion, this is the main identifier for creating completions.

Example:

"learning-content-123"

data.external_reference

string | null

deprecated

The external reference associated with this completion

Example:

"e3gd34-23tr21-er234-345er56"

data.result

object

The result of the completion

Show child attributes

data.result.value

enum<string> | null

The StackOne unified result status.

Available options:

Pass,

Fail,

unmapped_value,

data.result.source_value

The original result status from the provider before normalization.

data.completed_at

string<date-time> | null

The date the content was completed

Example:

"2021-07-21T14:00:00.000Z"

data.created_at

string<date-time> | null

The created date of the completion

Example:

"2021-07-21T14:00:00.000Z"

data.updated_at

string<date-time> | null

The updated date of the completion

Example:

"2021-07-21T14:00:00.000Z"

data.learning_object_type

object

The learning object type of the completion

Show child attributes

data.learning_object_type.value

enum<string> | null

The StackOne unified learning object type.

Available options:

content,

course,

collection,

unmapped_value,

data.learning_object_type.source_value

The original learning object type from the provider before normalization.

data.learning_object_id

string | null

The id of the learning object associated with this completion. This is not required unless specified in an integration.

Example:

"e3gd34-23tr21-er234-345er56"

data.remote_learning_object_id

string | null

Provider's unique identifier of the learning object related to the completion

Example:

"e3cb55bf-aa84-466e-a6c1-b8302b257a49"

data.user_id

string | null

The user ID associated with this completion

Example:

"c28xyrc55866bvuv"

data.remote_user_id

string | null

Provider's unique identifier of the user related to the completion

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.time_spent

string<string> | null

ISO 8601 duration format representing the time spent on completing the learning object

Example:

"PT1H30M45S"

data.certificate_url

string | null

The certification URL associated with this completion

Example:

"https://example.com/certificate/12345"

data.external_id

string | null

deprecated

The external ID associated with this completion

Example:

"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION"

data.content_external_reference

string | null

deprecated

The external reference associated with this content

Example:

"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT"

data.remote_external_id

string | null

deprecated

Provider's unique identifier of the content external reference

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.content_id

string | null

deprecated

The content ID associated with this completion

Example:

"16873-ENG-VIDEO-1"

data.remote_content_id

string | null

deprecated

Provider's unique identifier of the content associated with the completion

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.course_id

string | null

deprecated

The course ID associated with this completion

Example:

"16873-ENG-COURSE-1"

data.remote_course_id

string | null

deprecated

Provider's unique identifier of the course associated with the completion

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.score

object

The score associated with this completion

Show child attributes

data.score.percentage

number | null

The score percentage

Example:

87.5

data.score.raw_value

string | null

The raw string score value

Example:

87

Example:

{ "percentage": 87, "raw_value": "87 / 100" }

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

List Completions Get Category

⌘I

Getting Started

Use Cases

API Reference

Get Completion

Authorizations

Headers

Path Parameters

Query Parameters

Response