Errors

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

List errors

GET/api/errors/

API key permissionDatastream: Read-onlydatastream:read

Query parameters

• ackstring

  One of any false true

• datastream_idnumber
• job_idnumber
• 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
• start_fromstring · date-time
• start_tostring · date-time

Responses

200OKapplication/json

Response schema

object PaginatedDatastreamExtractionLogList

• 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 objectrequired
  Items · DatastreamExtractionLog

  • idintegerrequiredread-only
  • job_idintegerrequiredread-onlynullable
  • jobobjectrequiredread-only
  • startstring · date-timerequired
  • endstring · date-timerequired
  • messagestringnullable
  • display_messagestringrequiredread-onlynullable
  • type_labelstringrequiredread-only
  • datastreamobjectrequired
    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
  • extractobjectrequired
    Attributes · DatastreamExtractNested

    • idintegerrequiredread-only
    • namestringrequired

      Max length 255

    • preview_urlstringrequiredread-only
    • refetch_urlstringrequiredread-only
    • requeue_urlstringrequiredread-only
    • metadataany
    • datastream_idintegerrequiredread-only
  • ackboolean
  • ack_urlstringrequiredread-only
  • ack_group_urlstringrequiredread-only
  • retry_urlstringrequiredread-only
  • retry_group_urlstringrequiredread-only
  • urlstring · urirequiredread-only
  • mapping_table_change_urlstringrequiredread-onlynullable
  • mapping_entries_change_urlstringrequiredread-onlynullable
  • unmapped_workspace_mappings_urlstringrequiredread-onlynullable
  • target_column_change_urlstringrequired
  • transformation_config_urlstringrequired
  • extraction_stage_labelstringrequiredread-only
  • error_cause_labelstringrequiredread-only
  • error_resolution_labelstringrequiredread-only
  • occurrencesintegerrequiredread-only

RequestcURL

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

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "job_id": 1,
      "job": {
        "key": null
      },
      "start": "2024-01-01T00:00:00Z",
      "end": "2024-01-01T00:00:00Z",
      "message": "string",
      "display_message": "string",
      "type_label": "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
      },
      "extract": {
        "id": 1,
        "name": "string",
        "preview_url": "string",
        "refetch_url": "string",
        "requeue_url": "string",
        "metadata": null,
        "datastream_id": 1
      },
      "ack": true,
      "ack_url": "string",
      "ack_group_url": "string",
      "retry_url": "string",
      "retry_group_url": "string",
      "url": "https://example.com",
      "mapping_table_change_url": "string",
      "mapping_entries_change_url": "string",
      "unmapped_workspace_mappings_url": "string",
      "target_column_change_url": "string",
      "transformation_config_url": "string",
      "extraction_stage_label": "string",
      "error_cause_label": "string",
      "error_resolution_label": "string",
      "occurrences": 1
    }
  ]
}

Get errors

GET/api/errors/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Issues.

Responses

200OKapplication/json

Response schema

object DatastreamExtractionLog

• idintegerrequiredread-only
• job_idintegerrequiredread-onlynullable
• jobobjectrequiredread-only
• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• display_messagestringrequiredread-onlynullable
• type_labelstringrequiredread-only
• datastreamobjectrequired
  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
• extractobjectrequired
  Attributes · DatastreamExtractNested

  • idintegerrequiredread-only
  • namestringrequired

    Max length 255

  • preview_urlstringrequiredread-only
  • refetch_urlstringrequiredread-only
  • requeue_urlstringrequiredread-only
  • metadataany
  • datastream_idintegerrequiredread-only
• ackboolean
• ack_urlstringrequiredread-only
• ack_group_urlstringrequiredread-only
• retry_urlstringrequiredread-only
• retry_group_urlstringrequiredread-only
• urlstring · urirequiredread-only
• mapping_table_change_urlstringrequiredread-onlynullable
• mapping_entries_change_urlstringrequiredread-onlynullable
• unmapped_workspace_mappings_urlstringrequiredread-onlynullable
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired
• extraction_stage_labelstringrequiredread-only
• error_cause_labelstringrequiredread-only
• error_resolution_labelstringrequiredread-only
• occurrencesintegerrequiredread-only

RequestcURL

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

Response200

