Jobs

5 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List jobs

GET/api/jobs/

API key permissionDatastream: Read-onlydatastream:read

Query parameters

• datastream_idnumber
• endstring · date-time
• job_group_idnumber
• job_uuidstring · uuid
• orderingstring

  Which field to use when ordering the results.

• pageinteger

  A page number within the paginated result set.

• page_sizeinteger

  Number of results to return per page.

• stack_idnumber
• startstring · date-time
• stateinteger
  • 20 - Scheduled
  • 10 - Running
  • 50 - Success
  • 70 - Cancelled
  • 30 - Failed
  • 60 - Discarded

  One of 10 20 30 50 60 70

• triggered_by_userboolean

  true: only human-triggered fetches; false: only system-triggered.

• typestring
  • Fetch - Fetch
  • Enrich - Enrich
  • Transfer - Transfer

  One of Enrich Fetch Transfer

• userstring

  Filter by the email of the user who triggered the fetch.

Responses

200OKapplication/json

Response schema

object PaginatedJobPolymorphicList

• countintegerrequired

  Example 123

• nextstring · urinullable

  Example "http://api.example.org/accounts/?page=4"

• previousstring · urinullable

  Example "http://api.example.org/accounts/?page=2"

• resultsarray of one ofrequired
  Items · JobPolymorphic

  • BaseJobTyped

    • typestringrequired
    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • urlstring · urirequiredread-only
    • job_startstring · date-timerequiredread-only
    • job_endstring · date-timerequiredread-only
    • progressstringrequiredread-only
    • statestringrequiredread-only
    • state_labelstringrequiredread-only

      Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

    • state_colorstringrequiredread-only
    • datastreamobjectrequiredread-onlynullable
      Attributes

      • APIDatastreamBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • stackobjectrequiredread-only
          Attributes · StackBasic

          • idintegerrequiredread-only
          • uuidstring · uuidrequiredread-only
          • namestringrequired

            Max length 60

          • slugstringrequiredread-only
          • urlstring · urirequiredread-only
          • change_urlstringrequiredread-only
          • extracts_urlstringrequiredread-only
          • issues_urlstringrequiredread-only
          • overview_urlstringrequiredread-only
          • permissionsstringrequiredread-only
        • stack_idintegerrequiredread-only

          Which workspace the datastream belongs to.

        • authintegernullable

          Which authorization the datastream uses.

        • namestringrequired

          A human readable name. Numbers and special characters are supported.

          Max length 150

        • slugstringrequiredread-only
        • app_labelstringrequiredread-only
        • absolute_urlstringrequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • fetch_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • schema_mapping_urlstringrequiredread-only
        • enabledboolean

          Streams that are not scheduled will not be fetched automatically.

        • next_runstring · date-timerequiredread-only
        • urlstring · urirequiredread-only
        • datastream_type_idintegerrequiredread-only
        • logo_urlstringrequiredread-only
        • extracts_stream_urlstringrequiredread-only
        • supports_extended_intervalsstringrequiredread-only
        • updatedstring · date-timerequiredread-only
        • createdstring · date-timerequiredread-only
        • creatorstringrequiredread-onlynullable
        • can_be_fetchedbooleanrequiredread-only

      • null

    • issuesarray of objectrequiredread-only
      Items · CompactDatastreamExtractionLog

      • messagestringnullable
      • type_labelstringrequiredread-only
      • extraction_stage_labelstringrequiredread-only
      • urlstring · urirequiredread-only
    • last_executedstring · date-timerequiredread-onlynullable

      When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

    • userstringrequiredread-onlynullable

  • FetchJobTyped

    • typestringrequired
    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • urlstring · urirequiredread-only
    • job_startstring · date-timerequiredread-only
    • job_endstring · date-timerequiredread-only
    • progressstringrequiredread-only
    • statestringrequiredread-only
    • state_labelstringrequiredread-only

      Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

    • state_colorstringrequiredread-only
    • datastreamobjectrequiredread-onlynullable
      Attributes

      • APIDatastreamBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • stackobjectrequiredread-only
          Attributes · StackBasic

          • idintegerrequiredread-only
          • uuidstring · uuidrequiredread-only
          • namestringrequired

            Max length 60

          • slugstringrequiredread-only
          • urlstring · urirequiredread-only
          • change_urlstringrequiredread-only
          • extracts_urlstringrequiredread-only
          • issues_urlstringrequiredread-only
          • overview_urlstringrequiredread-only
          • permissionsstringrequiredread-only
        • stack_idintegerrequiredread-only

          Which workspace the datastream belongs to.

        • authintegernullable

          Which authorization the datastream uses.

        • namestringrequired

          A human readable name. Numbers and special characters are supported.

          Max length 150

        • slugstringrequiredread-only
        • app_labelstringrequiredread-only
        • absolute_urlstringrequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • fetch_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • schema_mapping_urlstringrequiredread-only
        • enabledboolean

          Streams that are not scheduled will not be fetched automatically.

        • next_runstring · date-timerequiredread-only
        • urlstring · urirequiredread-only
        • datastream_type_idintegerrequiredread-only
        • logo_urlstringrequiredread-only
        • extracts_stream_urlstringrequiredread-only
        • supports_extended_intervalsstringrequiredread-only
        • updatedstring · date-timerequiredread-only
        • createdstring · date-timerequiredread-only
        • creatorstringrequiredread-onlynullable
        • can_be_fetchedbooleanrequiredread-only

      • null

    • issuesarray of objectrequiredread-only
      Items · CompactDatastreamExtractionLog

      • messagestringnullable
      • type_labelstringrequiredread-only
      • extraction_stage_labelstringrequiredread-only
      • urlstring · urirequiredread-only
    • last_executedstring · date-timerequiredread-onlynullable

      When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

    • userstringrequiredread-onlynullable
    • range_startstring · date-timerequiredread-only
    • range_endstring · date-timerequiredread-only
    • scheduledstring · date-timerequiredread-only
    • manualstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/jobs/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "type": "string",
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "url": "https://example.com",
      "job_start": "2024-01-01T00:00:00Z",
      "job_end": "2024-01-01T00:00:00Z",
      "progress": "string",
      "state": "string",
      "state_label": "string",
      "state_color": "string",
      "datastream": {
        "id": null,
        "uuid": null,
        "stack": {},
        "stack_id": null,
        "auth": null,
        "name": null,
        "slug": null,
        "app_label": null,
        "absolute_url": null,
        "change_url": null,
        "extracts_url": null,
        "fetch_url": null,
        "overview_url": null,
        "schema_mapping_url": null,
        "enabled": null,
        "next_run": null,
        "url": null,
        "datastream_type_id": null,
        "logo_url": null,
        "extracts_stream_url": null,
        "supports_extended_intervals": null,
        "updated": null,
        "created": null,
        "creator": null,
        "can_be_fetched": null
      },
      "issues": [
        {
          "message": null,
          "type_label": null,
          "extraction_stage_label": null,
          "url": null
        }
      ],
      "last_executed": "2024-01-01T00:00:00Z",
      "user": "string"
    }
  ]
}

