WOworldbank
Job Types

Publish project to NADA

Changed on

Publish a project to a NADA catalog in the background. Sets job_type to publish_project. Equivalent to POST /jobs with job_type publish_project (user_id is set automatically).

post/jobs/publish_to_nada

Request

Request body

catalog_connection_idinteger required

NADA catalog connection ID

publish_metadataboolean
publish_thumbnailboolean
publish_resourcesboolean

Publish external resources metadata to NADA and upload attached local files to the study files API.

publish_dsdboolean

For indicator/timeseries projects, publish bound DSD to NADA

dsd_overwriteboolean

Replace existing DSD on NADA when publishing DSD

publish_indicator_databoolean

For indicator/timeseries projects, export and import observations to NADA

delete_nada_resourcesboolean

Remove existing NADA study resources before publishing (requires study_idno)

optionsobject

Additional publish options (e.g. overwrite)

priorityinteger
max_attemptsinteger

Example request

{
  "catalog_connection_id": 1,
  "options": {
    "overwrite": "yes"
  }
}

Response

Publish job created successfully

statusstring
messagestring
job_uuidstring

Example response

{
  "status": "success",
  "message": "Publish 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

  • 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

    • info

      request property list-of-types was widened by adding types integer to media type application/json

  • e1ea34251afbRevision changes
    • info

      added the new optional request property