Fusion Apps Functions

Package: DBMS_CLOUD_OCI_FA_FUSION_APPLICATIONS

CHANGE_FUSION_ENVIRONMENT_COMPARTMENT Function

Moves a FusionEnvironment into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_fusion_environment_compartment (
  fusion_environment_id varchar2,
  change_fusion_environment_compartment_details dbms_cloud_oci_fusion_apps_change_fusion_environment_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fa_fusion_applications_change_fusion_environment_compartment_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

change_fusion_environment_compartment_details

(required) The details of change compartment request.

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) The client request ID for tracing.

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.

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://fusionapps.{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_FUSION_ENVIRONMENT_FAMILY_COMPARTMENT Function

Moves a FusionEnvironmentFamily into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_fusion_environment_family_compartment (
  fusion_environment_family_id varchar2,
  change_fusion_environment_family_compartment_details dbms_cloud_oci_fusion_apps_change_fusion_environment_family_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fa_fusion_applications_change_fusion_environment_family_compartment_response_t;

Parameters

Parameter Description

fusion_environment_family_id

(required) The unique identifier (OCID) of the FusionEnvironmentFamily.

change_fusion_environment_family_compartment_details

(required) Details for the compartment move.

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) The client request ID for tracing.

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.

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://fusionapps.{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_DATA_MASKING_ACTIVITY Function

Creates a new DataMaskingActivity.

Syntax

FUNCTION create_data_masking_activity (
  fusion_environment_id varchar2,
  create_data_masking_activity_details dbms_cloud_oci_fusion_apps_create_data_masking_activity_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_fa_fusion_applications_create_data_masking_activity_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

create_data_masking_activity_details

(required) Details for the new DataMaskingActivity.

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) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT Function

Creates a new FusionEnvironment.

Syntax

FUNCTION create_fusion_environment (
  create_fusion_environment_details dbms_cloud_oci_fusion_apps_create_fusion_environment_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_fa_fusion_applications_create_fusion_environment_response_t;

Parameters

Parameter Description

create_fusion_environment_details

(required) Details for the new FusionEnvironment.

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) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_ADMIN_USER Function

Create a FusionEnvironment admin user

Syntax

FUNCTION create_fusion_environment_admin_user (
  create_fusion_environment_admin_user_details dbms_cloud_oci_fusion_apps_create_fusion_environment_admin_user_details_t,
  fusion_environment_id varchar2,
  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_fa_fusion_applications_create_fusion_environment_admin_user_response_t;

Parameters

Parameter Description

create_fusion_environment_admin_user_details

(required) The admin user to be created.

fusion_environment_id

(required) unique FusionEnvironment identifier

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) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_FAMILY Function

Creates a new FusionEnvironmentFamily.

Syntax

FUNCTION create_fusion_environment_family (
  create_fusion_environment_family_details dbms_cloud_oci_fusion_apps_create_fusion_environment_family_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_fa_fusion_applications_create_fusion_environment_family_response_t;

Parameters

Parameter Description

create_fusion_environment_family_details

(required) Details for the new FusionEnvironmentFamily.

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) The client request ID for tracing.

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://fusionapps.{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_REFRESH_ACTIVITY Function

Creates a new RefreshActivity.

Syntax

FUNCTION create_refresh_activity (
  fusion_environment_id varchar2,
  create_refresh_activity_details dbms_cloud_oci_fusion_apps_create_refresh_activity_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_fa_fusion_applications_create_refresh_activity_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

create_refresh_activity_details

(required) Details for the new RefreshActivity.

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) The client request ID for tracing.

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://fusionapps.{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_ATTACHMENT Function

Attaches a service instance to the fusion pod.

Syntax

FUNCTION create_service_attachment (
  create_service_attachment_details dbms_cloud_oci_fusion_apps_create_service_attachment_details_t,
  fusion_environment_id varchar2,
  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_fa_fusion_applications_create_service_attachment_response_t;

Parameters

Parameter Description

create_service_attachment_details

(required) Details for the service attachment.

fusion_environment_id

(required) unique FusionEnvironment identifier

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) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT Function

Deletes the Fusion environment identified by it's OCID.

Syntax

FUNCTION delete_fusion_environment (
  fusion_environment_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_fa_fusion_applications_delete_fusion_environment_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

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) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_ADMIN_USER Function