{
  "id": 1,
  "job_id": 1,
  "job": {
    "key": null
  },
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-01-01T00:00:00Z",
  "message": "string",
  "display_message": "string",
  "type_label": "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
  },
  "extract": {
    "id": 1,
    "name": "string",
    "preview_url": "string",
    "refetch_url": "string",
    "requeue_url": "string",
    "metadata": null,
    "datastream_id": 1
  },
  "ack": true,
  "ack_url": "string",
  "ack_group_url": "string",
  "retry_url": "string",
  "retry_group_url": "string",
  "url": "https://example.com",
  "mapping_table_change_url": "string",
  "mapping_entries_change_url": "string",
  "unmapped_workspace_mappings_url": "string",
  "target_column_change_url": "string",
  "transformation_config_url": "string",
  "extraction_stage_label": "string",
  "error_cause_label": "string",
  "error_resolution_label": "string",
  "occurrences": 1
}

Create errors confirm

POST/api/errors/{id}/confirm/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Issues.

Request bodyrequired

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

Body schema

object DatastreamExtractionLog

• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

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

    Max length 150

  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

• extractobjectrequired
  Attributes · DatastreamExtractNested

  • namestringrequired

    Max length 255

  • metadataany
• ackboolean
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired

Responses

200OKapplication/json

Response schema

object DatastreamExtractionLog

• idintegerrequiredread-only
• job_idintegerrequiredread-onlynullable
• jobobjectrequiredread-only
• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• display_messagestringrequiredread-onlynullable
• type_labelstringrequiredread-only
• datastreamobjectrequired
  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
• extractobjectrequired
  Attributes · DatastreamExtractNested

  • idintegerrequiredread-only
  • namestringrequired

    Max length 255

  • preview_urlstringrequiredread-only
  • refetch_urlstringrequiredread-only
  • requeue_urlstringrequiredread-only
  • metadataany
  • datastream_idintegerrequiredread-only
• ackboolean
• ack_urlstringrequiredread-only
• ack_group_urlstringrequiredread-only
• retry_urlstringrequiredread-only
• retry_group_urlstringrequiredread-only
• urlstring · urirequiredread-only
• mapping_table_change_urlstringrequiredread-onlynullable
• mapping_entries_change_urlstringrequiredread-onlynullable
• unmapped_workspace_mappings_urlstringrequiredread-onlynullable
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired
• extraction_stage_labelstringrequiredread-only
• error_cause_labelstringrequiredread-only
• error_resolution_labelstringrequiredread-only
• occurrencesintegerrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/errors/{id}/confirm/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-01-01T00:00:00Z",
    "message": "string",
    "datastream": {
      "auth": 1,
      "name": "string",
      "enabled": true
    },
    "extract": {
      "name": "string",
      "metadata": null
    },
    "ack": true,
    "target_column_change_url": "string",
    "transformation_config_url": "string"
  }'

Response200

{
  "id": 1,
  "job_id": 1,
  "job": {
    "key": null
  },
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-01-01T00:00:00Z",
  "message": "string",
  "display_message": "string",
  "type_label": "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
  },
  "extract": {
    "id": 1,
    "name": "string",
    "preview_url": "string",
    "refetch_url": "string",
    "requeue_url": "string",
    "metadata": null,
    "datastream_id": 1
  },
  "ack": true,
  "ack_url": "string",
  "ack_group_url": "string",
  "retry_url": "string",
  "retry_group_url": "string",
  "url": "https://example.com",
  "mapping_table_change_url": "string",
  "mapping_entries_change_url": "string",
  "unmapped_workspace_mappings_url": "string",
  "target_column_change_url": "string",
  "transformation_config_url": "string",
  "extraction_stage_label": "string",
  "error_cause_label": "string",
  "error_resolution_label": "string",
  "occurrences": 1
}

Create errors confirm group

POST/api/errors/{id}/confirm_group/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Issues.

Request bodyrequired

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

Body schema

object DatastreamExtractionLog

• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

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

    Max length 150

  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

• extractobjectrequired
  Attributes · DatastreamExtractNested

  • namestringrequired

    Max length 255

  • metadataany
• ackboolean
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired

Responses

200OKapplication/json

Response schema

object DatastreamExtractionLog

