Getting information about batch process history

You can also retrieve information about all runs of a given batch process, or a specific run of a given batch process, even when that specific run was not the most recent. This is done using any of the /batch-process/{batchProcessType}/histories endpoints.

For example, the following request returns all runs of the Activity Escalation batch process.

Command

GET /batch-processes/ActivityEsc/histories

Response

{
    "count": 2,
    "data": [
        {
            "attributes": {
                "dateCompleted": "2024-09-19T23:47:34.321Z",
                "dateCreated": "2024-09-19T23:47:34.302Z",
                "description": "Activity escalation monitor",
                "failedOps": 0,
                "id": "ab:Swdab0ToBSDtgSnHcTZZW",
                "internalFailure": false,
                "leaseId": "b1ac375b-8de1-4241-9da2-c132f487ec6e",
                "opsCompleted": 0,
                "ranToCompletion": true,
                "scheduled": false,
                "serverId": "e7fe021f6dfd",
                "startDate": "2024-09-19T23:47:34.313Z",
                "type": "ActivityEsc"
            },
            ...
        },
        {
            "attributes": {
                "dateCompleted": "2024-09-18T03:30:00.033Z",
                "dateCreated": "2024-09-18T03:30:00.009Z",
                "description": "Activity escalation monitor",
                "failedOps": 0,
                "id": "ab:SKQcRxTozlLJVCpZZV1x7",
                "internalFailure": false,
                "leaseId": "efa769b4-6730-4688-8032-4ef13c45df5d",
                "opsCompleted": 0,
                "ranToCompletion": true,
                "scheduled": true,
                "serverId": "e7fe021f6dfd",
                "startDate": "2024-09-19T03:30:00.024Z",
                "type": "ActivityEsc"
            },
            ...
        }
    }
}

The following request returns the run of the Activity Escalation batch process whose ID is ab:SKQcRxTozlLJVCpZZV1x7. Note that this was not the most recent run.

Command

GET /batch-processes/ActivityEsc/histories/ab:SKQcRxTozlLJVCpZZV1x7

Response

{
    "data": {
        "attributes": {
            "dateCompleted": "2024-09-18T03:30:00.033Z",
            "dateCreated": "2024-09-18T03:30:00.009Z",
            "description": "Activity escalation monitor",
            "failedOps": 0,
            "id": "ab:SKQcRxTozlLJVCpZZV1x7",
            "internalFailure": false,
            "leaseId": "efa769b4-6730-4688-8032-4ef13c45df5d",
            "opsCompleted": 0,
            "ranToCompletion": true,
            "scheduled": true,
            "serverId": "e7fe021f6dfd",
            "startDate": "2024-09-19T03:30:00.024Z",
            "type": "ActivityEsc"
        },
        ...