Deletes the FusionEnvironment administrator user identified by the username.

Syntax

FUNCTION delete_fusion_environment_admin_user (
  admin_username varchar2,
  fusion_environment_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_fa_fusion_applications_delete_fusion_environment_admin_user_response_t;

Parameters

Parameter Description

admin_username

(required) The admin user name for the fusion environment.

fusion_environment_id

(required) unique FusionEnvironment identifier

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) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_FAMILY Function

Deletes a FusionEnvironmentFamily resource by identifier

Syntax

FUNCTION delete_fusion_environment_family (
  fusion_environment_family_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_fa_fusion_applications_delete_fusion_environment_family_response_t;

Parameters

Parameter Description

fusion_environment_family_id

(required) The unique identifier (OCID) of the FusionEnvironmentFamily.

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) The client request ID for tracing.

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://fusionapps.{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_REFRESH_ACTIVITY Function

Deletes a scheduled RefreshActivity resource by identifier

Syntax

FUNCTION delete_refresh_activity (
  fusion_environment_id varchar2,
  refresh_activity_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_fa_fusion_applications_delete_refresh_activity_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

refresh_activity_id

(required) The unique identifier (OCID) of the Refresh activity.

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) The client request ID for tracing.

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://fusionapps.{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_ATTACHMENT Function

Delete a service attachment by identifier

Syntax

FUNCTION delete_service_attachment (
  fusion_environment_id varchar2,
  service_attachment_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_fa_fusion_applications_delete_service_attachment_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

service_attachment_id

(required) OCID of the Service Attachment

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) The client request ID for tracing.

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://fusionapps.{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_DATA_MASKING_ACTIVITY Function

Gets a DataMaskingActivity by identifier

Syntax

