admin

Get the status of a background job being processed in an administrative context.

Returns the current status and details of a background job.

get/admin/jobs/{jobType}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /admin/jobs/{jobType}
  • Auth
    none declared

Path parameters

jobType'APPLICATION_LISTS_DATABASE_JOB' | 'REFRESH_REFERENCE_DATA' required

The type of the administrative background job

Example:APPLICATION_LISTS_DATABASE_JOB

The type of the job we are determining the status of.

Response

Job status retrieved successfully.

lastRanstring date-time

The last time the job was run.

enabledboolean

Whether the job is currently enabled.

Example response

{
  "enabled": true
}

Changes

No recorded changes to this operation across all 61 revisions of this API.