workers

Create a new scheduled job

post/workers/jobs/

Request

  • Base URL
    https://dados.gov.pt/api/1
  • URL
    https://dados.gov.pt/api/1/workers/jobs/
  • Auth
    none declared

Headers

X-Fieldsstring mask

An optional fields mask

Request body

argsobject[]

The job execution arguments

descriptionstring

The job description

enabledboolean

Is this job enabled

idstring

The job unique identifier

kwargsobject

The job execution keyword arguments

last_run_atstring date-time

The last job execution date

last_run_idstring

The last execution task id

namestring required

The job unique name

schedulestring

The schedule display

task'test-high-queue' | 'test-default-queue' | 'test-error' | 'purge-chunks' | 'aggregate-metrics' | 'update-badges' | 'check-integrity' | 'bind-tabular-dataservice' | 'delete-expired-notifications' | 'test-log' | 'purge-harvesters' | 'purge-datasets' | 'purge-reuses' | 'test-low-queue' | 'count-tags' | 'purge-harvest-jobs' | 'purge-dataservices' | 'recommendations-clean' | 'compute-site-metrics' | 'map-transport-datasets' | 'recommendations-add' | 'notify-inactive-users' | 'harvest' | 'update-metrics' | 'compute-geozones-metrics' | 'purge-organizations' | 'purge-topics-elements' | 'export-csv' | 'delete-inactive-users' required

The task name

Example request

{
  "interval": {
    "period": "days"
  },
  "task": "test-high-queue"
}

Response

Success

argsobject[]

The job execution arguments

descriptionstring

The job description

enabledboolean

Is this job enabled

idstring

The job unique identifier

kwargsobject

The job execution keyword arguments

last_run_atstring date-time

The last job execution date

last_run_idstring

The last execution task id

namestring required

The job unique name

schedulestring

The schedule display

task'test-high-queue' | 'test-default-queue' | 'test-error' | 'purge-chunks' | 'aggregate-metrics' | 'update-badges' | 'check-integrity' | 'bind-tabular-dataservice' | 'delete-expired-notifications' | 'test-log' | 'purge-harvesters' | 'purge-datasets' | 'purge-reuses' | 'test-low-queue' | 'count-tags' | 'purge-harvest-jobs' | 'purge-dataservices' | 'recommendations-clean' | 'compute-site-metrics' | 'map-transport-datasets' | 'recommendations-add' | 'notify-inactive-users' | 'harvest' | 'update-metrics' | 'compute-geozones-metrics' | 'purge-organizations' | 'purge-topics-elements' | 'export-csv' | 'delete-inactive-users' required

The task name

Example response

{
  "interval": {
    "period": "days"
  },
  "task": "test-high-queue"
}

Changes

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