TAG LINE
TAG LINE
SMALL TITLE

Data Import / History

(API Version v7)


Retrieves the history of DataImport jobs.


What can you do with DataImportHistory?


Properties

Property Details
identity
READ-ONLY
"identity": 25
Type: Number
This is the unique numeric identifier for the DataImportHistory
ownerId
READ-ONLY
"ownerId": 0
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
udrFeedId
"udrFeedId": 7
Type: Number
Unique identifier for the associated UDRFeed object.
udrFeedName
"udrFeedName": "Sample Name"
Type: String
The name of the object associated with the udrFeedId property.
dataProfileId
"dataProfileId": 24
Type: Number
Unique identifier for the associated DataProfile object.
dataProfileName
"dataProfileName": "Sample Name"
Type: String
The name of the object associated with the dataProfileId property.
fileName
"fileName": "Hello World"
Type: String
The name of the file imported in the Data Import.
importStart
"importStart": "2021-04-26T15:25:27.587Z"
Type: Date
The date and time the import started.

Date and time values are specified in the ISO 8601 format.
importEnd
"importEnd": "2021-04-26T15:25:27.587Z"
Type: Date
The date and time the import ended.

Date and time values are specified in the ISO 8601 format.
importCount
"importCount": 10
Type: Number
The number of records imported.
importExceptionCount
"importExceptionCount": 12
Type: Number
The number of records that went into exception.
importSkipRecordCount
"importSkipRecordCount": 0
Type: Number
The number of records that were skipped.
importDuplicateCount
"importDuplicateCount": 26
Type: Number
The number of records that were identified as duplicates.
recordCount
"recordCount": 2
Type: Number
The total number of records processed in that job.
dataImportHistoryStatusTypeId
"dataImportHistoryStatusTypeId": 25
Type: Number
Unique identifier for the associated DataImportHistoryStatusType object.
dataImportHistoryStatusTypeName
"dataImportHistoryStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the dataImportHistoryStatusTypeId property.
dataImportUploadId
"dataImportUploadId": 20
Type: Number
Unique identifier for the associated DataImportUpload object.
dataImportUploadName
"dataImportUploadName": "Sample Name"
Type: String
The name of the object associated with the dataImportUploadId property.
fileSize
"fileSize": "Hello World"
Type: String
The size of the file imported.
progressPercent
"progressPercent": 11
Type: Number
The percentage of the file processed.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
createdByUserId
"createdByUserId": 7
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
updated
READ-ONLY
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.
errorMessage
"errorMessage": "Hello World"
Type: String
The error message thrown if an error encountered.
storageLocationId
"storageLocationId": 10
Type: Number
Unique identifier for the associated StorageLocation object.
storageLocationName
"storageLocationName": "Sample Name"
Type: String
The name of the object associated with the storageLocationId property.


End Points

GETDataImport/History/{id}/Detail
Retrieve deep detail of the DataImportHistory object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the DataImportHistory object.
Retrieve deep detail of the DataImportHistory object by its ID.
GET DataImport/History/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 0,
        "ownerName": "Sample Text Data",
        "udrFeedId": 24,
        "udrFeedName": "Sample Text Data",
        "dataProfileId": 5,
        "dataProfileName": "Sample Text Data",
        "fileName": "Sample Text Data",
        "importStart": "2021-04-26T15:25:27.587Z",
        "importEnd": "2021-04-26T15:25:27.587Z",
        "importCount": 6,
        "importExceptionCount": 18,
        "importSkipRecordCount": 24,
        "importDuplicateCount": 24,
        "recordCount": 11,
        "dataImportHistoryStatusTypeId": 1,
        "dataImportHistoryStatusTypeName": "Sample Text Data",
        "dataImportUploadId": 11,
        "dataImportUploadName": "Sample Text Data",
        "fileSize": "Sample Text Data",
        "progressPercent": 6,
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 21,
        "createdByUserName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z",
        "errorMessage": "Sample Text Data",
        "storageLocationId": 20,
        "storageLocationName": "Sample Text Data",
        "details": {
            "dataImportExceptions": [
                {
                    "identity": 58,
                    "importBatchId": 55,
                    "dataImportExceptionErrorTypeId": 32,
                    "dataImportExceptionErrorTypeName": "Sample Text Data",
                    "dataImportExceptionStatusTypeId": 27,
                    "dataImportExceptionStatusTypeName": "Sample Text Data",
                    "originatingFileRecordIndex": 73,
                    "created": "2021-04-26T15:25:27.587Z",
                    "currentDataRevision": {
                        "identity": 68,
                        "dataImportExceptionId": 59,
                        "revisionNumber": 67,
                        "created": "2021-04-26T15:25:27.587Z",
                        "createdByUserId": 25,
                        "createdByUserName": "Sample Text Data",
                        "dataSnippet": "Sample Text Data",
                        "exceptionDate": "2021-04-26T15:25:27.587Z",
                        "message": "Sample Text Data",
                        "messageDetails": "Sample Text Data"
                    }
                }
            ]
        }
    }
}