Jobs endpoint

Create long running Learnosity jobs and checking their status and output.

Jobs can be queried to check on the progress periodically and allow you to retrieve the results once ready.

Endpoints:

Get Jobs

Usage

The format of requests to the Data API use the following syntax:

https://data.learnosity.com/{LTS_VERSION}/{endpoint}

For example, to use the v2025.1.LTS version and the itembank/items endpoint, you would create a request like so:

https://data.learnosity.com/v2025.1.LTS/itembank/items

Important Data API is not a REST API. All requests must use the POST method with the action request body parameter specifying the operation to use. The Learnosity SDK must be used to make requests to Data API.

Note Data API usage is subject to rate limits.

Getting Started with the Data API
See Release Cadence and Version Lifecycle for more information on available LTS versions.

Get Jobs

Returns information for any job that has previously been started.

Endpoint	/{LTS_VERSION}/jobs
HTTP method	POST
Action type	`"get"`

Request body parameters

Body content type: application/json

include array[string]

Restrict the properties returned in the data object.

Default: ["reference", "type", "status", "dt_created", "dt_completed"]
limit integer

Restricts the number of records returned.

Default: 50

Maximum: 50
maxtime integer string

A timestamp filter based on the created time of the job. Latest UTC Unix timestamp or datetime string (in ISO 8601) to get results from.
mintime integer string

A timestamp filter based on the created time of the job. Earliest UTC Unix timestamp or datetime string (in ISO 8601) to filter results to.
organisation_id integer

Returns only jobs filtered to the Item bank with the supplied ID.

The API consumer making the request will need to have access to the Item bank. This access can be ensured via API consumers configuration in the Learnosity Console.
references array[string]

A list of job references you want to retrieve.

Maximum entries: 1000
status array[string]

Filters jobs containing any of the specified statuses.

Default: ["completed"]

Possible values
- queued
- running
- halted
- completed

Request body example

{
    "references": [
        "9fd443d0-2b4f-4315-aec6-708da3d30d49"
    ]
}

Responses

Response example

{
    "meta":{
        "status":true,
        "timestamp":1389192595
        "records": 1
    },
    "data": [
        {
            "reference": "9fd443d0-2b4f-4315-aec6-708da3d30d49",
            "type": "manualresponseupdate",
            "status": "completed",
            "dt_created": "2015-04-24 01:30:02",
            "dt_completed": "2015-04-24 01:30:03"
        }
    ]
}