Content

Endpoints to create and manage content objects and libraries; and to access content analytics.

The Content Model

Adaptemy maintains a list of all content objects against which learner records are reported, to build the content model: an estimate of various properties of each content object used to make accurate predictions and recommendations.

Each content object has a definition, which needs to be supplied to Adaptemy; the definition will include basic information about the type of object, and also some additional custom metadata fields configured for your organisation.

In a typical implementation, all recommendable Content Objects will be registered with Adaptemy before learners begin the course. If a learner posts evidence against a content object that is not known to Adaptemy, we will query your API to request the object definition and register the content object. If we cannot retrieve this information, the evidence will not be applied to the learner's profile.

Sample content object definition

{
    "id": "https://buildup.ie/content/3abdfe6d-e85f-40c0-bbf2-281c0b1cb630",
    "definition": {
        "type": "http://adlnet.gov/expapi/activities/media",
        "extensions": {
            "https://api.adaptemy.io/concept": "f28cadb6-a90b-4ae2-9ea3-28f55778484c",
            "https://buildup.ie/contentmetadata/difficulty": 3,
        }
    }
}

The Content Object Definition

Property	Description
id	unique identifier in URI format
definition	object containing definition of the content
type	a content object type
extensions	a set of configured extension properties; each a key/value pair where the key is in URI format. Only pre-agreed keys will be processed.

List of Content Object Types

value	description
http://adlnet.gov/expapi/activities/assessment	An exercise, typically consisting of a set of questions.
http://adlnet.gov/expapi/activities/question	A single question, typically within a parent exercise or survey.
http://adlnet.gov/expapi/activities/media	Any playable media object, often a video or animation.
http://adlnet.gov/expapi/activities/simulation	An interactive simulation
http://id.tincanapi.com/activitytype/document	Any document
http://id.tincanapi.com/activitytype/survey	A survey, typically consisting of a set of questions.
http://adlnet.gov/expapi/activities/course	A reference to the containing course, typically used as a context.
http://adlnet.gov/expapi/activities/module	A reference to a containing part-of-a-course, typically used as a context.
http://adlnet.gov/expapi/activities/objective	A learning objective, standard or goal.

Additional types can be configured for your Organisation if required.

content-objects

GET https://api.adaptemy.io/content-objects

Returns the definition of the content object for the selected id.

Query Parameters

Name	Type	Description
id	string	object URI

200

[
    {
        "guid": "eef9408c-81ca-4285-9147-0529c998f602",
        "id": "https://buildup.ie/content/3abdfe6d-e85f-40c0-bbf2-281c0b1cb630",
        "definition": {
            "type": "http://adlnet.gov/expapi/activities/media",
            "moreinfo": "",
            "extensions": {
                "https://buildup.ie/contentmetadata/difficulty": 3
            }
        },
        "createdOn": "2021-02-26T18:02:01.844Z"
    }
]

content-objects

POST https://api.adaptemy.io/content-objects

Register a content object, or array of content objects, with the Adaptemy system. Content objects can be registered to a course or module, or just linked to a node from the Curriculum object.

Request Body

Name	Type	Description
contentobject	object	A array of valid content object - see above

200 Object created or updated. Full object definition returned.

[
    {
        "guid": "eef9408c-81ca-4285-9147-0529c998f602",
        "id": "https://buildup.ie/content/3abdfe6d-e85f-40c0-bbf2-281c0b1cb630",
        "definition": {
            "type": "http://adlnet.gov/expapi/activities/media",
            "moreinfo": "",
            "extensions": {
                "https://buildup.ie/contentmetadata/difficulty": 3
            }
        },
        "createdOn": "2021-02-26T18:02:01.844Z"
    }
]

content-objects

DELETE https://api.adaptemy.io/content-objects

De-register this contentobject from the Adaptemy system. Object will no longer be available for recommendation. Historical data on this contentobject will be retained. Future learning records posted against this contentobject will fail. This endpoint deletes the one specified content-object. To delete multiple content-objects, call this endpoint multiple times.

Query Parameters

Name	Type	Description
id	string	Object URI

204 Object successfully deleted.

Course definition, content reporting and analytics methods yet to be migrated to API-v2.