WOworldbank
Jobs

List jobs

Changed on

Get a list of background jobs. Returns basic job information. Use GET /jobs/{uuid} for full details including payload and result.

get/jobs

Request

Query parameters

status'pending' | 'held' | 'processing' | 'completed' | 'failed'

Filter by job status

job_type'generate_pdf' | 'generate_microdata_resource' | 'import_microdata' | 'import_indicator_data' | 'publish_project' | 'hello_world'

Registered background job type identifier

Filter by job type

user_idinteger

Filter by user ID (admin only, or own jobs for regular users)

limitinteger

Number of jobs to return

offsetinteger

Offset for pagination

Response

successful operation

statusstring
totalinteger

Total number of jobs in the response

foundinteger

Number of jobs found

limitinteger

Limit used for pagination

offsetinteger

Offset used for pagination

Example response

{
  "status": "success"
}

Changes

  • 7f334b22fc50Revision changes
    • breaking

      the query request parameter job_type was restricted to a list of enum values

    • warning

      added the new generate_microdata_resource enum value to the // response property for the response status

    • warning

      added the new generate_pdf enum value to the // response property for the response status

    • warning

      added the new hello_world enum value to the // response property for the response status

    • warning

      added the new import_indicator_data enum value to the // response property for the response status

    • warning

      added the new import_microdata enum value to the // response property for the response status

    • warning

      added the new publish_project enum value to the // response property for the response status

    • info

      added the new enum value generate_microdata_resource to the query request parameter job_type

    • info

      added the new enum value generate_pdf to the query request parameter job_type

    • info

      added the new enum value hello_world to the query request parameter job_type

    • info

      added the new enum value import_indicator_data to the query request parameter job_type

    • info

      added the new enum value import_microdata to the query request parameter job_type

    • info

      added the new enum value publish_project to the query request parameter job_type

  • 1ff58dcd71a4Revision changes
    • warning

      added the new held enum value to the // response property for the response status

    • info

      added the new enum value held to the query request parameter status