FUNCTION get_data_masking_activity (
  fusion_environment_id varchar2,
  data_masking_activity_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_fa_fusion_applications_get_data_masking_activity_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

data_masking_activity_id

(required) Unique DataMasking run identifier.

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT Function

Gets a FusionEnvironment by identifier

Syntax

FUNCTION get_fusion_environment (
  fusion_environment_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_fa_fusion_applications_get_fusion_environment_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_FAMILY Function

Retrieves a fusion environment family identified by its OCID.

Syntax

FUNCTION get_fusion_environment_family (
  fusion_environment_family_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_fa_fusion_applications_get_fusion_environment_family_response_t;

Parameters

Parameter Description

fusion_environment_family_id

(required) The unique identifier (OCID) of the FusionEnvironmentFamily.

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_FAMILY_LIMITS_AND_USAGE Function

Gets the number of environments (usage) of each type in the fusion environment family, as well as the limit that's allowed to be created based on the group's associated subscriptions.

Syntax

FUNCTION get_fusion_environment_family_limits_and_usage (
  fusion_environment_family_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_fa_fusion_applications_get_fusion_environment_family_limits_and_usage_response_t;

Parameters

Parameter Description

fusion_environment_family_id

(required) The unique identifier (OCID) of the FusionEnvironmentFamily.

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_FAMILY_SUBSCRIPTION_DETAIL Function

Gets the subscription details of an fusion environment family.

Syntax

FUNCTION get_fusion_environment_family_subscription_detail (
  fusion_environment_family_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_fa_fusion_applications_get_fusion_environment_family_subscription_detail_response_t;

Parameters

Parameter Description

fusion_environment_family_id

(required) The unique identifier (OCID) of the FusionEnvironmentFamily.

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_STATUS Function

Gets the status of a Fusion environment identified by its OCID.

Syntax

FUNCTION get_fusion_environment_status (
  fusion_environment_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_fa_fusion_applications_get_fusion_environment_status_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_REFRESH_ACTIVITY Function

Gets a RefreshActivity by identifier

Syntax

FUNCTION get_refresh_activity (
  fusion_environment_id varchar2,
  refresh_activity_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_fa_fusion_applications_get_refresh_activity_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

refresh_activity_id

(required) The unique identifier (OCID) of the Refresh activity.

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_SCHEDULED_ACTIVITY Function

Gets a ScheduledActivity by identifier

Syntax

FUNCTION get_scheduled_activity (
  fusion_environment_id varchar2,
  scheduled_activity_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_fa_fusion_applications_get_scheduled_activity_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

scheduled_activity_id

(required) Unique ScheduledActivity identifier.

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_ATTACHMENT Function

Gets a Service Attachment by identifier

Syntax

FUNCTION get_service_attachment (
  fusion_environment_id varchar2,
  service_attachment_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_fa_fusion_applications_get_service_attachment_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

service_attachment_id

(required) OCID of the Service Attachment

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_fa_fusion_applications_get_work_request_response_t;

Parameters

Parameter Description

work_request_id

(required) The ID of the asynchronous request.

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_ADMIN_USERS Function

List all FusionEnvironment admin users

Syntax

FUNCTION list_admin_users (
  fusion_environment_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_fa_fusion_applications_list_admin_users_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_DATA_MASKING_ACTIVITIES Function

Returns a list of DataMaskingActivities.

Syntax

FUNCTION list_data_masking_activities (
  fusion_environment_id varchar2,
  lifecycle_state 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_fa_fusion_applications_list_data_masking_activities_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

lifecycle_state

(optional) A filter that returns all resources that match the specified status

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME'

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_FAMILIES Function

Returns a list of FusionEnvironmentFamilies.

Syntax

FUNCTION list_fusion_environment_families (
  compartment_id varchar2,
  fusion_environment_family_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state 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_fa_fusion_applications_list_fusion_environment_families_response_t;

Parameters

Parameter Description

compartment_id

(required) The ID of the compartment in which to list resources.

fusion_environment_family_id

(optional) The ID of the fusion environment family in which to list resources.

display_name

(optional) A filter to return only resources that match the entire display name given.

lifecycle_state

(optional) A filter that returns all resources that match the specified lifecycle state.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME'

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENTS Function

Returns a list of FusionEnvironments.

Syntax

FUNCTION list_fusion_environments (
  compartment_id varchar2,
  fusion_environment_family_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state 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_fa_fusion_applications_list_fusion_environments_response_t;

Parameters

Parameter Description

compartment_id

(required) The ID of the compartment in which to list resources.

fusion_environment_family_id

(optional) The ID of the fusion environment family in which to list resources.

display_name

(optional) A filter to return only resources that match the entire display name given.

lifecycle_state

(optional) A filter that returns all resources that match the specified lifecycle state.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME'

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_REFRESH_ACTIVITIES Function

Returns a list of RefreshActivities.

Syntax

FUNCTION list_refresh_activities (
  fusion_environment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  time_scheduled_start_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_expected_finish_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  lifecycle_state 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_fa_fusion_applications_list_refresh_activities_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

display_name

(optional) A filter to return only resources that match the entire display name given.

time_scheduled_start_greater_than_or_equal_to

(optional) A filter that returns all resources that are scheduled after this date

time_expected_finish_less_than_or_equal_to

(optional) A filter that returns all resources that end before this date

lifecycle_state

(optional) A filter that returns all resources that match the specified status

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME'

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_SCHEDULED_ACTIVITIES Function

Returns a list of ScheduledActivities.

Syntax

FUNCTION list_scheduled_activities (
  fusion_environment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  time_scheduled_start_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_expected_finish_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  run_cycle varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  scheduled_activity_association_id varchar2 DEFAULT NULL,
  scheduled_activity_phase 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_fa_fusion_applications_list_scheduled_activities_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

display_name

(optional) A filter to return only resources that match the entire display name given.

time_scheduled_start_greater_than_or_equal_to

(optional) A filter that returns all resources that are scheduled after this date

time_expected_finish_less_than_or_equal_to

(optional) A filter that returns all resources that end before this date

run_cycle

(optional) A filter that returns all resources that match the specified run cycle.

lifecycle_state

(optional) A filter that returns all resources that match the specified status

scheduled_activity_association_id

(optional) A filter that returns all resources that match the specified scheduledActivityAssociationId.

scheduled_activity_phase

(optional) A filter that returns all resources that match the specified scheduledActivityPhase.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME'

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_ATTACHMENTS Function

Returns a list of service attachments.

Syntax

FUNCTION list_service_attachments (
  fusion_environment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  service_instance_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_fa_fusion_applications_list_service_attachments_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

display_name

(optional) A filter to return only resources that match the entire display name given.

lifecycle_state

(optional) A filter that returns all resources that match the specified lifecycle state.

service_instance_type

(optional) A filter that returns all resources that match the specified lifecycle state.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME'

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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_TIME_AVAILABLE_FOR_REFRESHES Function

Gets available refresh time for this fusion environment

Syntax

FUNCTION list_time_available_for_refreshes (
  fusion_environment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 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_fa_fusion_applications_list_time_available_for_refreshes_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

opc_request_id

(optional) The client request ID for tracing.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME'

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://fusionapps.{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,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fa_fusion_applications_list_work_request_errors_response_t;

Parameters

Parameter Description

work_request_id

(required) The ID of the asynchronous request.

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 use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) The client request ID for tracing.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

limit

(optional) The maximum number of items to return.

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://fusionapps.{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_fa_fusion_applications_list_work_request_logs_response_t;

Parameters

Parameter Description

work_request_id

(required) The ID of the asynchronous request.

opc_request_id

(optional) The client request ID for tracing.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

limit

(optional) The maximum number of items to return.

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 use, either 'asc' or 'desc'.

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://fusionapps.{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,
  status varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fa_fusion_applications_list_work_requests_response_t;

Parameters

Parameter Description

compartment_id

(required) The ID of the compartment in which to list resources.

status

(optional) A filter to return only resources their lifecycleState matches the given OperationStatus.

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 use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

resource_id

(optional) The ID of the a resource in which to list associated resources.

opc_request_id

(optional) The client request ID for tracing.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

limit

(optional) The maximum number of items to return.

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://fusionapps.{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.

RESET_FUSION_ENVIRONMENT_PASSWORD Function

Resets the password of the Fusion Environment Administrator.

Syntax

FUNCTION reset_fusion_environment_password (
  reset_fusion_environment_password_details dbms_cloud_oci_fusion_apps_reset_fusion_environment_password_details_t,
  fusion_environment_id varchar2,
  admin_username varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_fa_fusion_applications_reset_fusion_environment_password_response_t;

Parameters

Parameter Description

reset_fusion_environment_password_details

(required) The information to be updated.

fusion_environment_id

(required) unique FusionEnvironment identifier

admin_username

(required) The admin user name for the fusion environment.

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) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT Function

Updates the FusionEnvironment

Syntax

FUNCTION update_fusion_environment (
  fusion_environment_id varchar2,
  update_fusion_environment_details dbms_cloud_oci_fusion_apps_update_fusion_environment_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_fa_fusion_applications_update_fusion_environment_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

update_fusion_environment_details

(required) The information to be updated.

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) The client request ID for tracing.

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://fusionapps.{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_FUSION_ENVIRONMENT_FAMILY Function

Updates the FusionEnvironmentFamily

Syntax

FUNCTION update_fusion_environment_family (
  fusion_environment_family_id varchar2,
  update_fusion_environment_family_details dbms_cloud_oci_fusion_apps_update_fusion_environment_family_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_fa_fusion_applications_update_fusion_environment_family_response_t;

Parameters

Parameter Description

fusion_environment_family_id

(required) The unique identifier (OCID) of the FusionEnvironmentFamily.

update_fusion_environment_family_details

(required) The information to be updated.

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) The client request ID for tracing.

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://fusionapps.{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_REFRESH_ACTIVITY Function

Updates a scheduled RefreshActivity.

Syntax

FUNCTION update_refresh_activity (
  fusion_environment_id varchar2,
  refresh_activity_id varchar2,
  update_refresh_activity_details dbms_cloud_oci_fusion_apps_update_refresh_activity_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_fa_fusion_applications_update_refresh_activity_response_t;

Parameters

Parameter Description

fusion_environment_id

(required) unique FusionEnvironment identifier

refresh_activity_id

(required) The unique identifier (OCID) of the Refresh activity.

update_refresh_activity_details

(required) Details for the updating scheduled RefreshActivity.

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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.

VERIFY_SERVICE_ATTACHMENT Function

Verify whether a service instance can be attached to the fusion pod

Syntax

FUNCTION verify_service_attachment (
  verify_service_attachment_details dbms_cloud_oci_fusion_apps_verify_service_attachment_details_t,
  fusion_environment_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_fa_fusion_applications_verify_service_attachment_response_t;

Parameters

Parameter Description

verify_service_attachment_details

(required) Details for the service attachment.

fusion_environment_id

(required) unique FusionEnvironment identifier

opc_request_id

(optional) The client request ID for tracing.

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://fusionapps.{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.