Send Requests

Use these guidelines when sending requests using the Application Management REST API.

URL Structure

Here's the URL structure for the requests:

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

Where:

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

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

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.

HTTP Method	Description
GET	Retrieves one or more complete or partial 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.
PATCH	Modifies a resource with a set of client-specified changes (partial updates).
DELETE	Deletes a resource.
OPTIONS	Default jersey support.
HEAD	Default jersey support.

Media Types

The following media types are supported by the Application Management REST API:

• application/json

• application/xml

Supported Headers

The Application Management 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
X-ID-TENANT-NAME	Identity domain name of the <product name>, used for authentication.	X-ID-TENANT-NAME:ExampleIdentityDomain