harvest

Get a single job given an ID

Readable without a session by the same decision as the source reads -- see SourceAPI.get, which records it in full. The errors and captured logs served here are redacted twice over: in their constructors on the way into the database, and in error_fields/log_fields on the way out, which is what covers the preview, where nothing is ever saved. The jobs list is the one route that marshals neither, so _serialize_light_job repeats the redaction by hand.

See LEDG-2477.

get/harvest/job/{ident}/

Request

  • Base URL
    https://dados.gov.pt/api/1
  • URL
    https://dados.gov.pt/api/1/harvest/job/{ident}/
  • Auth
    none declared

Query parameters

pageinteger

The page to fetch

page_sizeinteger

The page size to fetch

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

createdstring date-time required

The job creation date

endedstring date-time

The job end date

idstring required

The job execution ID

sourcestring required

The source owning the job

startedstring date-time

The job start date

status'pending' | 'initializing' | 'initialized' | 'processing' | 'done' | 'done-errors' | 'failed' required

The job status

Example response

{
  "items": [
    {
      "dataservice": {
        "title": "My awesome API"
      },
      "status": "pending"
    }
  ],
  "status": "pending"
}

Changes

No recorded changes to this operation across all 21 revisions of this API.