Send Requests

Review the following information before sending requests using the Oracle Service Cloud REST APIs.

URL Structure

Access the Oracle Service Cloud REST resources using the following URL structure:

https://your_site_interface/services/rest/connect/version/resource[/resource_id][/child_resource][/child_resource_id][?query_parameters]

The following table describes the URL syntax.

Parameter Description

your_site_interface

The domain name of your interface, such as mysite.example.com.

version

The API version. In the August 2017 release, only v1.4 and latest are allowed, both of which currently point to CCOM version 1.4.

resource

The name of the resource, for example, incidents.

resource_id

The primary key identifier of the instance of the resource. Must be an integer, for example, 5.

child_resource

The name of the child resource, for example, address or name.

child_resource_id

The primary key identifier of the instance of the child resource. Must be an integer, for example, 7.

query_parameters

The query parameters where allowed, for example, fields or download. For more information, see Using Query Parameters.

For example:

https://mysite.example.com/services/rest/connect/v1.4/accounts/2

Supported Methods

Perform basic CRUD operations (create, read, update, and delete) on your Oracle Service Cloud REST APIs using standard HTTP method requests.

HTTP Method Description

GET

Retrieves data from a resource or object. For more information, see Examples of GET.

POST

Creates an object. For more information, see Examples of POST.

You can also use POST for Executing Analytics Reports.

PATCH

Updates an object. For more information, see Examples of PATCH.

Note:

If PATCH request is blocked or not supported, use HTTP Tunneling for updating your objects.

DELETE

Deletes an object. For more information, see Examples of DELETE.

OPTIONS

Returns a list of allowed verbs for an object type. For more information, see Examples of OPTIONS.

Note:

The PUT method isn't supported.

Media Types

The Oracle Service Cloud REST API supports the application/vnd.oracle.adf.action+json media type.

Metadata Catalog

Use the GET method to retrieve information about REST resources from the metadata catalog. This information includes metadata, such as resource attributes, actions supported on the resource, child resources, and list-of-value resources. For more information, see Using the Metadata Catalog.

Generating and Downloading Swagger

You can download the swagger file for the current release from this document. The swagger file includes information about APIs supported, their child resources, and their properties. You can download the swagger file by clicking the Download link. On the Download page, click the Swagger button to download the swagger file.