Send Requests

Use the following guidelines when sending requests using the REST API.

URL Structure

Access the REST resources using the following URL structure:

https://<subdomain>.<domain>.com:<port>/data/api<resource-path>

Where:

• <subdomain.domain>.com:<port> = the endpoint host and port where the service is running

• <resource-path> = the relative path that defines the resource

Note:

It's important to always encode URL parameters when calling the REST API using an appropriate library, such as java.net.URLEncoder.

Supported Methods

The rest endpoints support one or more of the HTTP methods described in the following table:

HTTP Method	Description
GET	Retrieves information identified by the Request-URI.
POST	Accepts the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line.
PUT	Requests that the enclosed entity be stored/updated under the supplied Request-URI.
DELETE	Deletes the resource identified by the Request-URI.

Media Types

The following media types are supported by the REST API:

• application/json

• application/xml

Supported Headers

The 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