WOworldbank
Job Types

Create microdata resource generation job

Changed on

Export project data files and create a dat/micro external resource in the background. Equivalent to POST /jobs with job_type generate_microdata_resource.

post/jobs/generate_microdata_resource

Request

Request body

project_idinteger required

Project ID (sid)

export_formatstring required

csv, dta, sav, xpt, or json

export_versionstring

Stata version when export_format is dta

file_idsstring[]

Data file IDs; all files when omitted

zipboolean
overwriteboolean
resource_idinteger

Regenerate an existing generated resource

refresh_descriptionboolean
max_wait_secondsinteger
priorityinteger
max_attemptsinteger

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