Trigger a Connect Job
Use this interface to trigger an existing Connect job.
Note: The Responsys Advanced API is generally available for all Responsys customers.
- You can use this interface to trigger the following standard Connect jobs (where Status is “Active”):
- This interface does not support triggering the following types of jobs:
- Partner integration jobs, such as Coremetrics, Salesforce, or Omniture jobs
- Event Feed jobs
- Job group, inactive jobs, or jobs that are already running
An Oracle Responsys user must have created the Connect job, and you must get the Job ID by logging in and viewing it in Connect or by using the Advanced SOAP API’s Connect calls (the documentation for these calls is available from Oracle Responsys by Responsys Management approval only). If you do not have access to Oracle Responsys, please contact the Responsys Account Administrator for assistance.
Service URL:
/rest/api/v1.3/connectJobs/{jobId}/trigger
Required Path Parameters:
-
jobId- Job ID of the existing Connect job that you want to trigger. See “Before you begin” (above) for information about how to look up the Job ID in Oracle Responsys.
Request Method:
PUT
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
No parameters are required, however the request body must contain an empty JSON object. See the example below.
Sample Request Body
{ }
Sample Response Body - Success
{
"jobRunId": 30875907,
"errorMessage": "",
"success": true
}
Sample Response Body - Failure
400 Bad Request
Inactive Connect job error: Trigger Connect Job fails for inactive Connect jobs. The error response will resemble the following:
{
"type": "",
"title": "Connect job not active",
"errorCode": "CONNECT_JOB_INACTIVE",
"detail": "Connect Job status is Inactive and can't be run",
"errorDetails": []
}
Job already running error: If a job is already running, a Trigger Connect Job request will fail. The error response will resemble the following:
{
"type": "",
"title": "Connect job already running",
"errorCode": "CONNECT_JOB_ALREADY_RUNNING",
"detail": "This Connect Job is already running",
"errorDetails": []
}
Unsupported character (such as an alphabetic character) in the Job ID: Job IDs are always numeric values. Trigger Connect Job fails if the Job ID contains alphabetic or other unsupported characters. The error response will resemble the following:
{
"type":"",
"title":"Invalid request parameters",
"errorCode":"INVALID_PARAMETER",
"detail":"Job Id should be a numeric value.",
"errorDetails":[]
}
Event Feed job error: The API does not support event feed export jobs. Trigger Connect Job fails for these job types. The error response will resemble the following:
{
"type":"",
"title":"Can not run connect job",
"errorCode":"CANNOT_RUN_CONNECT_JOB",
"detail":"Cannot run job on a Event Feed Connect Job",
"errorDetails":[]
}
Group job error: The API does not support group jobs. Trigger Connect Job fails if you try to trigger the running of a group job. The error response will resemble the following:
{
"type":"",
"title":"Can not run connect job",
"errorCode":"CANNOT_RUN_CONNECT_JOB",
"detail":"Cannot run a job that is part of a group",
"errorDetails":[]
}
404 Not Found
Invalid Job ID error: If the path contains an invalid Job ID, the Trigger Connect Job request will fail. The error response will resemble the following:
{
"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": []
}
500 Internal Server Error
Partner integration job errors: The API does not support partner integration jobs, such as Salesforce, Coremetrics, Omniture, and the like. Trigger Connect Job fails for these job types. The error responses will resemble the following:
{
"type": "",
"title": "Can not run connect job",
"errorCode": "CANNOT_RUN_CONNECT_JOB",
"detail": "Cannot run job on a Omniture Genesis Job",
"errorDetails": []
}