• idintegerrequiredread-only
• job_idintegerrequiredread-onlynullable
• jobobjectrequiredread-only
• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• display_messagestringrequiredread-onlynullable
• type_labelstringrequiredread-only
• datastreamobjectrequired
  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
• extractobjectrequired
  Attributes · DatastreamExtractNested

  • idintegerrequiredread-only
  • namestringrequired

    Max length 255

  • preview_urlstringrequiredread-only
  • refetch_urlstringrequiredread-only
  • requeue_urlstringrequiredread-only
  • metadataany
  • datastream_idintegerrequiredread-only
• ackboolean
• ack_urlstringrequiredread-only
• ack_group_urlstringrequiredread-only
• retry_urlstringrequiredread-only
• retry_group_urlstringrequiredread-only
• urlstring · urirequiredread-only
• mapping_table_change_urlstringrequiredread-onlynullable
• mapping_entries_change_urlstringrequiredread-onlynullable
• unmapped_workspace_mappings_urlstringrequiredread-onlynullable
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired
• extraction_stage_labelstringrequiredread-only
• error_cause_labelstringrequiredread-only
• error_resolution_labelstringrequiredread-only
• occurrencesintegerrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/errors/{id}/confirm_group/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-01-01T00:00:00Z",
    "message": "string",
    "datastream": {
      "auth": 1,
      "name": "string",
      "enabled": true
    },
    "extract": {
      "name": "string",
      "metadata": null
    },
    "ack": true,
    "target_column_change_url": "string",
    "transformation_config_url": "string"
  }'

Response200

{
  "id": 1,
  "job_id": 1,
  "job": {
    "key": null
  },
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-01-01T00:00:00Z",
  "message": "string",
  "display_message": "string",
  "type_label": "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
  },
  "extract": {
    "id": 1,
    "name": "string",
    "preview_url": "string",
    "refetch_url": "string",
    "requeue_url": "string",
    "metadata": null,
    "datastream_id": 1
  },
  "ack": true,
  "ack_url": "string",
  "ack_group_url": "string",
  "retry_url": "string",
  "retry_group_url": "string",
  "url": "https://example.com",
  "mapping_table_change_url": "string",
  "mapping_entries_change_url": "string",
  "unmapped_workspace_mappings_url": "string",
  "target_column_change_url": "string",
  "transformation_config_url": "string",
  "extraction_stage_label": "string",
  "error_cause_label": "string",
  "error_resolution_label": "string",
  "occurrences": 1
}

Create errors retry

POST/api/errors/{id}/retry/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Issues.

Request bodyrequired

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

Body schema

object DatastreamExtractionLog

• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

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

    Max length 150

  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

• extractobjectrequired
  Attributes · DatastreamExtractNested

  • namestringrequired

    Max length 255

  • metadataany
• ackboolean
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired

Responses

200OKapplication/json

Response schema

object DatastreamExtractionLog

• idintegerrequiredread-only
• job_idintegerrequiredread-onlynullable
• jobobjectrequiredread-only
• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• display_messagestringrequiredread-onlynullable
• type_labelstringrequiredread-only
• datastreamobjectrequired
  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
• extractobjectrequired
  Attributes · DatastreamExtractNested

  • idintegerrequiredread-only
  • namestringrequired

    Max length 255

  • preview_urlstringrequiredread-only
  • refetch_urlstringrequiredread-only
  • requeue_urlstringrequiredread-only
  • metadataany
  • datastream_idintegerrequiredread-only
• ackboolean
• ack_urlstringrequiredread-only
• ack_group_urlstringrequiredread-only
• retry_urlstringrequiredread-only
• retry_group_urlstringrequiredread-only
• urlstring · urirequiredread-only
• mapping_table_change_urlstringrequiredread-onlynullable
• mapping_entries_change_urlstringrequiredread-onlynullable
• unmapped_workspace_mappings_urlstringrequiredread-onlynullable
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired
• extraction_stage_labelstringrequiredread-only
• error_cause_labelstringrequiredread-only
• error_resolution_labelstringrequiredread-only
• occurrencesintegerrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/errors/{id}/retry/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-01-01T00:00:00Z",
    "message": "string",
    "datastream": {
      "auth": 1,
      "name": "string",
      "enabled": true
    },
    "extract": {
      "name": "string",
      "metadata": null
    },
    "ack": true,
    "target_column_change_url": "string",
    "transformation_config_url": "string"
  }'

