PATCH
/
unified
/
lms
/
collections
/
{id}
curl --request PATCH \
  --url https://api.stackone.com/unified/lms/collections/{id} \
  --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>"
      },
      "proficiency": {
        "value": "1",
        "source_value": "<string>"
      },
      "language": {
        "value": "en_GB",
        "source_value": "<string>"
      },
      "level": {
        "value": "primary",
        "source_value": "<string>"
      }
    }
  ]
}'
{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}

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

id
string
required

Body

application/json
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"
}
external_reference
string | null

The external ID associated with this collection

Example:

"SOFTWARE-ENG-LV1-TRAINING-collection-1"

learning_object_ids
string[] | null

The child ID/IDs associated with this collection

Example:
[
  "16873-SOFTWARE-ENG-COURSE",
  "16874-SOFTWARE-ENG-COURSE"
]
remote_learning_object_ids
string[] | null

Provider's unique identifiers of the child ID/IDs associated with this collection

Example:
[
  "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
]
title
string | null

The title of the collection

Example:

"Software Engineer Lv 1 Collection"

description
string | null

The description of the collection

Example:

"This collection acts as learning pathway for software engineers."

languages
string[] | null

The languages associated with this collection

cover_url
string | null

The URL of the thumbnail image associated with the collection.

Example:

"https://www.googledrive.com/?v=16873"

categories
object[] | null

The categories associated with this content

skills
object[] | null

The skills associated with this content

Response

201
application/json
The collection was updated successfully.
statusCode
number
required
Example:

200

message
string
required
Example:

"Record updated successfully."

timestamp
string
required
Example:

"2021-01-01T01:01:01.000Z"