Send Requests

Use these guidelines when sending requests using the STAP REST API.

URL Structure

Here's the URL structure for the requests:

apiRoot/apiType/resourcePath
where:
  • apiRoot is for accessing the HTTP Gateway server at either http://hostname:httpPort or https://hostname:httpsPort.
  • apiType is the type of the API:

    • For user endpoints, use /user.

  • resourcePath is the path to the endpoint.
For example, the URL for creating a new user: 
https://hostname:httpsPort/user

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.
PATCH Update a specific part of the resource.
PUT Update the entire resource, replacing the original.

Media Types

The STAP REST API supports the following media types:

  • application/json

Supported Headers

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

Header Description Example
Authority

The host name and port number of your Oracle Services Communications Proxy (SCP) Authority Server. Include this header if your system's communication model includes an SCP.

 Authority: example.com:1534
Authorization

The type of authorization. The STAP REST API uses the OAuth 2.0 bearer token framework.

 Authorization: Bearer accessToken

where accessToken is your client application's OAuth 2.0/Basic access token.

Content-Type

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

 Content-Type: application/json