Response200

{
  "id": 1,
  "job_id": 1,
  "job": {
    "key": null
  },
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-01-01T00:00:00Z",
  "message": "string",
  "display_message": "string",
  "type_label": "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
  },
  "extract": {
    "id": 1,
    "name": "string",
    "preview_url": "string",
    "refetch_url": "string",
    "requeue_url": "string",
    "metadata": null,
    "datastream_id": 1
  },
  "ack": true,
  "ack_url": "string",
  "ack_group_url": "string",
  "retry_url": "string",
  "retry_group_url": "string",
  "url": "https://example.com",
  "mapping_table_change_url": "string",
  "mapping_entries_change_url": "string",
  "unmapped_workspace_mappings_url": "string",
  "target_column_change_url": "string",
  "transformation_config_url": "string",
  "extraction_stage_label": "string",
  "error_cause_label": "string",
  "error_resolution_label": "string",
  "occurrences": 1
}

Create errors retry group

POST/api/errors/{id}/retry_group/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Issues.

Request bodyrequired

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

Body schema

object DatastreamExtractionLog

• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

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

    Max length 150

  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

• extractobjectrequired
  Attributes · DatastreamExtractNested

  • namestringrequired

    Max length 255

  • metadataany
• ackboolean
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired

Responses

200OKapplication/json

Response schema

object DatastreamExtractionLog

• idintegerrequiredread-only
• job_idintegerrequiredread-onlynullable
• jobobjectrequiredread-only
• startstring · date-timerequired
• endstring · date-timerequired
• messagestringnullable
• display_messagestringrequiredread-onlynullable
• type_labelstringrequiredread-only
• datastreamobjectrequired
  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
• extractobjectrequired
  Attributes · DatastreamExtractNested

  • idintegerrequiredread-only
  • namestringrequired

    Max length 255

  • preview_urlstringrequiredread-only
  • refetch_urlstringrequiredread-only
  • requeue_urlstringrequiredread-only
  • metadataany
  • datastream_idintegerrequiredread-only
• ackboolean
• ack_urlstringrequiredread-only
• ack_group_urlstringrequiredread-only
• retry_urlstringrequiredread-only
• retry_group_urlstringrequiredread-only
• urlstring · urirequiredread-only
• mapping_table_change_urlstringrequiredread-onlynullable
• mapping_entries_change_urlstringrequiredread-onlynullable
• unmapped_workspace_mappings_urlstringrequiredread-onlynullable
• target_column_change_urlstringrequired
• transformation_config_urlstringrequired
• extraction_stage_labelstringrequiredread-only
• error_cause_labelstringrequiredread-only
• error_resolution_labelstringrequiredread-only
• occurrencesintegerrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/errors/{id}/retry_group/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-01-01T00:00:00Z",
    "message": "string",
    "datastream": {
      "auth": 1,
      "name": "string",
      "enabled": true
    },
    "extract": {
      "name": "string",
      "metadata": null
    },
    "ack": true,
    "target_column_change_url": "string",
    "transformation_config_url": "string"
  }'

Response200

{
  "id": 1,
  "job_id": 1,
  "job": {
    "key": null
  },
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-01-01T00:00:00Z",
  "message": "string",
  "display_message": "string",
  "type_label": "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
  },
  "extract": {
    "id": 1,
    "name": "string",
    "preview_url": "string",
    "refetch_url": "string",
    "requeue_url": "string",
    "metadata": null,
    "datastream_id": 1
  },
  "ack": true,
  "ack_url": "string",
  "ack_group_url": "string",
  "retry_url": "string",
  "retry_group_url": "string",
  "url": "https://example.com",
  "mapping_table_change_url": "string",
  "mapping_entries_change_url": "string",
  "unmapped_workspace_mappings_url": "string",
  "target_column_change_url": "string",
  "transformation_config_url": "string",
  "extraction_stage_label": "string",
  "error_cause_label": "string",
  "error_resolution_label": "string",
  "occurrences": 1
}

Was this page helpful? Yes No