Get Connect Job Status
Use this to retrieve the status of a Connect job. The endpoint will return a status of “running”, “failed”, “succeeded”, or “aborted”.
Note: The Responsys Advanced API is generally available for all Responsys customers.
Service URL:
/rest/api/v1.3/connectJobs/{jobId}/jobRuns/{jobRunID}/status
Required Path Parameters:
-
jobRunID- The Job Run ID of the Connect job. See Get Connect Jobs Runs for more information. -
jobId- Job ID of the existing Connect job that you want to get the status of. See Trigger a Connect Job for information about how to look up the Job ID in Oracle Responsys.
Request Method:
GET
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
Not applicable
Sample Request Body
Not applicable
Sample Response Body - Success
{
"jobRunStatus": "<status>",
"errrorMessage": "<error>",
"recordsProcessed": <recordsProcessed>,
"recordsAdded": <recordsAdded>,
"recordsRejected": <recordsRejected>,
"recordsUpdated": <recordsUpdated>,
"durationInSeconds": <durationInSeconds>
}
Sample Response Body - Failure
400 Bad Request
Invalid request parameters. Error when the job ID in the request URL is non-numeric (if, for instance, the job name was provided instead):
{
"type":"",
"title":"Invalid request parameters",
"errorCode":"INVALID_PARAMETER",
"detail":"Job Id should be a numeric value.",
"errorDetails":[]
}
401 Unauthorized
Connect disabled for user. Error when the user does not have access to Connect:
{
"type": "",
"title": "Connect disabled for user",
"errorCode": "CONNECT_DISABLED_FOR_USER",
"detail": "DataIntegrationGateway not enabled for user.",
"errorDetails": []
}
API disabled for user. Error when the user does not have access to advanced APIs:
{
"type": "",
"title": "API disabled for user",
"errorCode": "API_DISABLED_FOR_USER",
"detail": "API is disabled for user",
"errorDetails": []
}
404 Not Found
Running connect job not found. Error when the job ID in the request URL is invalid:
{
"type": "",
"title": "Connect job not found",
"errorCode": "CONNECT_JOB_NOT_FOUND",
"detail": "Connect Job not found for jobId : 1", // value of job ID sent
"errorDetails": []
}