API Response Fields

The JSON response message contains the following fields:

Response Field

Description

internaleventname

The internal name of the event being monitored.

itkDisplayNames

The ITK display name(s) of the event(s). For example, “Batch Data Load” and “Import Batch Data”.

eventDisplayName

The external name, shown on the user interface, of the event being monitored.

checkSum

The number of data bits transferred in the import or export event.

eventStartTime

The start time of the event being monitored in EPOCH format.

eventEndTime

The end time of the event being monitored in EPOCH format.

eventStatus

This field contains one of the following values, to indicate how successful the import or export event was:

  • 0 - The event did not run

  • 1 - The event completed successfully

  • 2 - The event completed with warning

  • 3 - The event is in progress

  • 4 - The event failed to run due to an error

recordsCreated

The number of records created as a result of an import event.

recordsUpdated

The number of records updated as a result of an import event.

recordsDeleted

The number of records deleted as a result of an import event.

recordsExported

The number of records exported as a result of an export event.

clientDetails

This section shows information related to the ITK version and the details of the client system from where the data was uploaded via ITK.

errorDetails

This section shows the error details of the event.

subEvents

This section will be present if the event being monitored is a batch event. It shows the event status of an individual event which is part of the batch event.

percentageCompletionOfCurrentFile(s)

The percentage of completion of the file being processed by the data import task. New in v2.

percentageCompletionOfFiles

The percentage of completion of files in a ZIP file. This is updated after each file is processed. New in v2.

file(s)InProgress

The file being processed by the data import task. New in v2.

filesProcessed

The number of files processed in a ZIP file. New in v2.

filesPending

The number of files remaining to be processed in a ZIP file. New in v2.