Jobs

Create a new job

Changed on Jun 6, 2026

Enqueue a new background job for processing

post/jobs

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/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Registered background job type identifier

priorityinteger

Job priority

max_attemptsinteger

Maximum retry attempts

Example request

{
  "payload": {
    "project_id": 123,
    "options": {}
  }
}

Response

Job created successfully

statusstring

messagestring

uuidstring

Example response

{
  "status": "success",
  "message": "Job created successfully",
  "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
  request property was restricted to a list of enum values
- breaking
  the request property type changed from object to no type
- 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
- info
  added the new generate_microdata_resource enum value to the request property
- info
  added the new generate_pdf enum value to the request property
- info
  added the new hello_world enum value to the request property
- info
  added the new import_indicator_data enum value to the request property
- info
  added the new import_microdata enum value to the request property
- info
  added the new publish_project enum value to the request property
- info
  added to the request property oneOf list
May 24, 20261ff58dcd71a4 Revision changes
- warning
  added the new held enum value to the / response property for the response status

Operation history