Name | Type | Description | Constraints |
---|
processId | Long | The ID of the process for which the information is returned. | required |
processName | String | The name of the entity that the process executes. A name is assigned to each entity by an individual system user or by the system when the entity is created. The name provides additional information about the task that is performed. | required |
entityType | String | The kind of entity the process executes. | required |
entityId | String | The unique identification number that the system automatically assigns to each entity. | required |
status | ProcessStatus | An enumerated type that represents the current status of a process. | required |
processedCount | Long | The number of chunks on which work is successfully completed. | required |
totalCount | Long | The entire number of chunks in the process (meaning, the number of chunks into which the work of the process is divided). | required |
startDate | String | The date and time the process began. | required |
estimatedEndDate | String | The date and time that a process is expected to be finished (if an estimate is available). | required |
endDate | String | The date and time that the process was completed. | required |
duration | Long | The length of time the process runs in hours, minutes, and seconds. | required |
executorName | String | The name of the system user who created the entity that is executed in the process. Provided in the format LastName, FirstName. | required |
executorEmail | String | The email address of the system user who created the entity that is executed in the process. | required |
error | String | If an error causes the execution of a process to fail, this property contains information about the kind of error that occurred. | required |