WOworldbank
Job Types

Import Microdata files

Changed on

Upload and import a data file in one step (multipart/form-data). Creates an import_microdata background job after upload. Equivalent to uploading separately then POST /jobs with job_type import_microdata and payload file_id + project_id.

post/jobs/import_microdata/{project_id}

Request

Path parameters

project_idstring required

Project ID where the data file will be imported

Request body multipart/form-data

filestring binary required

The data file to upload (CSV, DTA, SAV, etc.)

overwrite0 | 1

Whether to overwrite existing file (0 or 1)

store_data'store' | 'remove'

Whether to store data ("store" or "remove")

descriptionstring

File description (datafile-schema.json)

producerstring

File producer

data_checksstring

Processing / data checks

missing_datastring

Missing data documentation

versionstring

File version

notesstring

File notes

priorityinteger

Job queue priority; higher values are processed before lower ones

Response

File uploaded and job created successfully

statusstring
messagestring
file_idstring

ID of the uploaded file

uuidstring

UUID of the created import job

Example response

{
  "status": "success",
  "message": "File uploaded and import job created successfully",
  "file_id": "F4",
  "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

  • 7f334b22fc50Revision 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

  • 1ff58dcd71a4Revision changes
    • warning

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

    • info

      added the new optional request property