Retrieve batch jobs
GET /v2/batchFlowsJob?flowRef=<flowRef>
Retrieves a list of batch jobs for a flow. You must include the flow reference as a query string parameter in the URI of the request.
|
Parameter name |
Type |
Description |
Example |
|---|---|---|---|
|
|
string |
The flow reference. |
|
In the response, items.ref contains the reference of the batch job.
You use the batch job reference to retrieve a specific batch job and to retrieve batch outputs.
RequestResponse
curl -X GET '<baseURL>/v2/batchFlowsJob?flowRef=06ae8113-c1cb-4627-9d7c-d636270d0b1f' \
-u '<username>:<password>' \
-H 'Accept: application/json'RequestResponse
{
"href": "<baseURL>/v2/batchFlowsJob?offset=0&limit=10&flowRef=06ae8113-c1cb-4627-9d7c-d636270d0b1f",
"offset": 0,
"limit": 10,
"first": {
"href": "<baseURL>/v2/batchFlowsJob?offset=0&limit=10&flowRef=06ae8113-c1cb-4627-9d7c-d636270d0b1f"
},
"last": {
"href": "<baseURL>/v2/batchFlowsJob?offset=0&limit=10&flowRef=06ae8113-c1cb-4627-9d7c-d636270d0b1f"
},
"items": [
{
"ref": "2fb3d8e8-cbf4-46ad-a2f2-fbf34015dd77",
"clientKey": "pqsPERS3lw12v5a9rrHPW1c4hET73GxQ",
"flowRef": "06ae8113-c1cb-4627-9d7c-d636270d0b1f",
"segmentRef": "1655b5bb-9e5b-4d31-be99-1027b4b29e2c",
"datasetDate": "2024-10-19T00:00:00.000Z",
"oozieWorkflowId": "0009402-220704110919276-oozie-oozi-W",
"status": "SUCCESS",
"statusDescription": "",
"s3GuestContextPath": "s3://sitecore-data-derived-production-eu-west-1/guest-contexts/2024/10/19/pqsPERS3lw12v5a9rrHPW1c4hET73GxQ/",
"s3FlowExecutionPath": "s3://sitecore-batch-flows-production-eu-west-1/2024/10/19/pqsPERS3lw12v5a9rrHPW1c4hET73GxQ",
"startTime": "2024-10-19T09:57:22.439Z",
"endTime": "2024-10-19T09:57:30.188Z",
"guestContextSize": -1,
"segmentSize": 19,
"numberPartitions": 64,
"createdAt": "2024-10-19T08:24:59.261Z",
"modifiedAt": "2024-10-19T09:57:30.188Z"
}
]
}