Send Requests

Use these guidelines when sending requests using the REST API.

URL Structure

The URL parameters for the REST API for Oracle® Session Delivery Management Cloud (Oracle SDM Cloud) contains Oracle Cloud service endpoint for your region, the tenancy name that you provide for your instance, and its uniform resource identifier (URI).

Access the Oracle® Session Delivery Management Cloud (Oracle SDM Cloud) resources using the following URL structure:

https://< tenant-url>/<tenant-name>/osdmc/ums/rest/v1.0/inventory/nf-mgmt/nfs

Where:

  • <tenant-url> - The Oracle Cloud service endpoint for your region.

  • <tenant-name> - Oracle Cloud tenant identifier (the tenancy/account name) that you provide for your instance.

  • /rest/v1.0/inventory/nf-mgmt/nfs - Relative path that defines the resource, which is the uniform resource identifier (URI) portion of the fixed URL starts with /rest, the major and minor version (/ v1.0) of the API, the API category name (/inventory/nf-mgmt), and the resource (/nfs).

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on the REST API for Oracle® Session Delivery Management Cloud (Oracle SDM Cloud) using standard HTTPS method requests, as summarized in the following table.

HTTP Method Description
GET The specified read-only operation passes query parameters to the resource and retrieves data from the resource without changing it. Unless otherwise specified, this operation returns the configured state of the resource.
POST Submit data to be processed by the specified resource in the request body, and is also able to create a new resource with the details contained in the JSON request body.
PUT Update the specified resource with new information that replaces or modifies the previous data with the following conditions:
  1. This operation cannot be used to create a new resource.
  2. The request body must contain the complete representation of mandatory attributes of the resource.
DELETE Delete the resource. If the resource has already been deleted, a "404 Not Found" response is returned.

Media Types

The REST API for Oracle Communications Session Delivery Manager supports JSON data format in the request and response message.

A request to the API resource always returns a response code through HTTPS. Error response codes typically have two types: 4xx series status codes for client-side issues and 5xx series status codes for server-side issues. An error response also contains an error body in JSON format containing the https status code, server error code, error label and error message that are defined by Oracle SDM Cloud.

Supported Headers

The REST API for Oracle SDM Cloud supports the following headers that may be passed in the header section of the HTTPS request or response. The following table describes the HTTPS request and response headers supported in the REST API.

Header Description Example
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json
Accept Media type of the body of the response. Accept: application/json
Authorization Provide credentials when accessing protected resources on a server. Authorization: <type> <credentials>