REST API for Oracle Internet of Things Cloud Service

URL Structure

Access the Oracle IoT Cloud Service REST resources using the URL structure convention described in Conventions.

Roles and Security

Clients making requests to the Oracle IoT Cloud Service REST API resources must be members of pre-defined roles that have sufficient privileges to invoke the desired REST API resource. The roles are described in Understand Oracle IoT Cloud Service User Roles .

Supported Methods

You can perform basic CRUD operations (Create, Read, Update, and Delete) on your Oracle IoT Cloud Service instance using standard HTTP method requests, as summarized in the following table.

HTTP Method	Description
`GET`	Retrieve information about a resource.
`POST`	Create or update a resource.
`PUT`	Update the a resource.
`DELETE`	Delete a resource.

Media Types

Currently, the only media type supported by the Oracle IoT Cloud Service REST API is application/json.

Required Headers

All requests to the Oracle IoT Cloud Service REST API must include the following headers that are 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. Currently, only the `application/json` value is accepted.	`Content-Type: application/json`
`Accept`	Media type of the body of the response. Required for GET requests. Any value other than `application/json` will be rejected with client request error `406 ???Not Acceptable???`.	`Accept: application/json`

Retrieving Partial Resources

See Retrieving Partial Resources for information about how to retrieve partial resources for some of the Oracle IoT Cloud Service REST API resources that support the feature.

Retrieving Resources with Expansion

See Retrieving Resources with Expansion for information about how to retrieve partial resources for some of the Oracle IoT Cloud Service REST API resources that support the feature.

Updating Resources

Information about creating, updating, and deleting resources can be found in Updating Resources

Receiving HATEOAS-based Responses

See Conventions for information about the HATEOAS-based responses that are returned for various requests made to Oracle IoT Cloud Service REST API.

Compression

Use compression on the Oracle IoT Cloud Service REST resource request and response for improved performance. To use compression, include one of the following HTTP headers in the request: Accept-Encoding or Content-Encoding.