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
ackstringdatastream_idnumberjob_idnumberorderingstringWhich field to use when ordering the results.
pageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
stack_idnumberstart_fromstring · date-timestart_tostring · date-time
Responses
200OKapplication/json
Response schema
object PaginatedDatastreamExtractionLogList
countintegerrequirednullableAlways null: this list does not count its rows.
nextstring · urinullablepreviousstring · urinullableresultsarray of objectrequiredItems · DatastreamExtractionLog
idintegerrequiredread-onlyjob_idintegerrequiredread-onlynullablejobobjectrequiredread-onlystartstring · date-timerequiredendstring · date-timerequirednullablemessagestringnullabledisplay_messagestringrequiredread-onlynullabletype_labelstringrequiredread-onlydatastreamobjectrequiredAttributes · APIDatastreamBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlystackobjectrequiredread-onlyAttributes · StackBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlynamestringrequiredslugstringrequiredread-onlyurlstring · urirequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyissues_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlypermissionsobjectrequiredread-onlyAttributes
isCreatorbooleanrequiredisDatastreamManagerbooleanrequiredisViewerbooleanrequired
stack_idintegerrequiredread-onlyWhich workspace the datastream belongs to.
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
slugstringrequiredread-onlyapp_labelstringrequiredread-onlyabsolute_urlstringrequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyfetch_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlyschema_mapping_urlstringrequiredread-onlyenabledbooleanStreams that are not scheduled will not be fetched automatically.
next_runstring · date-timerequiredread-onlynullableurlstring · urirequiredread-onlydatastream_type_idintegerrequiredread-onlylogo_urlstringrequiredread-onlyextracts_stream_urlstringrequiredread-onlysupports_extended_intervalsbooleanrequiredread-onlyupdatedstring · date-timerequiredread-onlycreatedstring · date-timerequiredread-onlycreatorstringrequiredread-onlynullablecan_be_fetchedbooleanrequiredread-only
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
idintegerrequiredread-onlynamestringrequiredpreview_urlstringrequiredread-onlyrefetch_urlstringrequiredread-onlynullablerequeue_urlstringrequiredread-onlynullablemetadataanydatastream_idintegerrequiredread-only
null
ackbooleanack_urlstringrequiredread-onlyack_group_urlstringrequiredread-onlyretry_urlstringrequiredread-onlyretry_group_urlstringrequiredread-onlyurlstring · urirequiredread-onlymapping_table_change_urlstringrequiredread-onlynullablemapping_entries_change_urlstringrequiredread-onlynullableunmapped_workspace_mappings_urlstringrequiredread-onlynullabletarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullableextraction_stage_labelstringrequiredread-onlynullableerror_cause_labelstringrequiredread-onlynullableerror_resolution_labelstringrequiredread-onlynullableoccurrencesintegerrequiredread-only
Get errors¶
GET/api/errors/{id}/
API key permissionDatastream: Read-onlydatastream:read
Path parameters
idintegerrequiredA unique integer value identifying this Issues.
Responses
200OKapplication/json
Response schema
object DatastreamExtractionLog
idintegerrequiredread-onlyjob_idintegerrequiredread-onlynullablejobobjectrequiredread-onlystartstring · date-timerequiredendstring · date-timerequirednullablemessagestringnullabledisplay_messagestringrequiredread-onlynullabletype_labelstringrequiredread-onlydatastreamobjectrequiredAttributes · APIDatastreamBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlystackobjectrequiredread-onlyAttributes · StackBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlynamestringrequiredslugstringrequiredread-onlyurlstring · urirequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyissues_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlypermissionsobjectrequiredread-onlyAttributes
isCreatorbooleanrequiredisDatastreamManagerbooleanrequiredisViewerbooleanrequired
stack_idintegerrequiredread-onlyWhich workspace the datastream belongs to.
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
slugstringrequiredread-onlyapp_labelstringrequiredread-onlyabsolute_urlstringrequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyfetch_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlyschema_mapping_urlstringrequiredread-onlyenabledbooleanStreams that are not scheduled will not be fetched automatically.
next_runstring · date-timerequiredread-onlynullableurlstring · urirequiredread-onlydatastream_type_idintegerrequiredread-onlylogo_urlstringrequiredread-onlyextracts_stream_urlstringrequiredread-onlysupports_extended_intervalsbooleanrequiredread-onlyupdatedstring · date-timerequiredread-onlycreatedstring · date-timerequiredread-onlycreatorstringrequiredread-onlynullablecan_be_fetchedbooleanrequiredread-only
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
idintegerrequiredread-onlynamestringrequiredpreview_urlstringrequiredread-onlyrefetch_urlstringrequiredread-onlynullablerequeue_urlstringrequiredread-onlynullablemetadataanydatastream_idintegerrequiredread-only
null
ackbooleanack_urlstringrequiredread-onlyack_group_urlstringrequiredread-onlyretry_urlstringrequiredread-onlyretry_group_urlstringrequiredread-onlyurlstring · urirequiredread-onlymapping_table_change_urlstringrequiredread-onlynullablemapping_entries_change_urlstringrequiredread-onlynullableunmapped_workspace_mappings_urlstringrequiredread-onlynullabletarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullableextraction_stage_labelstringrequiredread-onlynullableerror_cause_labelstringrequiredread-onlynullableerror_resolution_labelstringrequiredread-onlynullableoccurrencesintegerrequiredread-only
Create errors confirm¶
POST/api/errors/{id}/confirm/
API key permissionDatastream: Writedatastream:write
Path parameters
idintegerrequiredA 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-timerequiredendstring · date-timerequirednullablemessagestringnullabledatastreamobjectrequiredAttributes · APIDatastreamBasic
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
enabledbooleanStreams that are not scheduled will not be fetched automatically.
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
namestringrequiredmetadataany
null
ackbooleantarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullable
Responses
200OKapplication/json
Response schema
object DatastreamExtractionLog
idintegerrequiredread-onlyjob_idintegerrequiredread-onlynullablejobobjectrequiredread-onlystartstring · date-timerequiredendstring · date-timerequirednullablemessagestringnullabledisplay_messagestringrequiredread-onlynullabletype_labelstringrequiredread-onlydatastreamobjectrequiredAttributes · APIDatastreamBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlystackobjectrequiredread-onlyAttributes · StackBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlynamestringrequiredslugstringrequiredread-onlyurlstring · urirequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyissues_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlypermissionsobjectrequiredread-onlyAttributes
isCreatorbooleanrequiredisDatastreamManagerbooleanrequiredisViewerbooleanrequired
stack_idintegerrequiredread-onlyWhich workspace the datastream belongs to.
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
slugstringrequiredread-onlyapp_labelstringrequiredread-onlyabsolute_urlstringrequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyfetch_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlyschema_mapping_urlstringrequiredread-onlyenabledbooleanStreams that are not scheduled will not be fetched automatically.
next_runstring · date-timerequiredread-onlynullableurlstring · urirequiredread-onlydatastream_type_idintegerrequiredread-onlylogo_urlstringrequiredread-onlyextracts_stream_urlstringrequiredread-onlysupports_extended_intervalsbooleanrequiredread-onlyupdatedstring · date-timerequiredread-onlycreatedstring · date-timerequiredread-onlycreatorstringrequiredread-onlynullablecan_be_fetchedbooleanrequiredread-only
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
idintegerrequiredread-onlynamestringrequiredpreview_urlstringrequiredread-onlyrefetch_urlstringrequiredread-onlynullablerequeue_urlstringrequiredread-onlynullablemetadataanydatastream_idintegerrequiredread-only
null
ackbooleanack_urlstringrequiredread-onlyack_group_urlstringrequiredread-onlyretry_urlstringrequiredread-onlyretry_group_urlstringrequiredread-onlyurlstring · urirequiredread-onlymapping_table_change_urlstringrequiredread-onlynullablemapping_entries_change_urlstringrequiredread-onlynullableunmapped_workspace_mappings_urlstringrequiredread-onlynullabletarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullableextraction_stage_labelstringrequiredread-onlynullableerror_cause_labelstringrequiredread-onlynullableerror_resolution_labelstringrequiredread-onlynullableoccurrencesintegerrequiredread-only
Create errors confirm group¶
POST/api/errors/{id}/confirm_group/
API key permissionDatastream: Writedatastream:write
Path parameters
idintegerrequiredA 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-timerequiredendstring · date-timerequirednullablemessagestringnullabledatastreamobjectrequiredAttributes · APIDatastreamBasic
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
enabledbooleanStreams that are not scheduled will not be fetched automatically.
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
namestringrequiredmetadataany
null
ackbooleantarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullable
Responses
200OKapplication/json
Response schema
object DatastreamExtractionLog
idintegerrequiredread-onlyjob_idintegerrequiredread-onlynullablejobobjectrequiredread-onlystartstring · date-timerequiredendstring · date-timerequirednullablemessagestringnullabledisplay_messagestringrequiredread-onlynullabletype_labelstringrequiredread-onlydatastreamobjectrequiredAttributes · APIDatastreamBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlystackobjectrequiredread-onlyAttributes · StackBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlynamestringrequiredslugstringrequiredread-onlyurlstring · urirequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyissues_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlypermissionsobjectrequiredread-onlyAttributes
isCreatorbooleanrequiredisDatastreamManagerbooleanrequiredisViewerbooleanrequired
stack_idintegerrequiredread-onlyWhich workspace the datastream belongs to.
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
slugstringrequiredread-onlyapp_labelstringrequiredread-onlyabsolute_urlstringrequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyfetch_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlyschema_mapping_urlstringrequiredread-onlyenabledbooleanStreams that are not scheduled will not be fetched automatically.
next_runstring · date-timerequiredread-onlynullableurlstring · urirequiredread-onlydatastream_type_idintegerrequiredread-onlylogo_urlstringrequiredread-onlyextracts_stream_urlstringrequiredread-onlysupports_extended_intervalsbooleanrequiredread-onlyupdatedstring · date-timerequiredread-onlycreatedstring · date-timerequiredread-onlycreatorstringrequiredread-onlynullablecan_be_fetchedbooleanrequiredread-only
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
idintegerrequiredread-onlynamestringrequiredpreview_urlstringrequiredread-onlyrefetch_urlstringrequiredread-onlynullablerequeue_urlstringrequiredread-onlynullablemetadataanydatastream_idintegerrequiredread-only
null
ackbooleanack_urlstringrequiredread-onlyack_group_urlstringrequiredread-onlyretry_urlstringrequiredread-onlyretry_group_urlstringrequiredread-onlyurlstring · urirequiredread-onlymapping_table_change_urlstringrequiredread-onlynullablemapping_entries_change_urlstringrequiredread-onlynullableunmapped_workspace_mappings_urlstringrequiredread-onlynullabletarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullableextraction_stage_labelstringrequiredread-onlynullableerror_cause_labelstringrequiredread-onlynullableerror_resolution_labelstringrequiredread-onlynullableoccurrencesintegerrequiredread-only
Create errors retry¶
POST/api/errors/{id}/retry/
API key permissionDatastream: Writedatastream:write
Path parameters
idintegerrequiredA 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-timerequiredendstring · date-timerequirednullablemessagestringnullabledatastreamobjectrequiredAttributes · APIDatastreamBasic
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
enabledbooleanStreams that are not scheduled will not be fetched automatically.
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
namestringrequiredmetadataany
null
ackbooleantarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullable
Responses
200OKapplication/json
Response schema
object DatastreamExtractionLog
idintegerrequiredread-onlyjob_idintegerrequiredread-onlynullablejobobjectrequiredread-onlystartstring · date-timerequiredendstring · date-timerequirednullablemessagestringnullabledisplay_messagestringrequiredread-onlynullabletype_labelstringrequiredread-onlydatastreamobjectrequiredAttributes · APIDatastreamBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlystackobjectrequiredread-onlyAttributes · StackBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlynamestringrequiredslugstringrequiredread-onlyurlstring · urirequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyissues_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlypermissionsobjectrequiredread-onlyAttributes
isCreatorbooleanrequiredisDatastreamManagerbooleanrequiredisViewerbooleanrequired
stack_idintegerrequiredread-onlyWhich workspace the datastream belongs to.
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
slugstringrequiredread-onlyapp_labelstringrequiredread-onlyabsolute_urlstringrequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyfetch_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlyschema_mapping_urlstringrequiredread-onlyenabledbooleanStreams that are not scheduled will not be fetched automatically.
next_runstring · date-timerequiredread-onlynullableurlstring · urirequiredread-onlydatastream_type_idintegerrequiredread-onlylogo_urlstringrequiredread-onlyextracts_stream_urlstringrequiredread-onlysupports_extended_intervalsbooleanrequiredread-onlyupdatedstring · date-timerequiredread-onlycreatedstring · date-timerequiredread-onlycreatorstringrequiredread-onlynullablecan_be_fetchedbooleanrequiredread-only
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
idintegerrequiredread-onlynamestringrequiredpreview_urlstringrequiredread-onlyrefetch_urlstringrequiredread-onlynullablerequeue_urlstringrequiredread-onlynullablemetadataanydatastream_idintegerrequiredread-only
null
ackbooleanack_urlstringrequiredread-onlyack_group_urlstringrequiredread-onlyretry_urlstringrequiredread-onlyretry_group_urlstringrequiredread-onlyurlstring · urirequiredread-onlymapping_table_change_urlstringrequiredread-onlynullablemapping_entries_change_urlstringrequiredread-onlynullableunmapped_workspace_mappings_urlstringrequiredread-onlynullabletarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullableextraction_stage_labelstringrequiredread-onlynullableerror_cause_labelstringrequiredread-onlynullableerror_resolution_labelstringrequiredread-onlynullableoccurrencesintegerrequiredread-only
Create errors retry group¶
POST/api/errors/{id}/retry_group/
API key permissionDatastream: Writedatastream:write
Path parameters
idintegerrequiredA 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-timerequiredendstring · date-timerequirednullablemessagestringnullabledatastreamobjectrequiredAttributes · APIDatastreamBasic
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
enabledbooleanStreams that are not scheduled will not be fetched automatically.
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
namestringrequiredmetadataany
null
ackbooleantarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullable
Responses
200OKapplication/json
Response schema
object DatastreamExtractionLog
idintegerrequiredread-onlyjob_idintegerrequiredread-onlynullablejobobjectrequiredread-onlystartstring · date-timerequiredendstring · date-timerequirednullablemessagestringnullabledisplay_messagestringrequiredread-onlynullabletype_labelstringrequiredread-onlydatastreamobjectrequiredAttributes · APIDatastreamBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlystackobjectrequiredread-onlyAttributes · StackBasic
idintegerrequiredread-onlyuuidstring · uuidrequiredread-onlynamestringrequiredslugstringrequiredread-onlyurlstring · urirequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyissues_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlypermissionsobjectrequiredread-onlyAttributes
isCreatorbooleanrequiredisDatastreamManagerbooleanrequiredisViewerbooleanrequired
stack_idintegerrequiredread-onlyWhich workspace the datastream belongs to.
authintegernullableWhich authorization the datastream uses.
namestringrequiredA human readable name. Numbers and special characters are supported.
slugstringrequiredread-onlyapp_labelstringrequiredread-onlyabsolute_urlstringrequiredread-onlychange_urlstringrequiredread-onlyextracts_urlstringrequiredread-onlyfetch_urlstringrequiredread-onlyoverview_urlstringrequiredread-onlyschema_mapping_urlstringrequiredread-onlyenabledbooleanStreams that are not scheduled will not be fetched automatically.
next_runstring · date-timerequiredread-onlynullableurlstring · urirequiredread-onlydatastream_type_idintegerrequiredread-onlylogo_urlstringrequiredread-onlyextracts_stream_urlstringrequiredread-onlysupports_extended_intervalsbooleanrequiredread-onlyupdatedstring · date-timerequiredread-onlycreatedstring · date-timerequiredread-onlycreatorstringrequiredread-onlynullablecan_be_fetchedbooleanrequiredread-only
extractobjectrequirednullableNull when the error belongs to no extract, or when the extract has been permanently removed. An extract that is only marked as deleted is still returned as an object.
Attributes
DatastreamExtractNested
idintegerrequiredread-onlynamestringrequiredpreview_urlstringrequiredread-onlyrefetch_urlstringrequiredread-onlynullablerequeue_urlstringrequiredread-onlynullablemetadataanydatastream_idintegerrequiredread-only
null
ackbooleanack_urlstringrequiredread-onlyack_group_urlstringrequiredread-onlyretry_urlstringrequiredread-onlyretry_group_urlstringrequiredread-onlyurlstring · urirequiredread-onlymapping_table_change_urlstringrequiredread-onlynullablemapping_entries_change_urlstringrequiredread-onlynullableunmapped_workspace_mappings_urlstringrequiredread-onlynullabletarget_column_change_urlstringrequirednullabletransformation_config_urlstringrequirednullableextraction_stage_labelstringrequiredread-onlynullableerror_cause_labelstringrequiredread-onlynullableerror_resolution_labelstringrequiredread-onlynullableoccurrencesintegerrequiredread-only