Send Requests

Use these guidelines when sending requests using the Offline Mediation Controller REST API.

URL Structure

Here's the URL structure for the requests:

apiRoot/resourcePath
where:
  • apiroot is for accessing the HTTP Gateway server at either http://hostname:port or https://hostname:port
  • resourcePath is the path to the endpoint.
For example, the URL for updating a node:
http://hostname:port/nodes/{id}

Supported Methods

You can perform create and read operations on a resource by using standard HTTP/HTTPS method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve information about the resource.
POST Create the resource.
DELETE Delete the resource.
PUT Update the entire resource, replacing the original.
PATCH Update a specific part of the resource.

Media Types

The following media types are supported by the Offline Mediation Controller REST API:

  • application/json

Supported Headers

The Offline Mediation Controller REST API supports the following headers that may be passed in the header section of the HTTP/HTTPS request or response:

Header Description Example
Content-Type

Media type of the request body. This is required for POST and PUT requests.

Content-Type: application/json