Data Import / Exception

What can you do with DataImportException?


Properties

Property Details
id
"id": 605
Type: Number
This is the unique numeric identifier for the DataImportException
dataImportHistoryId
"dataImportHistoryId": 262
Type: Number
Unique identifier for the associated DataImportHistory object.
dataImportExceptionErrorTypeId
"dataImportExceptionErrorTypeId": 803
Type: Number
Unique identifier for the associated DataImportExceptionErrorType object.
dataImportExceptionStatusTypeId
"dataImportExceptionStatusTypeId": 495
Type: Number
Unique identifier for the associated DataImportExceptionStatusType object.
originatingFileRecordIndex
"originatingFileRecordIndex": 530
Type: Number


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • dataImportHistoryId
  • dataImportExceptionErrorTypeId
  • dataImportExceptionStatusTypeId
  • originatingFileRecordIndex

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the DataImportException object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/DataImport/Exception/{id:int}
Delete an instance of the DataImportException object.
GETapi/v1/DataImport/Exception
Retrieve all of the DataImportException objects.
GETapi/v1/DataImport/Exception/Metadata
Retrieve all of the meta data details of the DataImportException object.
GETapi/v1/DataImport/Exception/Metadata/{option}
Retrieve all the meta data details of the DataImportException object based on provided options.
{option}Metadata options for the DataImportException object.
GETapi/v1/DataImport/Exception/Paged
Retreive all of the DataImportException objects in a paged fashion.
GETapi/v1/DataImport/Exception/Paged/Detail
Retreive all of the DataImportException objects in a paged fashion with all object details.
GETapi/v1/DataImport/Exception/{id:int}
Retrieve an instance of the DataImportException object by it's ID.
{id:int}Unique identifier for the DataImportException object.
GETapi/v1/DataImport/Exception/{id:int}/Detail
Retreive all of the Detail objects for the specified DataImportException.
{id:int}Unique identifier for the DataImportException object.
POSTapi/v1/DataImport/Exception
Create a new instance of the DataImportException object.