TAG LINE
TAG LINE
SMALL TITLE

View Data Import Exceptions By History

(API Version v8)


This allows for querying any of the import exceptions that may have occured.


What can you do with DataImportHistory?



End Points

GETDataImportHistory/Exception/Paged
Retrieve all the data import exceptions in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all the data import exceptions in a paged fashion.
GET DataImportHistory/Exception/Paged
View Sample Response
HTTP/1.1 200 OK
{
  "pagination": {
    "pageNumber": 1,
    "pageSize": 20,
    "excludeTotalCount": false
  },
  "pagedResults": {
    "totalCount": 2,
    "items": [
      {
        "dataImportExceptionId": 1,
        "importBatchId": 31,
        "dataImportExceptionErrorTypeId": 8,
        "dataImportExceptionErrorTypeName": "Unknown Error",
        "dataImportExceptionStatusTypeId": 1,
        "dataImportExceptionStatusTypeName": "New",
        "originatingFileRecordIndex": 1,
        "created": "2023-05-19T12:55:32.55Z",
        "dataImportHistoryId": 1,
        "dataImportExceptionDataRevisionId": 9,
        "revisionNumber": 1,
        "dataSnippet": "UsageClassName,RaterType,BaseUnit,UsageClassTypeName,ServiceTaxCategory",
        "exceptionDate": "2023-05-19T12:55:32Z",
        "message": "Could not find a match for UsageRaterTypeName with value 'RaterType'.",
        "messageDetails": "Could not find a match for UsageRaterTypeName with value 'RaterType'.",
        "fileName": "Usage Class Import Sample - Sheet1.csv",
        "importBatchTypeId": 3,
        "importBatchTypeName": "Non-Usage By File"
      }
    ]
  }
}
GETDataImportHistory/{id}/Exception
Retrieve data import exception based on its id.
{id}Unique identifier for the DataImportHistory object.
Retrieve data import exception based on its id.
GET DataImportHistory/{id}/Exception
View Sample Response
HTTP/1.1 200 OK
{
  "totalCount": 1,
  "items": [
    {
      "dataImportExceptionId": 1,
      "importBatchId": 31,
      "dataImportExceptionErrorTypeId": 8,
      "dataImportExceptionErrorTypeName": "Unknown Error",
      "dataImportExceptionStatusTypeId": 1,
      "dataImportExceptionStatusTypeName": "New",
      "originatingFileRecordIndex": 1,
      "created": "2023-05-19T12:55:32.55Z",
      "dataImportHistoryId": 1,
      "dataImportExceptionDataRevisionId": 9,
      "revisionNumber": 1,
      "dataSnippet": "UsageClassName,RaterType,BaseUnit,UsageClassTypeName,ServiceTaxCategory",
      "exceptionDate": "2023-05-19T12:55:32Z",
      "message": "Could not find a match for UsageRaterTypeName with value 'RaterType'.",
      "messageDetails": "Could not find a match for UsageRaterTypeName with value 'RaterType'.",
      "fileName": "Usage Class Import Sample - Sheet1.csv",
      "importBatchTypeId": 3,
      "importBatchTypeName": "Non-Usage By File"
    }
  ]
}
GETDataImportHistory/{id}/Exception/Paged
Retrieve data import exception based on its id.
{id}Unique identifier for the DataImportHistory object.
Retrieve data import exception based on its id.
GET DataImportHistory/{id}/Exception/Paged
View Sample Response
HTTP/1.1 200 OK
{
  "pagination": {
    "pageNumber": 1,
    "pageSize": 20,
    "excludeTotalCount": false
  },
  "pagedResults": {
    "totalCount": 1,
    "items": [
      {
        "dataImportExceptionId": 1,
        "importBatchId": 31,
        "dataImportExceptionErrorTypeId": 8,
        "dataImportExceptionErrorTypeName": "Unknown Error",
        "dataImportExceptionStatusTypeId": 1,
        "dataImportExceptionStatusTypeName": "New",
        "originatingFileRecordIndex": 1,
        "created": "2023-05-19T12:55:32.55Z",
        "dataImportHistoryId": 1,
        "dataImportExceptionDataRevisionId": 9,
        "revisionNumber": 1,
        "dataSnippet": "UsageClassName,RaterType,BaseUnit,UsageClassTypeName,ServiceTaxCategory",
        "exceptionDate": "2023-05-19T12:55:32Z",
        "message": "Could not find a match for UsageRaterTypeName with value 'RaterType'.",
        "messageDetails": "Could not find a match for UsageRaterTypeName with value 'RaterType'.",
        "fileName": "Usage Class Import Sample - Sheet1.csv",
        "importBatchTypeId": 3,
        "importBatchTypeName": "Non-Usage By File"
      }
    ]
  }
}