Jobs

Get job details

Changed on Jun 6, 2026

Get full details of a specific job including payload and result. Accepts UUID (recommended) or numeric ID for backward compatibility.

get/jobs/{uuid}

Request

Base URL
https://localhost/index.php/api
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/worldbank/apis/metadata-editor-jobs-api/docs/jobs/:uuid/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

uuidstring required

Job UUID (or numeric ID for backward compatibility)

Response

successful operation

statusstring

Example response

{
  "status": "success",
  "job": {
    "payload": {
      "project_id": 123,
      "options": {}
    },
    "result": {
      "pdf_path": "/path/to/project_123.pdf",
      "project_id": 123,
      "generated_at": "2025-01-11 16:30:45"
    }
  }
}

Changes

Jun 6, 20267f334b22fc50 Revision changes
- breaking
  added to the / response property oneOf list for the response status
- breaking
  added to the / response property oneOf list for the response status
- breaking
  the / response's property type changed from object to no type for status
- breaking
  the / response's property type changed from object to no type for status
- 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
May 24, 20261ff58dcd71a4 Revision changes
- warning
  added the new held enum value to the / response property for the response status

Operation history