1. <ProductName> REST APIREST API for Deployment Manager 12c
  2. Send Requests

Send Requests

Use the following guidelines when sending requests using the Oracle Identity Governance (OIG) Deployment Manager REST API.

URL Structure

Access the Deployment Manager REST resources using the following URL structure: 
https://<subdomain>.<domain>.com:<port>/<m-base-url>/<resource-path>
Where:

  • <subdomain.domain>.com:<port> ? Host and port where OIG is running.

  • <resource-path> ? Relative path that defines the resource.

  • <dm-base-url> ? Base URL for all Deployment Manager REST APIs in 12c. OIG base URL for Deployment Manager is /iam/governance/configmgmt/rest.

Supported Methods

Deployment Manager REST APIs can import and export an object, all of its dependent, and related objects from one OIG environment to another using standard HTTP method requests, as summarized in the following table:

HTTP Method Description
GET Retrieves one or more partial or complete resources.
POST Creates new resources or creates search requests, depending on the endpoint..
PUT Modifies a resource by replacing existing attributes with a specified set of replacement attributes (replace). PUT must not be used to create new resources.

Media Types

The following media types are supported by the Deployment Manager REST API:

  • application/json

  • application/xml

Supported Headers

The Deployment Manager REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Accept-Encoding List of acceptable encodings to support compression. Accept-Encoding: gzip
Content-Encoding List of acceptable encodings to support compression. Content-Encoding: deflate
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json
Accept Media type for the body of the response. Accept:application/xml
X-ID-TENANT-NAME Identity domain name of the <product name>, used for authentication. X-ID-TENANT-NAME:ExampleIdentityDomain

Compression

Use compression on the Deployment Manager 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.