Oracle Cloud Infrastructure Documentation
Try Free Tier

OSub Subscription Commitment Functions

Package: DBMS_CLOUD_OCI_OSS_COMMITMENT

GET_COMMITMENT Function

This API returns the commitment details corresponding to the id provided

Syntax

FUNCTION get_commitment (
  commitment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  x_one_gateway_subscription_id varchar2 DEFAULT NULL,
  x_one_origin_region varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oss_commitment_get_commitment_response_t;

Parameters

Parameter Description

commitment_id

(required) The Commitment Id

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

x_one_gateway_subscription_id

(optional) This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

x_one_origin_region

(optional) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://csaap-e.oracle.com.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_COMMITMENTS Function

This list API returns all commitments for a particular Subscribed Service

Syntax

FUNCTION list_commitments (
  subscribed_service_id varchar2,
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  x_one_gateway_subscription_id varchar2 DEFAULT NULL,
  x_one_origin_region varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oss_commitment_list_commitments_response_t;

Parameters

Parameter Description

subscribed_service_id

(required) This param is used to get the commitments for a particular subscribed service

compartment_id

(required) The OCID of the compartment.

limit

(optional) The maximum number of items to return in a paginated \"List\" call. Default: (`50`) Example: `500`

page

(optional) The value of the `opc-next-page` response header from the previous \"List\" call.

sort_order

(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. You can provide one sort order (`sortOrder`).

Allowed values are: 'TIMECREATED', 'TIMESTART'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

x_one_gateway_subscription_id

(optional) This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

x_one_origin_region

(optional) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://csaap-e.oracle.com.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

Was this article helpful?