Service Catalog Functions

Package: DBMS_CLOUD_OCI_SVC_SERVICE_CATALOG

BULK_REPLACE_SERVICE_CATALOG_ASSOCIATIONS Function

Replace all associations of a given service catalog in one bulk transaction.

Syntax

FUNCTION bulk_replace_service_catalog_associations (
  service_catalog_id varchar2,
  bulk_replace_service_catalog_associations_details dbms_cloud_oci_service_catalog_bulk_replace_service_catalog_associations_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_bulk_replace_service_catalog_associations_response_t;

Parameters

Parameter	Description
`service_catalog_id`	(required) The unique identifier for the service catalog.
`bulk_replace_service_catalog_associations_details`	(required) Details of the service catalog update operation.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

CHANGE_PRIVATE_APPLICATION_COMPARTMENT Function

Moves the specified private application from one compartment to another.

Syntax

FUNCTION change_private_application_compartment (
  private_application_id varchar2,
  change_private_application_compartment_details dbms_cloud_oci_service_catalog_change_private_application_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_change_private_application_compartment_response_t;

Parameters

Parameter	Description
`private_application_id`	(required) The unique identifier for the private application.
`change_private_application_compartment_details`	(required) The details of the request to change the compartment of a given private application.
`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.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

CHANGE_SERVICE_CATALOG_COMPARTMENT Function

Moves the specified service catalog from one compartment to another.

Syntax

FUNCTION change_service_catalog_compartment (
  service_catalog_id varchar2,
  change_service_catalog_compartment_details dbms_cloud_oci_service_catalog_change_service_catalog_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_change_service_catalog_compartment_response_t;

Parameters

Parameter	Description
`service_catalog_id`	(required) The unique identifier for the service catalog.
`change_service_catalog_compartment_details`	(required) The details of the request to change the compartment of a given service catalog.
`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.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

CREATE_PRIVATE_APPLICATION Function

Creates a private application along with a single package to be hosted.

Syntax

FUNCTION create_private_application (
  create_private_application_details dbms_cloud_oci_service_catalog_create_private_application_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_create_private_application_response_t;

Parameters

Parameter	Description
`create_private_application_details`	(required) Private application creation details.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected).
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

CREATE_SERVICE_CATALOG Function

Creates a brand new service catalog in a given compartment.

Syntax

FUNCTION create_service_catalog (
  create_service_catalog_details dbms_cloud_oci_service_catalog_create_service_catalog_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_create_service_catalog_response_t;

Parameters

Parameter	Description
`create_service_catalog_details`	(required) The details for creating a service catalog.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected).
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

CREATE_SERVICE_CATALOG_ASSOCIATION Function

Creates an association between service catalog and a resource.

Syntax

FUNCTION create_service_catalog_association (
  create_service_catalog_association_details dbms_cloud_oci_service_catalog_create_service_catalog_association_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_create_service_catalog_association_response_t;

Parameters

Parameter	Description
`create_service_catalog_association_details`	(required) The details for creating the association between resource and service catalog.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected).
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

DELETE_PRIVATE_APPLICATION Function

Deletes an existing private application.

Syntax

FUNCTION delete_private_application (
  private_application_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_delete_private_application_response_t;

Parameters

Parameter	Description
`private_application_id`	(required) The unique identifier for the private application.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

DELETE_SERVICE_CATALOG Function

Deletes the specified service catalog from the compartment.

Syntax

FUNCTION delete_service_catalog (
  service_catalog_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_delete_service_catalog_response_t;

Parameters

Parameter	Description
`service_catalog_id`	(required) The unique identifier for the service catalog.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

DELETE_SERVICE_CATALOG_ASSOCIATION Function

Removes an association between service catalog and a resource.

Syntax

FUNCTION delete_service_catalog_association (
  service_catalog_association_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_delete_service_catalog_association_response_t;

Parameters

Parameter	Description
`service_catalog_association_id`	(required) The unique identifier of the service catalog association.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

GET_PRIVATE_APPLICATION Function

Gets the details of the specified private application.

Syntax

FUNCTION get_private_application (
  private_application_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_get_private_application_response_t;

Parameters

Parameter	Description
`private_application_id`	(required) The unique identifier for the private application.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

GET_PRIVATE_APPLICATION_ACTION_DOWNLOAD_LOGO Function

Downloads the binary payload of the logo image of the private application.

Syntax

FUNCTION get_private_application_action_download_logo (
  private_application_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_get_private_application_action_download_logo_response_t;

Parameters

Parameter	Description
`private_application_id`	(required) The unique identifier for the private application.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

GET_PRIVATE_APPLICATION_PACKAGE Function

Gets the details of a specific package within a given private application.

Syntax

FUNCTION get_private_application_package (
  private_application_package_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_get_private_application_package_response_t;

Parameters

Parameter	Description
`private_application_package_id`	(required) The unique identifier for the private application package.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

GET_PRIVATE_APPLICATION_PACKAGE_ACTION_DOWNLOAD_CONFIG Function

Downloads the configuration that was used to create the private application package.

Syntax

FUNCTION get_private_application_package_action_download_config (
  private_application_package_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_get_private_application_package_action_download_config_response_t;

Parameters

Parameter	Description
`private_application_package_id`	(required) The unique identifier for the private application package.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

GET_SERVICE_CATALOG Function

Gets detailed information about the service catalog including name, compartmentId

Syntax

FUNCTION get_service_catalog (
  service_catalog_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_get_service_catalog_response_t;

Parameters

Parameter	Description
`service_catalog_id`	(required) The unique identifier for the service catalog.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

GET_SERVICE_CATALOG_ASSOCIATION Function

Gets detailed information about specific service catalog association.

Syntax

FUNCTION get_service_catalog_association (
  service_catalog_association_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_get_service_catalog_association_response_t;

Parameters

Parameter	Description
`service_catalog_association_id`	(required) The unique identifier of the service catalog association.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

GET_WORK_REQUEST Function

Gets the status of the work request with the given ID.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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_APPLICATIONS Function

Lists all the applications in a service catalog or a tenancy. If no parameter is specified, all catalogs from all compartments in the tenancy will be scanned for any type of content.

Syntax

FUNCTION list_applications (
  compartment_id varchar2 DEFAULT NULL,
  service_catalog_id varchar2 DEFAULT NULL,
  entity_type varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  entity_id varchar2 DEFAULT NULL,
  publisher_id dbms_cloud_oci_service_catalog_varchar2_tbl DEFAULT NULL,
  package_type dbms_cloud_oci_service_catalog_varchar2_tbl DEFAULT NULL,
  pricing dbms_cloud_oci_service_catalog_varchar2_tbl DEFAULT NULL,
  is_featured number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_list_applications_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The unique identifier for the compartment.
`service_catalog_id`	(optional) The unique identifier for the service catalog.
`entity_type`	(optional) The type of the application in the service catalog.
`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.
`limit`	(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`display_name`	(optional) Exact match name filter.
`entity_id`	(optional) The unique identifier of the entity associated with service catalog.
`publisher_id`	(optional) Limit results to just this publisher.
`package_type`	(optional) Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned. Allowed values are: 'STACK'
`pricing`	(optional) Name of the pricing type. If multiple pricing types are provided, then any resource with one or more matching pricing models will be returned. Allowed values are: 'FREE', 'BYOL', 'PAYGO'
`is_featured`	(optional) Indicates whether to show only featured resources. If this is set to `false` or is omitted, then all resources will be returned.
`sort_order`	(optional) The sort order to apply, either `ASC` or `DESC`. Default is `ASC`. Allowed values are: 'ASC', 'DESC'
`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://service-catalog.{region}.oci.{secondLevelDomain}.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_PRIVATE_APPLICATION_PACKAGES Function

Lists the packages in the specified private application.

Syntax

FUNCTION list_private_application_packages (
  private_application_id varchar2,
  private_application_package_id varchar2 DEFAULT NULL,
  package_type dbms_cloud_oci_service_catalog_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_list_private_application_packages_response_t;

Parameters

Parameter	Description
`private_application_id`	(required) The unique identifier for the private application.
`private_application_package_id`	(optional) The unique identifier for the private application package.
`package_type`	(optional) Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned. Allowed values are: 'STACK'
`limit`	(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`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.
`sort_by`	(optional) The field to use to sort listed results. You can only specify one field to sort by. `TIMECREATED` displays results in descending order by default. You can change your preference by specifying a different sort order. Allowed values are: 'TIMECREATED', 'VERSION'
`sort_order`	(optional) The sort order to apply, either `ASC` or `DESC`. Default is `ASC`. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) Exact match name filter.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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_PRIVATE_APPLICATIONS Function

Lists all the private applications in a given compartment.

Syntax

FUNCTION list_private_applications (
  compartment_id varchar2,
  private_application_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_list_private_applications_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The unique identifier for the compartment.
`private_application_id`	(optional) The unique identifier for the private application.
`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.
`limit`	(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`sort_by`	(optional) The field to use to sort listed results. You can only specify one field to sort by. Default is `TIMECREATED`. Allowed values are: 'TIMECREATED', 'LIFECYCLESTATE'
`sort_order`	(optional) The sort order to apply, either `ASC` or `DESC`. Default is `ASC`. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) Exact match name filter.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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_SERVICE_CATALOG_ASSOCIATIONS Function

Lists all the resource associations for a specific service catalog.

Syntax

FUNCTION list_service_catalog_associations (
  service_catalog_association_id varchar2 DEFAULT NULL,
  service_catalog_id varchar2 DEFAULT NULL,
  entity_id varchar2 DEFAULT NULL,
  entity_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_list_service_catalog_associations_response_t;

Parameters

Parameter	Description
`service_catalog_association_id`	(optional) The unique identifier for the service catalog association.
`service_catalog_id`	(optional) The unique identifier for the service catalog.
`entity_id`	(optional) The unique identifier of the entity associated with service catalog.
`entity_type`	(optional) The type of the application in the service catalog.
`limit`	(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`sort_order`	(optional) The sort order to apply, either `ASC` or `DESC`. Default is `ASC`. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Default is `TIMECREATED` Allowed values are: 'TIMECREATED'
`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.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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_SERVICE_CATALOGS Function

Lists all the service catalogs in the given compartment.

Syntax

FUNCTION list_service_catalogs (
  compartment_id varchar2,
  service_catalog_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_list_service_catalogs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The unique identifier for the compartment.
`service_catalog_id`	(optional) The unique identifier for the service catalog.
`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.
`limit`	(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`sort_by`	(optional) Default is `TIMECREATED` Allowed values are: 'TIMECREATED'
`sort_order`	(optional) The sort order to apply, either `ASC` or `DESC`. Default is `ASC`. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) Exact match name filter.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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_WORK_REQUEST_ERRORS Function

Return a (paginated) list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`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.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`limit`	(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to apply, either `ASC` or `DESC`. Default is `ASC`. Allowed values are: 'ASC', 'DESC'
`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://service-catalog.{region}.oci.{secondLevelDomain}.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_WORK_REQUEST_LOGS Function

Return a (paginated) list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`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.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`limit`	(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to apply, either `ASC` or `DESC`. Default is `ASC`. Allowed values are: 'ASC', 'DESC'
`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://service-catalog.{region}.oci.{secondLevelDomain}.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_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2 DEFAULT NULL,
  work_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The unique identifier for the compartment.
`work_request_id`	(optional) The ID of the asynchronous work request.
`status`	(optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: 'ACCEPTED', 'FAILED', 'SUCCEEDED'
`resource_id`	(optional) The ID of the resource affected by the work request
`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.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`limit`	(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
`sort_order`	(optional) The sort order to apply, either `ASC` or `DESC`. Default is `ASC`. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

UPDATE_PRIVATE_APPLICATION Function

Updates the details of an existing private application.

Syntax

FUNCTION update_private_application (
  private_application_id varchar2,
  update_private_application_details dbms_cloud_oci_service_catalog_update_private_application_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_update_private_application_response_t;

Parameters

Parameter	Description
`private_application_id`	(required) The unique identifier for the private application.
`update_private_application_details`	(required) The details for updating the private application.
`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.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

UPDATE_SERVICE_CATALOG Function

Updates the details of a previously created service catalog.

Syntax

FUNCTION update_service_catalog (
  service_catalog_id varchar2,
  update_service_catalog_details dbms_cloud_oci_service_catalog_update_service_catalog_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svc_service_catalog_update_service_catalog_response_t;

Parameters

Parameter	Description
`service_catalog_id`	(required) The unique identifier for the service catalog.
`update_service_catalog_details`	(required) Details to update for a service catalog.
`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.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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://service-catalog.{region}.oci.{secondLevelDomain}.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.

Oracle Cloud Infrastructure Documentation Try Free Tier

BULK_REPLACE_SERVICE_CATALOG_ASSOCIATIONS Function 🔗

CHANGE_PRIVATE_APPLICATION_COMPARTMENT Function 🔗

CHANGE_SERVICE_CATALOG_COMPARTMENT Function 🔗

CREATE_PRIVATE_APPLICATION Function 🔗

CREATE_SERVICE_CATALOG Function 🔗

CREATE_SERVICE_CATALOG_ASSOCIATION Function 🔗

DELETE_PRIVATE_APPLICATION Function 🔗

DELETE_SERVICE_CATALOG Function 🔗

DELETE_SERVICE_CATALOG_ASSOCIATION Function 🔗

GET_PRIVATE_APPLICATION Function 🔗

GET_PRIVATE_APPLICATION_ACTION_DOWNLOAD_LOGO Function 🔗

GET_PRIVATE_APPLICATION_PACKAGE Function 🔗

GET_PRIVATE_APPLICATION_PACKAGE_ACTION_DOWNLOAD_CONFIG Function 🔗

GET_SERVICE_CATALOG Function 🔗

GET_SERVICE_CATALOG_ASSOCIATION Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_APPLICATIONS Function 🔗

LIST_PRIVATE_APPLICATION_PACKAGES Function 🔗

LIST_PRIVATE_APPLICATIONS Function 🔗

LIST_SERVICE_CATALOG_ASSOCIATIONS Function 🔗

LIST_SERVICE_CATALOGS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_PRIVATE_APPLICATION Function 🔗

UPDATE_SERVICE_CATALOG Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

BULK_REPLACE_SERVICE_CATALOG_ASSOCIATIONS Function

CHANGE_PRIVATE_APPLICATION_COMPARTMENT Function

CHANGE_SERVICE_CATALOG_COMPARTMENT Function

CREATE_PRIVATE_APPLICATION Function

CREATE_SERVICE_CATALOG Function

CREATE_SERVICE_CATALOG_ASSOCIATION Function

DELETE_PRIVATE_APPLICATION Function

DELETE_SERVICE_CATALOG Function

DELETE_SERVICE_CATALOG_ASSOCIATION Function

GET_PRIVATE_APPLICATION Function

GET_PRIVATE_APPLICATION_ACTION_DOWNLOAD_LOGO Function

GET_PRIVATE_APPLICATION_PACKAGE Function

GET_PRIVATE_APPLICATION_PACKAGE_ACTION_DOWNLOAD_CONFIG Function

GET_SERVICE_CATALOG Function

GET_SERVICE_CATALOG_ASSOCIATION Function

GET_WORK_REQUEST Function

LIST_APPLICATIONS Function

LIST_PRIVATE_APPLICATION_PACKAGES Function

LIST_PRIVATE_APPLICATIONS Function

LIST_SERVICE_CATALOG_ASSOCIATIONS Function

LIST_SERVICE_CATALOGS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_PRIVATE_APPLICATION Function

UPDATE_SERVICE_CATALOG Function