This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.
Initialization Option Assess API

items

Array of Item objects. Each Item represents a single page within the assess screens, containing questions and contents within.

Examples

"items": [
    {
        "content": "<span class=\"learnosity-response question-widget1234\"></span>",
        "response_ids": [
            "widget1234"
        ],
        "feature_ids": [
            "feature1234"
        ],
        "workflow": "",
        "reference": "ccore_ccs_rabbit",
        "metadata": {
            "display_name": "CC Card Item"
        }
    },
    {
      //...
    },
    ...
]

Values

Request object key items

Type array[Item]

Type definitions

Item object

  • content string
    Content should contain a span element for each response_id in that item, as well as any additional description or content
  • response_ids array
    Response Ids should be provided in the "QuestionApiActivity" to match the responses and features ,and spans provided
    Example: [ "widget1234" ]
  • feature_ids array
    Feature Ids should be provided in the "QuestionApiActivity" to match the responses and features, and spans provided
  • workflow string
    A Workflow can be added to allow for triggered events on certain actions. This can be seen in the workflow section.
  • reference string
    Reference should be a unique name to identify each item.
  • metadata object
    Contains various item metadata information such as default display name of the item in TOC.
    Example: metadata: { display_name: "CC Card Item" }

this is a mandatory property.

Was this article helpful?