Get Assignment

GET

unified

lms

assignments

{id}

curl --request GET \
  --url https://api.stackone.com/unified/lms/assignments/{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",
    "learning_object_id": "e3gd34-23tr21-er234-345er56",
    "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49",
    "learning_object_external_reference": "learning-content-123",
    "progress": "40",
    "updated_at": "2021-07-21T14:00:00.000Z",
    "created_at": "2021-07-21T14:00:00.000Z",
    "due_date": "2021-07-21T14:00:00.000Z",
    "status": {
      "value": "in-progress",
      "source_value": "<string>"
    },
    "learning_object_type": {
      "value": "content",
      "source_value": "<string>"
    },
    "user_id": "c28xyrc55866bvuv",
    "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "course_id": "16873-ENG-1",
    "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "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

default:false

Indicates that the raw request result is returned

proxy

object | null

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

200

application/json

The assignment with the given identifier was retrieved.

data

object

required

data.id

string | null

The ID associated with this assignment

Example:

"123456"

data.remote_id

string | null

Provider's unique identifier

Example:

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

data.unified_custom_fields

object | null

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.external_reference

string | null

deprecated

The external reference associated with this assignment

Example:

"e3gd34-23tr21-er234-345er56"

data.learning_object_id

string | null

The learning_object_id associated with this assignment. 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 assignment

Example:

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

data.learning_object_external_reference

string | null

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

Example:

"learning-content-123"

data.progress

number | null

The progress associated with this assigment

Example:

"40"

data.updated_at

string | null

The date the assignment was last updated

Example:

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

data.created_at

string | null

The date the assignment was created

Example:

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

data.due_date

string | null

The date the assignment is due to be completed

Example:

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

data.status

object

The status of the assignment

data.learning_object_type

object

The learning object type of the assignment

data.user_id

string | null

The user ID associated with this assignment

Example:

"c28xyrc55866bvuv"

data.remote_user_id

string | null

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

Example:

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

data.course_id

string | null

deprecated

The course ID associated with this assignment

Example:

"16873-ENG-1"

data.remote_course_id

string | null

deprecated

Provider's unique identifier of the course related to the assignment

Example:

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

raw

object[] | null

Was this page helpful?

Suggest edits

Pagination List Assignments

curl --request GET \
  --url https://api.stackone.com/unified/lms/assignments/{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",
    "learning_object_id": "e3gd34-23tr21-er234-345er56",
    "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49",
    "learning_object_external_reference": "learning-content-123",
    "progress": "40",
    "updated_at": "2021-07-21T14:00:00.000Z",
    "created_at": "2021-07-21T14:00:00.000Z",
    "due_date": "2021-07-21T14:00:00.000Z",
    "status": {
      "value": "in-progress",
      "source_value": "<string>"
    },
    "learning_object_type": {
      "value": "content",
      "source_value": "<string>"
    },
    "user_id": "c28xyrc55866bvuv",
    "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "course_id": "16873-ENG-1",
    "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

LMS

Common Guides

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response