Send Requests

Use the following guidelines when sending requests using the Oracle Integration Cloud Service REST API.

URL Structure

Access the Oracle Integration Cloud Service REST resources using the following URL structure:
https://domain-integration.region.oraclecloud.com/icsapis/v2/
Where:
  • domain-integration.region.oraclecloud.com - Host where Oracle Integration Cloud Service is running.

    The Service URL listed in the welcome email you receive with your trial or purchased subscription contains this host. Here is an example Service URL:

    https://icssvc-acme.integration.us.oraclecloud.com/ics

    The host in this case is icssvc-acme.integration.us.oraclecloud.com. You use the same host to access the Oracle Integration Cloud Service REST API as you do to access Oracle Integration Cloud Service itself.

    All the examples in this document use integration.us.oraclecloud.com as the host.

  • /icsapis/v2/ - Fixed prefix for Oracle Integration Cloud Service REST resources. For a complete list of resources, see REST Endpoints.

Common Path Parameters

The following table describes each common path parameter. The path parameters are supported with some API operations, but not all.

Name Description
id

For connections, the ID, also called the identifier, is derived from the connection name. It is uppercase and may be changed in other ways: spaces are replaced by underscores and it may be shortened. Additionally, the generated identifier can be overridden with a user specified value.

Other objects such as logs and error instances also have unique identifiers. You can use GET operations to list these identifiers.

ID (identifier) path parameter is often referred to as code in Request and Response bodies.

id for integrations

For integrations, the ID is the identifier and the version separated by a vertical line ( | ) character.

The identifier is derived from the integration name. It is uppercase and may be changed in other ways: spaces are replaced by underscores and it may be shortened. Additionally, the generated identifier can be overridden with a user specified value.

Version numbers are in the format xx.yy.zzzz, where xx is the major version and yy.zzzz is the minor version.

If you don't know the version number, you can try the default version number, which is 01.00.0000.

Integrations having the same code, but a different major version, can be active at the same time.

ID (identifier) path parameter is often referred to as code in Request and Response bodies.

Common Query Parameters

The following table describes each common query parameter. Pass the parameters in URL-encoded format. The query parameters are supported with some API operations, but not all.

The Oracle Integration Cloud Service REST API uses the MongoDB syntax, so it implements the 'like' and the ???exact match??? in a different way:
  • Exact match: q={ paramName1 : 'paramValue1' , paramName2 : 'paramValue2', .... }

  • 'Like'(contains) is implemented as a regular expression in MongoDB: q={ paramName1 : /paramValue1/ , paramName2 : /paramValue2/, .... }

Note:

Other MongoDB operators are not supported.
Name Description
q
{name like 'QUERY'} & {status like 'STATUS'} & {type like 'TYPE'}
where:
  • QUERY is a text query string.

  • STATUS is one of the following:

    • ALL

    • INPROGRESS

    • CONFIGURED

    • ACTIVATED

    • FAILEDACTIVATION

    • LOCKED

    • COMPLETED

    • FAILED

  • TYPE is one of the following:

    • developed

    • custom

    • prebuilt

    • preinstalled

    • private

    • marketplace

  • Operators: exact match, contains

  • Some of the examples are:

    • {name : /MyLookup/, status :'CONFIGURED'}

    • {code : 'SC2RNSYNC' , version : '01.00.0000' , timewindow : '3d'}

    • {name : 'SC2RNSync', type: 'DEVELOPED'}

Not all endpoints that use this parameter support name, status, and type. Some endpoints support name only or name and status only. If this parameter is omitted, all items are returned. The wild card character is *.
q={name like 'org'} 
   q=%7Bname%20like%20%27org%27%7D
q={status like 'INPROGRESS'} 
   q=%7Bstatus%20like%20%27INPROGRESS%27%7D
q={name like 'org'} & {status like 'all'}
   q=%7Bname%20like%20%27org%27%7D%20%26%20%7Bstatus%20like%20%27all%27%7D
orderBy
Either name or time. If this parameter is omitted, the returned items are sorted by time in descending order.
orderBy=name
orderBy=time

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on Oracle Integration Cloud Service using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve information about integration states, monitoring, and packaging.
POST Import, activate, or deactivate integrations and retrieve or create lookups.
PUT Import (update) integrations.
DELETE Delete integrations.
OPTIONS Retrieve metadata links for various resources.

Media Types

The following media types are supported by the Oracle Integration Cloud Service REST API:

  • application/json

  • application/vnd.oracle.resource+json;type=singular

  • application/vnd.oracle.resource+json;type=collection

  • application/octet-stream

  • multipart/form-data

Supported Headers

The Oracle Integration Cloud Service REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json
Accept Media type of the body of the response. Accept: application/json