Trigger Multiple Connect Jobs

Use this interface to trigger one or more existing Connect jobs in a single request. Up to 5 jobs can be triggered in a single request.

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”):
    • Import jobs – for importing data into Profile Lists, Profile Extension Tables (PET), Supplemental Data tables
    • Export jobs – for exporting Profile Lists, Audiences, App channel lists, List filters, Profile extension table data, Supplemental table data
  • 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
Before you begin:

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/trigger

Request Method:

PUT

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body - Required Properties:

  • jobIds - A list of connect job IDs to trigger. Minimum 1, maximum 5.

Sample Request Body

{
  "jobIds": [
    1,
    2,
    3
  ]
}

Sample Response Body - Success

In the sample response below, the jobs 1 and 3 succeeded, while triggering job 2 failed.

{
  "jobId": 1,
  "success": true,
  "jobRunId": 10,
  "links": [
    {
      "rel": "self",
      "href": "/webservices/rest/api/v1.3/connectJobs/trigger",
      "method": "PUT"
    },
    {
      "rel": "getConnectJobRunStatus",
      "href": "/webservices/rest/api/v1.3/connectJobs/1/jobRuns/10/status",
      "method": "GET"
    }
  ]
},
{
  "jobId": 2,
  "success": false,
  "errorMessage": "Connect Job not found"
},
{
  "jobId": 3,
  "success": true,
  "jobRunId": 30,
  "links": [
    {
      "rel": "self",
      "href": "/webservices/rest/api/v1.3/connectJobs/trigger",
      "method": "PUT"
    },
    {
      "rel": "getConnectJobRunStatus",
      "href": "/webservices/rest/api/v1.3/connectJobs/3/jobRuns/30/status",
      "method": "GET"
    }
  ]
}
]

Sample Response Body - Failure

200 OK

Connect Job not found: If the specified connect jobs do not exist, the error response will resemble the following:

[
  {
    "jobId": 1,
    "success": false,
    "errorMessage": "Connect Job not found"
  },
  {
    "jobId": 2,
    "success": false,
    "errorMessage": "Connect Job not found"
  },
  {
    "jobId": 3,
    "success": false,
    "errorMessage": "Connect Job not found"
  }
]

This Connect Job is already running: If one of the specified connect jobs is already running, the error response will resemble the following:

[
  {
    "jobId": 1,
    "success": false,
    "errorMessage": "This Connect Job is already running"
  }
}

Negative job ID: If negative numbers are specified for a job ID, the error response will resemble the following:

[
  {
    "jobId": -129967,
    "success": false,
    "errorMessage": "Invalid jobId : jobId is null (or) less than 0"
  }
]

Decimal job ID: If decimal numbers are specified for a job ID, the error response will resemble the following:

[
  {
    "jobId": -129967,
    "success": false,
    "errorMessage": "Invalid jobId : jobId is null (or) less than 0"
  }
]

400 Bad Request

Decimal job ID: If decimal numbers are specified for a job ID, the error response will resemble the following:

[
  {
    "jobId": -129967,
    "success": false,
    "errorMessage": "Invalid jobId : jobId is null (or) less than 0"
  }
]

Null or empty values specified for job ID: If the job IDs specified contains null or empty values, the error response will resemble the following:

{
  "type": "",
  "title": "Invalid request content",
  "errorCode": "INVALID_REQUEST_CONTENT",
  "detail": "Request body is empty or invalid",
  "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":[]
}

Job ID exceeds long integer value: If any job IDs exceed the long integer limit, the error response will resemble the following:

{
  "type": "",
  "title": "Invalid request content",
  "errorCode": "INVALID_REQUEST_CONTENT",
  "detail": "Request body is empty or invalid",
  "errorDetails": []
}

Connect jobs limit exceeded: The endpoint will return the following error if more than 20 Job IDs are specified. The error response will resemble the following:

{
  "type": "",
  "title": "Connect jobs limit exceeded",
  "errorCode": "CONNECT_JOBS_LIMIT_EXCEEDED",
  "detail": "Number of connect jobs provided exceeds allowed limit of 20 per request",
  "errorDetails": []
}

Note: Triggering Connect jobs using the API is available for all customers. However, this is subject to the internal limits of active Connect jobs. Please submit a service request using the My Oracle Support portal to request a higher active Connect job limit. Requests are subject to approval.

Learn more

Connect Jobs