Get jobs

GET/api/jobs/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this job.

Responses

200OKapplication/json

Response schema

one of JobPolymorphic

• BaseJobTyped

  • typestringrequired
  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable

• FetchJobTyped

  • typestringrequired
  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable
  • range_startstring · date-timerequiredread-only
  • range_endstring · date-timerequiredread-only
  • scheduledstring · date-timerequiredread-only
  • manualstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/jobs/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "type": "string",
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "job_start": "2024-01-01T00:00:00Z",
  "job_end": "2024-01-01T00:00:00Z",
  "progress": "string",
  "state": "string",
  "state_label": "string",
  "state_color": "string",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "issues": [
    {
      "message": "string",
      "type_label": "string",
      "extraction_stage_label": "string",
      "url": "https://example.com"
    }
  ],
  "last_executed": "2024-01-01T00:00:00Z",
  "user": "string"
}

Get jobs imported

GET/api/jobs/{id}/imported/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this job.

Responses

200OKapplication/json

Response schema

one of JobPolymorphic

• BaseJobTyped

  • typestringrequired
  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable

• FetchJobTyped

  • typestringrequired
  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable
  • range_startstring · date-timerequiredread-only
  • range_endstring · date-timerequiredread-only
  • scheduledstring · date-timerequiredread-only
  • manualstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/jobs/{id}/imported/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "type": "string",
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "job_start": "2024-01-01T00:00:00Z",
  "job_end": "2024-01-01T00:00:00Z",
  "progress": "string",
  "state": "string",
  "state_label": "string",
  "state_color": "string",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "issues": [
    {
      "message": "string",
      "type_label": "string",
      "extraction_stage_label": "string",
      "url": "https://example.com"
    }
  ],
  "last_executed": "2024-01-01T00:00:00Z",
  "user": "string"
}

Create jobs retry

POST/api/jobs/{id}/retry/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this job.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

one of JobPolymorphic

• BaseJobTyped

  • typestringrequired

• FetchJobTyped

  • typestringrequired

Responses

200OKapplication/json

Response schema

one of JobPolymorphic

• BaseJobTyped

  • typestringrequired
  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable

• FetchJobTyped

  • typestringrequired
  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable
  • range_startstring · date-timerequiredread-only
  • range_endstring · date-timerequiredread-only
  • scheduledstring · date-timerequiredread-only
  • manualstringrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/jobs/{id}/retry/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "string"
  }'

Response200

{
  "type": "string",
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "job_start": "2024-01-01T00:00:00Z",
  "job_end": "2024-01-01T00:00:00Z",
  "progress": "string",
  "state": "string",
  "state_label": "string",
  "state_color": "string",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "issues": [
    {
      "message": "string",
      "type_label": "string",
      "extraction_stage_label": "string",
      "url": "https://example.com"
    }
  ],
  "last_executed": "2024-01-01T00:00:00Z",
  "user": "string"
}

Create jobs stop

POST/api/jobs/{id}/stop/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this job.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

one of JobPolymorphic

• BaseJobTyped

  • typestringrequired

• FetchJobTyped

  • typestringrequired

Responses

200OKapplication/json

Response schema

one of JobPolymorphic

• BaseJobTyped

  • typestringrequired
  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable

• FetchJobTyped

  • typestringrequired
  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable
  • range_startstring · date-timerequiredread-only
  • range_endstring · date-timerequiredread-only
  • scheduledstring · date-timerequiredread-only
  • manualstringrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/jobs/{id}/stop/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "string"
  }'

Response200

{
  "type": "string",
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "job_start": "2024-01-01T00:00:00Z",
  "job_end": "2024-01-01T00:00:00Z",
  "progress": "string",
  "state": "string",
  "state_label": "string",
  "state_color": "string",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "issues": [
    {
      "message": "string",
      "type_label": "string",
      "extraction_stage_label": "string",
      "url": "https://example.com"
    }
  ],
  "last_executed": "2024-01-01T00:00:00Z",
  "user": "string"
}

Was this page helpful? Yes No