Job Status¶
https://{cluster-id}.api.esales.apptus.cloud/api/admin/v4/event-data/job-status
GET¶
The customer data job status can be performed to check the current job status of an export or removal job. More GDPR information is available here.
Request¶
Header parameters¶
| Name | Description | Example |
|---|---|---|
| Api-Key Required | Api-key that was supplied during on-boarding | pkA123456789AB1BE.. |
Query parameters¶
| Name | Description | Example |
|---|---|---|
| jid Required | The id of a event data job. | 962d41f3-1a53-4bb8-bd01-3b85310fb45f |
curl -i \
-X GET \
-H 'Api-Key: pkA123456789AB1BE..' \
"https://{cluster-id}.api.esales.apptus.cloud/api/admin/v4/event-data/job-status?jid=962d41f3-1a53-4bb8-bd01-3b85310fb45f"
Response¶
Response codes¶
| Status | Description |
|---|---|
| 403 | Incorrect cluster credentials. |
| 400 | Invalid or missing required arguments. |
| 200 | Request accepted, check the status of job with the supplied id. |
Response body¶
Example
application/json
{
"jid" : "962d41f3-1a53-4bb8-bd01-3b85310fb45f",
"status" : "created"
}
Schema
EventDataJobResult¶
The object representation of create or checking the status of a event data job.
| Name | Type | Description | Example |
|---|---|---|---|
| jid | string | The identifier of the event data job. | "962d41f3-1a53-4bb8-bd01-3b85310fb45f" |
| status | string | The current status of the job Supported values: not_found, created, waiting, running, done, error. | "created" |