Data Integration Functions

Package: DBMS_CLOUD_OCI_DI_DATA_INTEGRATION

CHANGE_COMPARTMENT Function

Moves a workspace to a specified compartment.

Syntax

FUNCTION change_compartment (
  workspace_id varchar2,
  change_compartment_details dbms_cloud_oci_dataintegration_change_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_di_data_integration_change_compartment_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`change_compartment_details`	(required) The information needed to move a workspace to a specified compartment.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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.
`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.
`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://dataintegration.{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_DIS_APPLICATION_COMPARTMENT Function

Moves a DIS Application to a specified compartment.

Syntax

FUNCTION change_dis_application_compartment (
  workspace_id varchar2,
  dis_application_id varchar2,
  change_dis_application_compartment_details dbms_cloud_oci_dataintegration_change_dis_application_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_di_data_integration_change_dis_application_compartment_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`dis_application_id`	(required) The OCID of the DIS Application.
`change_dis_application_compartment_details`	(required) The information needed to move a DIS Application to a specified compartment.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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.
`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.
`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://dataintegration.{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_APPLICATION Function

Creates an application.

Syntax

FUNCTION create_application (
  workspace_id varchar2,
  create_application_details dbms_cloud_oci_dataintegration_create_application_details_t,
  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_di_data_integration_create_application_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_application_details`	(required) The details needed to create an 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.
`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.
`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://dataintegration.{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_APPLICATION_DETAILED_DESCRIPTION Function

Creates detailed description for an application.

Syntax

FUNCTION create_application_detailed_description (
  workspace_id varchar2,
  application_key varchar2,
  create_application_detailed_description_details dbms_cloud_oci_dataintegration_create_detailed_description_details_t,
  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_di_data_integration_create_application_detailed_description_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`create_application_detailed_description_details`	(required) Detailed description of an 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.
`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.
`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://dataintegration.{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_CONNECTION Function

Creates a connection under an existing data asset.

Syntax

FUNCTION create_connection (
  workspace_id varchar2,
  create_connection_details dbms_cloud_oci_dataintegration_create_connection_details_t,
  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_di_data_integration_create_connection_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_connection_details`	(required) The information needed to create a connection.
`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.
`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.
`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://dataintegration.{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_CONNECTION_VALIDATION Function

Creates a connection validation.

Syntax

FUNCTION create_connection_validation (
  workspace_id varchar2,
  create_connection_validation_details dbms_cloud_oci_dataintegration_create_connection_validation_details_t,
  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_di_data_integration_create_connection_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_connection_validation_details`	(required) The information needed to validate a connection.
`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.
`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.
`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://dataintegration.{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_COPY_OBJECT_REQUEST Function

Copy Metadata Object.

Syntax

FUNCTION create_copy_object_request (
  workspace_id varchar2,
  create_copy_object_request_details dbms_cloud_oci_dataintegration_create_copy_object_request_details_t,
  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_di_data_integration_create_copy_object_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_copy_object_request_details`	(required) The details needed to copy metadata object.
`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.
`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.
`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://dataintegration.{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_ASSET Function

Creates a data asset with default connection.

Syntax

FUNCTION create_data_asset (
  workspace_id varchar2,
  create_data_asset_details dbms_cloud_oci_dataintegration_create_data_asset_details_t,
  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_di_data_integration_create_data_asset_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_data_asset_details`	(required) The information needed to create a data asset.
`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.
`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.
`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://dataintegration.{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_FLOW Function

Creates a new data flow in a project or folder ready for performing data integrations.

Syntax

FUNCTION create_data_flow (
  workspace_id varchar2,
  create_data_flow_details dbms_cloud_oci_dataintegration_create_data_flow_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_di_data_integration_create_data_flow_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_data_flow_details`	(required) The details needed to create a new data flow.
`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.
`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://dataintegration.{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_FLOW_VALIDATION Function

Accepts the data flow definition in the request payload and creates a data flow validation.

Syntax

FUNCTION create_data_flow_validation (
  workspace_id varchar2,
  create_data_flow_validation_details dbms_cloud_oci_dataintegration_create_data_flow_validation_details_t,
  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_di_data_integration_create_data_flow_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_data_flow_validation_details`	(required) The information needed to create the data flow validation for the data flow object.
`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.
`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.
`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://dataintegration.{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_DIS_APPLICATION Function

Creates a DIS Application.

Syntax

FUNCTION create_dis_application (
  workspace_id varchar2,
  create_dis_application_details dbms_cloud_oci_dataintegration_create_dis_application_details_t,
  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_di_data_integration_create_dis_application_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_dis_application_details`	(required) The details needed to create a DIS 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.
`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.
`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://dataintegration.{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_DIS_APPLICATION_DETAILED_DESCRIPTION Function

Creates detailed description for an application.

Syntax

FUNCTION create_dis_application_detailed_description (
  workspace_id varchar2,
  application_key varchar2,
  create_dis_application_detailed_description_details dbms_cloud_oci_dataintegration_create_detailed_description_details_t,
  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_di_data_integration_create_dis_application_detailed_description_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`create_dis_application_detailed_description_details`	(required) Detailed description of an 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.
`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.
`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://dataintegration.{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_ENTITY_SHAPE Function

Creates the data entity shape using the shape from the data asset.

Syntax

FUNCTION create_entity_shape (
  workspace_id varchar2,
  connection_key varchar2,
  schema_resource_name varchar2,
  create_entity_shape_details dbms_cloud_oci_dataintegration_create_entity_shape_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token 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_di_data_integration_create_entity_shape_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_key`	(required) The connection key.
`schema_resource_name`	(required) The schema resource name used for retrieving schemas.
`create_entity_shape_details`	(required) The details needed to create the data entity shape.
`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.
`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.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_EXPORT_REQUEST Function

Export Metadata Object

Syntax

FUNCTION create_export_request (
  workspace_id varchar2,
  create_export_request_details dbms_cloud_oci_dataintegration_create_export_request_details_t,
  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_di_data_integration_create_export_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_export_request_details`	(required) The details needed to export metadata object.
`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.
`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.
`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://dataintegration.{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_EXTERNAL_PUBLICATION Function

Publish a DataFlow in a OCI DataFlow application.

Syntax

FUNCTION create_external_publication (
  workspace_id varchar2,
  task_key varchar2,
  create_external_publication_details dbms_cloud_oci_dataintegration_create_external_publication_details_t,
  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_di_data_integration_create_external_publication_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`create_external_publication_details`	(required) Details needed to publish a task to OCI DataFlow 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.
`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.
`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://dataintegration.{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_EXTERNAL_PUBLICATION_VALIDATION Function

Validates a specific task.

Syntax

FUNCTION create_external_publication_validation (
  workspace_id varchar2,
  task_key varchar2,
  create_external_publication_validation_details dbms_cloud_oci_dataintegration_create_external_publication_validation_details_t,
  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_di_data_integration_create_external_publication_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`create_external_publication_validation_details`	(required) The information needed to create a task validation.
`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.
`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.
`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://dataintegration.{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_FOLDER Function

Creates a folder in a project or in another folder, limited to two levels of folders. | Folders are used to organize your design-time resources, such as tasks or data flows.

Syntax

FUNCTION create_folder (
  workspace_id varchar2,
  create_folder_details dbms_cloud_oci_dataintegration_create_folder_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_di_data_integration_create_folder_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_folder_details`	(required) The details needed to create a folder.
`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.
`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://dataintegration.{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_FUNCTION_LIBRARY Function

Creates a function library in a project or in another function library, limited to two levels of function libraries. | FunctionLibraries are used to organize your design-time resources, such as tasks or data flows.

Syntax

FUNCTION create_function_library (
  workspace_id varchar2,
  create_function_library_details dbms_cloud_oci_dataintegration_create_function_library_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_di_data_integration_create_function_library_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_function_library_details`	(required) The details needed to create a function Library.
`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.
`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://dataintegration.{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_IMPORT_REQUEST Function

Import Metadata Object

Syntax

FUNCTION create_import_request (
  workspace_id varchar2,
  create_import_request_details dbms_cloud_oci_dataintegration_create_import_request_details_t,
  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_di_data_integration_create_import_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_import_request_details`	(required) The details needed to import metadata object.
`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.
`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.
`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://dataintegration.{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_PATCH Function

Creates a patch in an application.

Syntax

FUNCTION create_patch (
  workspace_id varchar2,
  application_key varchar2,
  create_patch_details dbms_cloud_oci_dataintegration_create_patch_details_t,
  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_di_data_integration_create_patch_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`create_patch_details`	(required) Detailed needed to create a patch in an 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.
`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.
`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://dataintegration.{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_PIPELINE Function

Creates a new pipeline in a project or folder ready for performing task orchestration.

Syntax

FUNCTION create_pipeline (
  workspace_id varchar2,
  create_pipeline_details dbms_cloud_oci_dataintegration_create_pipeline_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_di_data_integration_create_pipeline_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_pipeline_details`	(required) The details needed to create a new pipeline.
`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.
`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://dataintegration.{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_PIPELINE_VALIDATION Function

Accepts the data flow definition in the request payload and creates a pipeline validation.

Syntax

FUNCTION create_pipeline_validation (
  workspace_id varchar2,
  create_pipeline_validation_details dbms_cloud_oci_dataintegration_create_pipeline_validation_details_t,
  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_di_data_integration_create_pipeline_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_pipeline_validation_details`	(required) The information needed to create the data flow validation for the pipeline object.
`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.
`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.
`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://dataintegration.{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_PROJECT Function

Creates a project. Projects are organizational constructs within a workspace that you use to organize your design-time resources, such as tasks or data flows. Projects can be organized into folders.

Syntax

FUNCTION create_project (
  workspace_id varchar2,
  create_project_details dbms_cloud_oci_dataintegration_create_project_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_di_data_integration_create_project_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_project_details`	(required) The details needed to create a project in a workspace.
`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.
`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://dataintegration.{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_SCHEDULE Function

Endpoint to create a new schedule

Syntax

FUNCTION create_schedule (
  workspace_id varchar2,
  application_key varchar2,
  create_schedule_details dbms_cloud_oci_dataintegration_create_schedule_details_t,
  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_di_data_integration_create_schedule_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`create_schedule_details`	(required) Request body parameter for Schedule details
`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.
`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.
`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://dataintegration.{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_TASK Function

Creates a new task ready for performing data integrations. There are specialized types of tasks that include data loader and integration tasks.

Syntax

FUNCTION create_task (
  workspace_id varchar2,
  create_task_details dbms_cloud_oci_dataintegration_create_task_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_di_data_integration_create_task_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_task_details`	(required) The details needed to create a new task.
`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.
`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://dataintegration.{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_TASK_RUN Function

Creates a data integration task run for the specified task.

Syntax

FUNCTION create_task_run (
  workspace_id varchar2,
  application_key varchar2,
  create_task_run_details dbms_cloud_oci_dataintegration_create_task_run_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_di_data_integration_create_task_run_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`create_task_run_details`	(required) The details needed to create a task run.
`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.
`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://dataintegration.{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_TASK_SCHEDULE Function

Endpoint to be used create TaskSchedule.

Syntax

FUNCTION create_task_schedule (
  workspace_id varchar2,
  application_key varchar2,
  create_task_schedule_details dbms_cloud_oci_dataintegration_create_task_schedule_details_t,
  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_di_data_integration_create_task_schedule_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`create_task_schedule_details`	(required) Request body parameter for TaskSchedule details
`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.
`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.
`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://dataintegration.{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_TASK_VALIDATION Function

Validates a specific task.

Syntax

FUNCTION create_task_validation (
  workspace_id varchar2,
  create_task_validation_details dbms_cloud_oci_dataintegration_create_task_validation_details_t,
  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_di_data_integration_create_task_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_task_validation_details`	(required) The information needed to create a task validation.
`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.
`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.
`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://dataintegration.{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_USER_DEFINED_FUNCTION Function

Creates a new UserDefinedFunction in a function library ready for performing data integrations.

Syntax

FUNCTION create_user_defined_function (
  workspace_id varchar2,
  create_user_defined_function_details dbms_cloud_oci_dataintegration_create_user_defined_function_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_di_data_integration_create_user_defined_function_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_user_defined_function_details`	(required) The details needed to create a new UserDefinedFunction.
`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.
`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://dataintegration.{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_USER_DEFINED_FUNCTION_VALIDATION Function

Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.

Syntax

FUNCTION create_user_defined_function_validation (
  workspace_id varchar2,
  create_user_defined_function_validation_details dbms_cloud_oci_dataintegration_create_user_defined_function_validation_details_t,
  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_di_data_integration_create_user_defined_function_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`create_user_defined_function_validation_details`	(required) The information needed to create the UserDefinedFunction validation for the UserDefinedFunction object.
`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.
`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.
`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://dataintegration.{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_WORKSPACE Function

Creates a new Data Integration workspace ready for performing data integration tasks. To retrieve the OCID for the new workspace, use the opc-work-request-id returned by this API and call the GET_WORK_REQUEST Function API.

Syntax

FUNCTION create_workspace (
  create_workspace_details dbms_cloud_oci_dataintegration_create_workspace_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_di_data_integration_create_workspace_response_t;

Parameters

Parameter	Description
`create_workspace_details`	(required) The information needed to create a new Data Integration workspace.
`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.
`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://dataintegration.{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_APPLICATION Function

Removes an application using the specified identifier.

Syntax

FUNCTION delete_application (
  workspace_id varchar2,
  application_key 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_di_data_integration_delete_application_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_APPLICATION_DETAILED_DESCRIPTION Function

Deletes detailed description of an Application.

Syntax

FUNCTION delete_application_detailed_description (
  workspace_id varchar2,
  application_key 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_di_data_integration_delete_application_detailed_description_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_CONNECTION Function

Removes a connection using the specified identifier.

Syntax

FUNCTION delete_connection (
  workspace_id varchar2,
  connection_key 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_di_data_integration_delete_connection_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_key`	(required) The connection key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_CONNECTION_VALIDATION Function

Deletes a connection validation.

Syntax

FUNCTION delete_connection_validation (
  workspace_id varchar2,
  connection_validation_key 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_di_data_integration_delete_connection_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_validation_key`	(required) The key of the connection validation.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_COPY_OBJECT_REQUEST Function

Delete copy object request using the specified identifier.

Syntax

FUNCTION delete_copy_object_request (
  workspace_id varchar2,
  copy_object_request_key varchar2,
  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_di_data_integration_delete_copy_object_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`copy_object_request_key`	(required) The key of the object to be copied, for example this could be the key of a project.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DATA_ASSET Function

Removes a data asset using the specified identifier.

Syntax

FUNCTION delete_data_asset (
  workspace_id varchar2,
  data_asset_key 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_di_data_integration_delete_data_asset_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_asset_key`	(required) The data asset key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DATA_FLOW Function

Removes a data flow from a project or folder using the specified identifier.

Syntax

FUNCTION delete_data_flow (
  workspace_id varchar2,
  data_flow_key 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_di_data_integration_delete_data_flow_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_flow_key`	(required) The data flow key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DATA_FLOW_VALIDATION Function

Removes a data flow validation using the specified identifier.

Syntax

FUNCTION delete_data_flow_validation (
  workspace_id varchar2,
  data_flow_validation_key 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_di_data_integration_delete_data_flow_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_flow_validation_key`	(required) The key of the dataflow validation.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DIS_APPLICATION Function

Removes a DIS application using the specified identifier.

Syntax

FUNCTION delete_dis_application (
  workspace_id varchar2,
  dis_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_di_data_integration_delete_dis_application_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`dis_application_id`	(required) The OCID of the DIS 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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DIS_APPLICATION_DETAILED_DESCRIPTION Function

Deletes detailed description of an Application.

Syntax

FUNCTION delete_dis_application_detailed_description (
  workspace_id varchar2,
  application_key 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_di_data_integration_delete_dis_application_detailed_description_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_EXPORT_REQUEST Function

Delete export object request using the specified identifier.

Syntax

FUNCTION delete_export_request (
  workspace_id varchar2,
  export_request_key varchar2,
  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_di_data_integration_delete_export_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`export_request_key`	(required) The key of the object export object 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.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_EXTERNAL_PUBLICATION Function

Removes a published object using the specified identifier.

Syntax

FUNCTION delete_external_publication (
  workspace_id varchar2,
  task_key varchar2,
  external_publications_key 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_di_data_integration_delete_external_publication_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`external_publications_key`	(required) The external published object key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_EXTERNAL_PUBLICATION_VALIDATION Function

Removes a task validation using the specified identifier.

Syntax

FUNCTION delete_external_publication_validation (
  workspace_id varchar2,
  task_key varchar2,
  external_publication_validation_key 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_di_data_integration_delete_external_publication_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`external_publication_validation_key`	(required) The external published object key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_FOLDER Function

Removes a folder from a project using the specified identifier.

Syntax

FUNCTION delete_folder (
  workspace_id varchar2,
  folder_key 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_di_data_integration_delete_folder_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`folder_key`	(required) The folder key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_FUNCTION_LIBRARY Function

Removes a Function Library from a project using the specified identifier.

Syntax

FUNCTION delete_function_library (
  workspace_id varchar2,
  function_library_key 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_di_data_integration_delete_function_library_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`function_library_key`	(required) The functionLibrary key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_IMPORT_REQUEST Function

Delete import object request using the specified identifier.

Syntax

FUNCTION delete_import_request (
  import_request_key varchar2,
  workspace_id varchar2,
  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_di_data_integration_delete_import_request_response_t;

Parameters

Parameter	Description
`import_request_key`	(required) The key of the object export object request
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_PATCH Function

Removes a patch using the specified identifier.

Syntax

FUNCTION delete_patch (
  workspace_id varchar2,
  application_key varchar2,
  patch_key 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_di_data_integration_delete_patch_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`patch_key`	(required) The patch key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_PIPELINE Function

Removes a pipeline from a project or folder using the specified identifier.

Syntax

FUNCTION delete_pipeline (
  workspace_id varchar2,
  pipeline_key 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_di_data_integration_delete_pipeline_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`pipeline_key`	(required) The pipeline key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_PIPELINE_VALIDATION Function

Removes a pipeline validation using the specified identifier.

Syntax

FUNCTION delete_pipeline_validation (
  workspace_id varchar2,
  pipeline_validation_key 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_di_data_integration_delete_pipeline_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`pipeline_validation_key`	(required) The key of the pipeline validation.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_PROJECT Function

Removes a project from the workspace using the specified identifier.

Syntax

FUNCTION delete_project (
  workspace_id varchar2,
  project_key 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_di_data_integration_delete_project_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`project_key`	(required) The project key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_SCHEDULE Function

Endpoint to delete schedule.

Syntax

FUNCTION delete_schedule (
  workspace_id varchar2,
  application_key varchar2,
  schedule_key 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_di_data_integration_delete_schedule_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`schedule_key`	(required) Schedule Key
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_TASK Function

Removes a task using the specified identifier.

Syntax

FUNCTION delete_task (
  workspace_id varchar2,
  task_key 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_di_data_integration_delete_task_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_TASK_RUN Function

Deletes a task run using the specified identifier.

Syntax

FUNCTION delete_task_run (
  workspace_id varchar2,
  application_key varchar2,
  task_run_key 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_di_data_integration_delete_task_run_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`task_run_key`	(required) The task run key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_TASK_SCHEDULE Function

Endpoint to delete TaskSchedule.

Syntax

FUNCTION delete_task_schedule (
  workspace_id varchar2,
  application_key varchar2,
  task_schedule_key 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_di_data_integration_delete_task_schedule_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`task_schedule_key`	(required) TaskSchedule Key
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_TASK_VALIDATION Function

Removes a task validation using the specified identifier.

Syntax

FUNCTION delete_task_validation (
  workspace_id varchar2,
  task_validation_key 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_di_data_integration_delete_task_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_validation_key`	(required) The task validation key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_USER_DEFINED_FUNCTION Function

Removes a UserDefinedFunction from a function library using the specified identifier.

Syntax

FUNCTION delete_user_defined_function (
  workspace_id varchar2,
  user_defined_function_key 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_di_data_integration_delete_user_defined_function_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`user_defined_function_key`	(required) The user defined function key.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_USER_DEFINED_FUNCTION_VALIDATION Function

Removes a UserDefinedFunction validation using the specified identifier.

Syntax

FUNCTION delete_user_defined_function_validation (
  workspace_id varchar2,
  user_defined_function_validation_key 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_di_data_integration_delete_user_defined_function_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`user_defined_function_validation_key`	(required) The key of the userDefinedFunction validation.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_WORKSPACE Function

Deletes a Data Integration workspace resource using the specified identifier.

Syntax

FUNCTION delete_workspace (
  workspace_id varchar2,
  quiesce_timeout number DEFAULT NULL,
  is_force_operation number DEFAULT NULL,
  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_di_data_integration_delete_workspace_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`quiesce_timeout`	(optional) Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace.
`is_force_operation`	(optional) Used to force close down the workspace.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_APPLICATION Function

Retrieves an application using the specified identifier.

Syntax

FUNCTION get_application (
  workspace_id varchar2,
  application_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_application_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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://dataintegration.{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_APPLICATION_DETAILED_DESCRIPTION Function

Retrieves detailed description of an Application

Syntax

FUNCTION get_application_detailed_description (
  workspace_id varchar2,
  application_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_application_detailed_description_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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://dataintegration.{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_COMPOSITE_STATE Function

This endpoint can be used to get composite state for a given aggregator

Syntax

FUNCTION get_composite_state (
  workspace_id varchar2,
  application_key varchar2,
  aggregator_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_composite_state_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`aggregator_key`	(required) Unique key of the aggregator for which we want to get the Composite State
`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://dataintegration.{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_CONNECTION Function

Retrieves the connection details using the specified identifier.

Syntax

FUNCTION get_connection (
  workspace_id varchar2,
  connection_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_connection_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_key`	(required) The connection key.
`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://dataintegration.{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_CONNECTION_VALIDATION Function

Retrieves a connection validation using the specified identifier.

Syntax

FUNCTION get_connection_validation (
  workspace_id varchar2,
  connection_validation_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_connection_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_validation_key`	(required) The key of the connection validation.
`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://dataintegration.{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_COPY_OBJECT_REQUEST Function

This endpoint can be used to get the summary/details of object being copied.

Syntax

FUNCTION get_copy_object_request (
  workspace_id varchar2,
  copy_object_request_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_copy_object_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`copy_object_request_key`	(required) The key of the object to be copied, for example this could be the key of a project.
`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://dataintegration.{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_COUNT_STATISTIC Function

Retrieves statistics on a workspace. It returns an object with an array of property values, such as the number of projects, | applications, data assets, and so on.

Syntax

FUNCTION get_count_statistic (
  workspace_id varchar2,
  count_statistic_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_count_statistic_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`count_statistic_key`	(required) A unique key of the container object, such as workspace, project, and so on, to count statistics for. The statistics is fetched for the given key.
`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://dataintegration.{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_ASSET Function

Retrieves details of a data asset using the specified identifier.

Syntax

FUNCTION get_data_asset (
  workspace_id varchar2,
  data_asset_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_data_asset_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_asset_key`	(required) The data asset key.
`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://dataintegration.{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_ENTITY Function

Retrieves the data entity details with the given name from live schema.

Syntax

FUNCTION get_data_entity (
  workspace_id varchar2,
  connection_key varchar2,
  schema_resource_name varchar2,
  data_entity_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_data_entity_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_key`	(required) The connection key.
`schema_resource_name`	(required) The schema resource name used for retrieving schemas.
`data_entity_key`	(required) The key of the data entity.
`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://dataintegration.{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_FLOW Function

Retrieves a data flow using the specified identifier.

Syntax

FUNCTION get_data_flow (
  workspace_id varchar2,
  data_flow_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  expand_references varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_data_flow_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_flow_key`	(required) The data flow key.
`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.
`expand_references`	(optional) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</B><br> <ul> <li><B>?expandReferences=true</B> returns all objects of type data loader task</li> </ul>
`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://dataintegration.{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_FLOW_VALIDATION Function

Retrieves a data flow validation using the specified identifier.

Syntax

FUNCTION get_data_flow_validation (
  workspace_id varchar2,
  data_flow_validation_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_data_flow_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_flow_validation_key`	(required) The key of the dataflow validation.
`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://dataintegration.{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_DEPENDENT_OBJECT Function

Retrieves the details of a dependent object from an application.

Syntax

FUNCTION get_dependent_object (
  workspace_id varchar2,
  application_key varchar2,
  dependent_object_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_dependent_object_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`dependent_object_key`	(required) The dependent object key.
`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://dataintegration.{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_DIS_APPLICATION Function

Retrieves an application using the specified OCID.

Syntax

FUNCTION get_dis_application (
  workspace_id varchar2,
  dis_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_di_data_integration_get_dis_application_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`dis_application_id`	(required) The OCID of the DIS 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://dataintegration.{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_DIS_APPLICATION_DETAILED_DESCRIPTION Function

Retrieves detailed description of an Application.

Syntax

FUNCTION get_dis_application_detailed_description (
  workspace_id varchar2,
  application_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_dis_application_detailed_description_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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://dataintegration.{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_EXPORT_REQUEST Function

This endpoint can be used to get the summary/details of object being exported.

Syntax

FUNCTION get_export_request (
  workspace_id varchar2,
  export_request_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_export_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`export_request_key`	(required) The key of the object export object 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://dataintegration.{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_EXTERNAL_PUBLICATION Function

Retrieves a publshed object in an task using the specified identifier.

Syntax

FUNCTION get_external_publication (
  workspace_id varchar2,
  task_key varchar2,
  external_publications_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_external_publication_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`external_publications_key`	(required) The external published object key.
`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://dataintegration.{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_EXTERNAL_PUBLICATION_VALIDATION Function

Retrieves an external publication validation using the specified identifier.

Syntax

FUNCTION get_external_publication_validation (
  workspace_id varchar2,
  task_key varchar2,
  external_publication_validation_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_external_publication_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`external_publication_validation_key`	(required) The external published object key.
`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://dataintegration.{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_FOLDER Function

Retrieves a folder using the specified identifier.

Syntax

FUNCTION get_folder (
  workspace_id varchar2,
  folder_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  projection dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_folder_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`folder_key`	(required) The folder key.
`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.
`projection`	(optional) This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. Allowed values are: 'CHILD_COUNT_STATISTICS'
`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://dataintegration.{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_FUNCTION_LIBRARY Function

Retrieves a Function Library using the specified identifier.

Syntax

FUNCTION get_function_library (
  workspace_id varchar2,
  function_library_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  projection dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_function_library_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`function_library_key`	(required) The functionLibrary key.
`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.
`projection`	(optional) This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. Allowed values are: 'CHILD_COUNT_STATISTICS'
`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://dataintegration.{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_IMPORT_REQUEST Function

This endpoint can be used to get the summary/details of object being imported.

Syntax

FUNCTION get_import_request (
  workspace_id varchar2,
  import_request_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_import_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`import_request_key`	(required) The key of the object export object 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.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`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://dataintegration.{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_PATCH Function

Retrieves a patch in an application using the specified identifier.

Syntax

FUNCTION get_patch (
  workspace_id varchar2,
  application_key varchar2,
  patch_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_patch_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`patch_key`	(required) The patch key.
`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://dataintegration.{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_PIPELINE Function

Retrieves a pipeline using the specified identifier.

Syntax

FUNCTION get_pipeline (
  workspace_id varchar2,
  pipeline_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  expand_references varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_pipeline_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`pipeline_key`	(required) The pipeline key.
`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.
`expand_references`	(optional) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</B><br> <ul> <li><B>?expandReferences=true</B> returns all objects of type data loader task</li> </ul>
`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://dataintegration.{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_PIPELINE_VALIDATION Function

Retrieves a pipeline validation using the specified identifier.

Syntax

FUNCTION get_pipeline_validation (
  workspace_id varchar2,
  pipeline_validation_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_pipeline_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`pipeline_validation_key`	(required) The key of the pipeline validation.
`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://dataintegration.{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_PROJECT Function

Retrieves a project using the specified identifier.

Syntax

FUNCTION get_project (
  workspace_id varchar2,
  project_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  projection dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_project_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`project_key`	(required) The project key.
`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.
`projection`	(optional) This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. Allowed values are: 'CHILD_COUNT_STATISTICS'
`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://dataintegration.{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_PUBLISHED_OBJECT Function

Retrieves the details of a published object from an application.

Syntax

FUNCTION get_published_object (
  workspace_id varchar2,
  application_key varchar2,
  published_object_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  expand_references varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_published_object_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`published_object_key`	(required) The published object key.
`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.
`expand_references`	(optional) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</B><br> <ul> <li><B>?expandReferences=true</B> returns all objects of type data loader task</li> </ul>
`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://dataintegration.{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_REFERENCE Function

Retrieves a reference in an application.

Syntax

FUNCTION get_reference (
  workspace_id varchar2,
  application_key varchar2,
  reference_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_reference_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`reference_key`	(required) The reference key.
`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://dataintegration.{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_RUNTIME_OPERATOR Function

Retrieves a runtime operator using the specified identifier.

Syntax

FUNCTION get_runtime_operator (
  workspace_id varchar2,
  application_key varchar2,
  runtime_pipeline_key varchar2,
  runtime_operator_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_runtime_operator_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`runtime_pipeline_key`	(required) Runtime Pipeline Key
`runtime_operator_key`	(required) Runtime Operator Key
`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://dataintegration.{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_RUNTIME_PIPELINE Function

Retrieves a runtime pipeline using the specified identifier.

Syntax

FUNCTION get_runtime_pipeline (
  workspace_id varchar2,
  application_key varchar2,
  runtime_pipeline_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  expand_references varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_runtime_pipeline_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`runtime_pipeline_key`	(required) Runtime Pipeline Key
`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.
`expand_references`	(optional) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</B><br> <ul> <li><B>?expandReferences=true</B> returns all objects of type data loader task</li> </ul>
`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://dataintegration.{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_SCHEDULE Function

Retrieves schedule by schedule key

Syntax

FUNCTION get_schedule (
  workspace_id varchar2,
  application_key varchar2,
  schedule_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_schedule_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`schedule_key`	(required) Schedule Key
`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://dataintegration.{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_SCHEMA Function

Retrieves a schema that can be accessed using the specified connection.

Syntax

FUNCTION get_schema (
  workspace_id varchar2,
  connection_key varchar2,
  schema_resource_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_schema_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_key`	(required) The connection key.
`schema_resource_name`	(required) The schema resource name used for retrieving schemas.
`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://dataintegration.{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_TASK Function

Retrieves a task using the specified identifier.

Syntax

FUNCTION get_task (
  workspace_id varchar2,
  task_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  expand_references varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_task_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`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.
`expand_references`	(optional) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</B><br> <ul> <li><B>?expandReferences=true</B> returns all objects of type data loader task</li> </ul>
`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://dataintegration.{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_TASK_RUN Function

Retrieves a task run using the specified identifier.

Syntax

FUNCTION get_task_run (
  workspace_id varchar2,
  application_key varchar2,
  task_run_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_task_run_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`task_run_key`	(required) The task run key.
`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://dataintegration.{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_TASK_SCHEDULE Function

Endpoint used to get taskSchedule by its key

Syntax

FUNCTION get_task_schedule (
  workspace_id varchar2,
  application_key varchar2,
  task_schedule_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_task_schedule_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`task_schedule_key`	(required) TaskSchedule Key
`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://dataintegration.{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_TASK_VALIDATION Function

Retrieves a task validation using the specified identifier.

Syntax

FUNCTION get_task_validation (
  workspace_id varchar2,
  task_validation_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_task_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_validation_key`	(required) The task validation key.
`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://dataintegration.{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_TEMPLATE Function

This endpoint can be used to get an application template using a key.

Syntax

FUNCTION get_template (
  workspace_id varchar2,
  template_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_di_data_integration_get_template_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`template_id`	(required) The OCID of the template.
`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://dataintegration.{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_USER_DEFINED_FUNCTION Function

Retrieves a UserDefinedFunction using the specified identifier.

Syntax

FUNCTION get_user_defined_function (
  workspace_id varchar2,
  user_defined_function_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_user_defined_function_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`user_defined_function_key`	(required) The user defined function key.
`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://dataintegration.{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_USER_DEFINED_FUNCTION_VALIDATION Function

Retrieves a UserDefinedFunction validation using the specified identifier.

Syntax

FUNCTION get_user_defined_function_validation (
  workspace_id varchar2,
  user_defined_function_validation_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_get_user_defined_function_validation_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`user_defined_function_validation_key`	(required) The key of the userDefinedFunction validation.
`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://dataintegration.{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

Retrieves 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_di_data_integration_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous work request to retrieve.
`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://dataintegration.{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_WORKSPACE Function

Retrieves a Data Integration workspace using the specified identifier.

Syntax

FUNCTION get_workspace (
  workspace_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_di_data_integration_get_workspace_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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://dataintegration.{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

Retrieves a list of applications and provides options to filter the list.

Syntax

FUNCTION list_applications (
  workspace_id varchar2,
  name varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_applications_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`name`	(optional) Used to filter by the name of the object.
`name_contains`	(optional) This parameter can be used to filter objects by the names that match partially or fully with the given value.
`identifier`	(optional) Used to filter by the identifier of the published object.
`fields`	(optional) Specifies the fields to get for an object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_CONNECTION_VALIDATIONS Function

Retrieves a list of connection validations within the specified workspace.

Syntax

FUNCTION list_connection_validations (
  workspace_id varchar2,
  key varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_di_data_integration_list_connection_validations_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`key`	(optional) Used to filter by the key of the object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`fields`	(optional) Specifies the fields to get for an object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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://dataintegration.{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_CONNECTIONS Function

Retrieves a list of all connections.

Syntax

FUNCTION list_connections (
  workspace_id varchar2,
  data_asset_key varchar2,
  name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_di_data_integration_list_connections_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_asset_key`	(required) Used to filter by the data asset key of the object.
`name`	(optional) Used to filter by the name of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`fields`	(optional) Specifies the fields to get for an object.
`l_type`	(optional) Type of the object to filter the results with.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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://dataintegration.{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_COPY_OBJECT_REQUESTS Function

This endpoint can be used to get the list of copy object requests.

Syntax

FUNCTION list_copy_object_requests (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  copy_status varchar2 DEFAULT NULL,
  projection varchar2 DEFAULT NULL,
  time_started_in_millis number DEFAULT NULL,
  time_ended_in_millis number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_copy_object_requests_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`name`	(optional) Used to filter by the name of the object.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`copy_status`	(optional) Specifies copy status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . Allowed values are: 'IN_PROGRESS', 'SUCCESSFUL', 'QUEUED', 'TERMINATING', 'TERMINATED', 'FAILED', 'ALL'
`projection`	(optional) This parameter allows users to specify which view of the copy object response to return. SUMMARY - Summary of the copy object response will be returned. This is the default option when no value is specified. DETAILS - Details of copy object response will be returned. This will include details of all the objects to be copied. Allowed values are: 'SUMMARY', 'DETAILS'
`time_started_in_millis`	(optional) Specifies start time of a copy object request.
`time_ended_in_millis`	(optional) Specifies end time of a copy object request.
`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://dataintegration.{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_ASSETS Function

Retrieves a list of all data asset summaries.

Syntax

FUNCTION list_data_assets (
  workspace_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  name 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_di_data_integration_list_data_assets_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`fields`	(optional) Specifies the fields to get for an object.
`l_type`	(optional) Type of the object to filter the results with.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`name`	(optional) Used to filter by the name of the object.
`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://dataintegration.{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_ENTITIES Function

Lists a summary of data entities from the data asset using the specified connection.

Syntax

FUNCTION list_data_entities (
  workspace_id varchar2,
  connection_key varchar2,
  schema_resource_name varchar2,
  name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  name_list dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  is_pattern number DEFAULT NULL,
  include_types dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_data_entities_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_key`	(required) The connection key.
`schema_resource_name`	(required) The schema resource name used for retrieving schemas.
`name`	(optional) Used to filter by the name of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`l_type`	(optional) Type of the object to filter the results with.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`fields`	(optional) Specifies the fields to get for an object.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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.
`name_list`	(optional) Used to filter by the name of the object.
`is_pattern`	(optional) This parameter can be used to specify whether entity search type is pattern search or not.
`include_types`	(optional) Artifact type which needs to be listed while listing Artifacts.
`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://dataintegration.{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_FLOW_VALIDATIONS Function

Retrieves a list of data flow validations within the specified workspace.

Syntax

FUNCTION list_data_flow_validations (
  workspace_id varchar2,
  key varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_di_data_integration_list_data_flow_validations_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`key`	(optional) Used to filter by the key of the object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`fields`	(optional) Specifies the fields to get for an object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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://dataintegration.{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_FLOWS Function

Retrieves a list of data flows in a project or folder.

Syntax

FUNCTION list_data_flows (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  folder_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_data_flows_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`folder_id`	(optional) Unique key of the folder.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_DEPENDENT_OBJECTS Function

Retrieves a list of all dependent objects for a specific application.

Syntax

FUNCTION list_dependent_objects (
  workspace_id varchar2,
  application_key varchar2,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  l_type dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  type_in_subtree 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_di_data_integration_list_dependent_objects_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`name_contains`	(optional) This parameter can be used to filter objects by the names that match partially or fully with the given value.
`identifier`	(optional) Used to filter by the identifier of the published object.
`l_type`	(optional) Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. For Data Integration APIs, a filter based on type Task is used.
`type_in_subtree`	(optional) Used in association with type parameter. If value is true, then type all sub types of the given type parameter is considered. If value is false, then sub types are not considered. Default is false.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_DIS_APPLICATION_TASK_RUN_LINEAGES Function

This endpoint can be used to list Task Run Lineages within a given time window.

Syntax

FUNCTION list_dis_application_task_run_lineages (
  workspace_id varchar2,
  dis_application_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  filter dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  time_updated_greater_than timestamp with time zone DEFAULT NULL,
  time_updated_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_upated_less_than timestamp with time zone DEFAULT NULL,
  time_upated_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_dis_application_task_run_lineages_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`dis_application_id`	(required) The OCID of the DIS 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.
`fields`	(optional) Specifies the fields to get for an object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`filter`	(optional) This filter parameter can be used to filter by model specific queryable fields of the object <br><br><B>Examples:-</B><br> <ul> <li><B>?filter=status eq Failed</B> returns all objects that have a status field with value Failed</li> </ul>
`time_updated_greater_than`	(optional) This parameter allows users to get objects which were updated after a certain time. The format of timeUpdatedGreaterThan is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\"
`time_updated_greater_than_or_equal_to`	(optional) This parameter allows users to get objects which were updated after and at a certain time. The format of timeUpdatedGreaterThanOrEqualTo is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\"
`time_upated_less_than`	(optional) This parameter allows users to get objects which were updated before a certain time. The format of timeUpatedLessThan is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\"
`time_upated_less_than_or_equal_to`	(optional) This parameter allows users to get objects which were updated before and at a certain time. The format of timeUpatedLessThanOrEqualTo is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\"
`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://dataintegration.{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_DIS_APPLICATIONS Function

Retrieves a list of DIS Applications in a compartment and provides options to filter the list.

Syntax

FUNCTION list_dis_applications (
  workspace_id varchar2,
  compartment_id varchar2,
  name varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_dis_applications_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`compartment_id`	(required) OCID of the compartment for which the list of DIS Applications is to be retrieved.
`name`	(optional) Used to filter by the name of the object.
`name_contains`	(optional) This parameter can be used to filter objects by the names that match partially or fully with the given value.
`identifier`	(optional) Used to filter by the identifier of the published object.
`fields`	(optional) Specifies the fields to get for an object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_EXPORT_REQUESTS Function

This endpoint can be used to get the list of export object requests.

Syntax

FUNCTION list_export_requests (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  export_status varchar2 DEFAULT NULL,
  projection varchar2 DEFAULT NULL,
  time_started_in_millis number DEFAULT NULL,
  time_ended_in_millis number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_export_requests_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`name`	(optional) Used to filter by the name of the object.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`export_status`	(optional) Specifies export status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . Allowed values are: 'IN_PROGRESS', 'SUCCESSFUL', 'QUEUED', 'TERMINATING', 'TERMINATED', 'FAILED'
`projection`	(optional) This parameter allows users to specify which view of the export object response to return. SUMMARY - Summary of the export object request will be returned. This is the default option when no value is specified. DETAILS - Details of export object request will be returned. This will include details of all the objects to be exported. Allowed values are: 'SUMMARY', 'DETAILS'
`time_started_in_millis`	(optional) Specifies start time of a copy object request.
`time_ended_in_millis`	(optional) Specifies end time of a copy object request.
`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://dataintegration.{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_EXTERNAL_PUBLICATION_VALIDATIONS Function

Retrieves a lists of external publication validations in a workspace and provides options to filter the list.

Syntax

FUNCTION list_external_publication_validations (
  workspace_id varchar2,
  task_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_external_publication_validations_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`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.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_EXTERNAL_PUBLICATIONS Function

Retrieves a list of external publications in an application and provides options to filter the list.

Syntax

FUNCTION list_external_publications (
  workspace_id varchar2,
  task_key varchar2,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name 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_di_data_integration_list_external_publications_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_FOLDERS Function

Retrieves a list of folders in a project and provides options to filter the list.

Syntax

FUNCTION list_folders (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  aggregator_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_folders_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`aggregator_key`	(optional) Used to filter by the project or the folder object.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`name_contains`	(optional) This parameter can be used to filter objects by the names that match partially or fully with the given value.
`identifier`	(optional) Used to filter by the identifier of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_FUNCTION_LIBRARIES Function

Retrieves a list of function libraries in a project and provides options to filter the list.

Syntax

FUNCTION list_function_libraries (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  aggregator_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_function_libraries_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`aggregator_key`	(optional) Used to filter by the project or the folder object.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_IMPORT_REQUESTS Function

This endpoint can be used to get the list of import object requests.

Syntax

FUNCTION list_import_requests (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  import_status varchar2 DEFAULT NULL,
  projection varchar2 DEFAULT NULL,
  time_started_in_millis number DEFAULT NULL,
  time_ended_in_millis number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_import_requests_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`name`	(optional) Used to filter by the name of the object.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`import_status`	(optional) Specifies import status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . Allowed values are: 'IN_PROGRESS', 'SUCCESSFUL', 'QUEUED', 'TERMINATING', 'TERMINATED', 'FAILED'
`projection`	(optional) This parameter allows users to specify which view of the import object response to return. SUMMARY - Summary of the import object request will be returned. This is the default option when no value is specified. DETAILS - Details of import object request will be returned. This will include details of all the objects to be exported. Allowed values are: 'SUMMARY', 'DETAILS'
`time_started_in_millis`	(optional) Specifies start time of a copy object request.
`time_ended_in_millis`	(optional) Specifies end time of a copy object request.
`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://dataintegration.{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_PATCH_CHANGES Function

Retrieves a list of patches in an application and provides options to filter the list.

Syntax

FUNCTION list_patch_changes (
  workspace_id varchar2,
  application_key varchar2,
  name varchar2 DEFAULT NULL,
  since_patch varchar2 DEFAULT NULL,
  to_patch 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_di_data_integration_list_patch_changes_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`name`	(optional) Used to filter by the name of the object.
`since_patch`	(optional) Specifies the patch key to query from.
`to_patch`	(optional) Specifies the patch key to query to.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_PATCHES Function

Retrieves a list of patches in an application and provides options to filter the list. For listing changes based on a period and logical objects changed, see ListPatchChanges API.

Syntax

FUNCTION list_patches (
  workspace_id varchar2,
  application_key varchar2,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_patches_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the published object.
`fields`	(optional) Specifies the fields to get for an object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_PIPELINE_VALIDATIONS Function

Retrieves a list of pipeline validations within the specified workspace.

Syntax

FUNCTION list_pipeline_validations (
  workspace_id varchar2,
  key varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_di_data_integration_list_pipeline_validations_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`key`	(optional) Used to filter by the key of the object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`fields`	(optional) Specifies the fields to get for an object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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://dataintegration.{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_PIPELINES Function

Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.

Syntax

FUNCTION list_pipelines (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  aggregator_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_pipelines_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`aggregator_key`	(optional) Used to filter by the project or the folder object.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_PROJECTS Function

Retrieves a lists of projects in a workspace and provides options to filter the list.

Syntax

FUNCTION list_projects (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_projects_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`name_contains`	(optional) This parameter can be used to filter objects by the names that match partially or fully with the given value.
`identifier`	(optional) Used to filter by the identifier of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_PUBLISHED_OBJECTS Function

Retrieves a list of all the published objects for a specified application.

Syntax

FUNCTION list_published_objects (
  workspace_id varchar2,
  application_key varchar2,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  name_starts_with varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  l_type dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  type_in_subtree 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_di_data_integration_list_published_objects_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`name_starts_with`	(optional) This parameter can be used to filter objects by the names starting with the given value.
`name_contains`	(optional) This parameter can be used to filter objects by the names that match partially or fully with the given value.
`identifier`	(optional) Used to filter by the identifier of the published object.
`l_type`	(optional) Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. For Data Integration APIs, a filter based on type Task is used.
`type_in_subtree`	(optional) Used in association with type parameter. If value is true, then type all sub types of the given type parameter is considered. If value is false, then sub types are not considered. Default is false.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_REFERENCES Function

Retrieves a list of references in an application. Reference objects are created when dataflows and tasks use objects, such as data assets and connections.

Syntax

FUNCTION list_references (
  workspace_id varchar2,
  application_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  name 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_di_data_integration_list_references_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`name`	(optional) Used to filter by the name of the object.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_RUNTIME_OPERATORS Function

This endpoint can be used to list runtime operators with filtering options

Syntax

FUNCTION list_runtime_operators (
  workspace_id varchar2,
  application_key varchar2,
  runtime_pipeline_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  key dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  aggregator_type dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_runtime_operators_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`runtime_pipeline_key`	(required) Runtime Pipeline Key
`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.
`key`	(optional) Used to filter by the key of the object.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`aggregator_type`	(optional) Unique type of the aggregator
`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://dataintegration.{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_RUNTIME_PIPELINES Function

This endpoint can be used to list runtime pipelines with filtering options

Syntax

FUNCTION list_runtime_pipelines (
  workspace_id varchar2,
  application_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  key dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  aggregator_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  aggregator_type dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  filter dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_runtime_pipelines_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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.
`key`	(optional) Used to filter by the key of the object.
`aggregator_key`	(optional) Unique key of the aggregator
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`aggregator_type`	(optional) Unique type of the aggregator
`filter`	(optional) This filter parameter can be used to filter by model specific queryable fields of the object <br><br><B>Examples:-</B><br> <ul> <li><B>?filter=status eq Failed</B> returns all objects that have a status field with value Failed</li> </ul>
`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://dataintegration.{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_SCHEDULES Function

Use this endpoint to list schedules.

Syntax

FUNCTION list_schedules (
  workspace_id varchar2,
  application_key varchar2,
  key dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  l_type dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_di_data_integration_list_schedules_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`key`	(optional) Used to filter by the key of the object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`l_type`	(optional) Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered. <br><br><B>Examples:</B><br> <ul> <li><B>?type=DATA_LOADER_TASK&typeInSubtree=false</B> returns all objects of type data loader task</li> <li><B>?type=DATA_LOADER_TASK</B> returns all objects of type data loader task</li> <li><B>?type=DATA_LOADER_TASK&typeInSubtree=true</B> returns all objects of type data loader task</li> </ul>
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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://dataintegration.{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_SCHEMAS Function

Retrieves a list of all the schemas that can be accessed using the specified connection.

Syntax

FUNCTION list_schemas (
  workspace_id varchar2,
  connection_key varchar2,
  schema_resource_name varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  name_list dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  include_types dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_schemas_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_key`	(required) The connection key.
`schema_resource_name`	(required) Schema resource name used for retrieving schemas.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`fields`	(optional) Specifies the fields to get for an object.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`name`	(optional) Used to filter by the name of the object.
`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.
`name_list`	(optional) Used to filter by the name of the object.
`include_types`	(optional) Artifact type which needs to be listed while listing Artifacts.
`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://dataintegration.{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_TASK_RUN_LINEAGES Function

This endpoint can be used to list Task Run Lineages within a given time window.

Syntax

FUNCTION list_task_run_lineages (
  workspace_id varchar2,
  application_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  filter dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  time_updated_greater_than timestamp with time zone DEFAULT NULL,
  time_updated_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_upated_less_than timestamp with time zone DEFAULT NULL,
  time_upated_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_task_run_lineages_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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.
`fields`	(optional) Specifies the fields to get for an object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`filter`	(optional) This filter parameter can be used to filter by model specific queryable fields of the object <br><br><B>Examples:-</B><br> <ul> <li><B>?filter=status eq Failed</B> returns all objects that have a status field with value Failed</li> </ul>
`time_updated_greater_than`	(optional) This parameter allows users to get objects which were updated after a certain time. The format of timeUpdatedGreaterThan is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\"
`time_updated_greater_than_or_equal_to`	(optional) This parameter allows users to get objects which were updated after and at a certain time. The format of timeUpdatedGreaterThanOrEqualTo is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\"
`time_upated_less_than`	(optional) This parameter allows users to get objects which were updated before a certain time. The format of timeUpatedLessThan is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\"
`time_upated_less_than_or_equal_to`	(optional) This parameter allows users to get objects which were updated before and at a certain time. The format of timeUpatedLessThanOrEqualTo is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\"
`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://dataintegration.{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_TASK_RUN_LOGS Function

Gets log entries for task runs using its key.

Syntax

FUNCTION list_task_run_logs (
  workspace_id varchar2,
  application_key varchar2,
  task_run_key varchar2,
  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_di_data_integration_list_task_run_logs_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`task_run_key`	(required) The task run key.
`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) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_TASK_RUNS Function

Retrieves a list of task runs and provides options to filter the list.

Syntax

FUNCTION list_task_runs (
  workspace_id varchar2,
  application_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  key dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  aggregator_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  filter dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name_starts_with varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_task_runs_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`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.
`key`	(optional) Used to filter by the key of the object.
`aggregator_key`	(optional) Used to filter by the project or the folder object.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`filter`	(optional) This filter parameter can be used to filter by model specific queryable fields of the object <br><br><B>Examples:-</B><br> <ul> <li><B>?filter=status eq Failed</B> returns all objects that have a status field with value Failed</li> </ul>
`name_starts_with`	(optional) This parameter can be used to filter objects by the names starting with the given value.
`name_contains`	(optional) This parameter can be used to filter objects by the names that match partially or fully with the given 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://dataintegration.{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_TASK_SCHEDULES Function

This endpoint can be used to get the list of all the TaskSchedule objects.

Syntax

FUNCTION list_task_schedules (
  workspace_id varchar2,
  application_key varchar2,
  key dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  l_type dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_enabled number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_di_data_integration_list_task_schedules_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`key`	(optional) Used to filter by the key of the object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`l_type`	(optional) Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered. <br><br><B>Examples:</B><br> <ul> <li><B>?type=DATA_LOADER_TASK&typeInSubtree=false</B> returns all objects of type data loader task</li> <li><B>?type=DATA_LOADER_TASK</B> returns all objects of type data loader task</li> <li><B>?type=DATA_LOADER_TASK&typeInSubtree=true</B> returns all objects of type data loader task</li> </ul>
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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.
`is_enabled`	(optional) This filter parameter can be used to filter task schedule by its state.
`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://dataintegration.{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_TASK_VALIDATIONS Function

Retrieves a list of task validations within the specified workspace.

Syntax

FUNCTION list_task_validations (
  workspace_id varchar2,
  key varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_di_data_integration_list_task_validations_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`key`	(optional) Used to filter by the key of the object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`fields`	(optional) Specifies the fields to get for an object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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://dataintegration.{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_TASKS Function

Retrieves a list of all tasks in a specified project or folder.

Syntax

FUNCTION list_tasks (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  folder_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  key dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  l_type dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_tasks_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`folder_id`	(optional) Unique key of the folder.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`key`	(optional) Used to filter by the key of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`l_type`	(optional) Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered. <br><br><B>Examples:</B><br> <ul> <li><B>?type=DATA_LOADER_TASK&typeInSubtree=false</B> returns all objects of type data loader task</li> <li><B>?type=DATA_LOADER_TASK</B> returns all objects of type data loader task</li> <li><B>?type=DATA_LOADER_TASK&typeInSubtree=true</B> returns all objects of type data loader task</li> </ul>
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_TEMPLATES Function

This endpoint can be used to list application templates with filtering options.

Syntax

FUNCTION list_templates (
  workspace_id varchar2,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_templates_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the published object.
`fields`	(optional) Specifies the fields to get for an object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_USER_DEFINED_FUNCTION_VALIDATIONS Function

Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.

Syntax

FUNCTION list_user_defined_function_validations (
  workspace_id varchar2,
  key varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_di_data_integration_list_user_defined_function_validations_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`key`	(optional) Used to filter by the key of the object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`fields`	(optional) Specifies the fields to get for an object.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`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://dataintegration.{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_USER_DEFINED_FUNCTIONS Function

Retrieves a list of UserDefinedFunctions in a function library.

Syntax

FUNCTION list_user_defined_functions (
  workspace_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  function_library_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_dataintegration_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  identifier dbms_cloud_oci_dataintegration_varchar2_tbl 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_di_data_integration_list_user_defined_functions_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`function_library_key`	(optional) Unique key of the FunctionLibrary.
`fields`	(optional) Specifies the fields to get for an object.
`name`	(optional) Used to filter by the name of the object.
`identifier`	(optional) Used to filter by the identifier of the object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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

Retrieves 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_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_di_data_integration_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous work request to retrieve.
`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) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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

Retrieves 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_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_di_data_integration_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous work request to retrieve.
`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) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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,
  opc_request_id varchar2 DEFAULT NULL,
  workspace_id varchar2 DEFAULT NULL,
  work_request_status 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_di_data_integration_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the resources you want to list.
`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.
`workspace_id`	(optional) DIS workspace id
`work_request_status`	(optional) The work request status. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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_WORKSPACES Function

Retrieves a list of Data Integration workspaces.

Syntax

FUNCTION list_workspaces (
  compartment_id varchar2,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state 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_di_data_integration_list_workspaces_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the resources you want to list.
`name`	(optional) Used to filter by the name of the object.
`limit`	(optional) Sets the maximum number of results per page, or items to return in a paginated `List` call. See List Pagination.
`page`	(optional) For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination.
`lifecycle_state`	(optional) The lifecycle state of a resource. When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match.
`sort_order`	(optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). Allowed values are: 'TIME_CREATED', 'DISPLAY_NAME', 'TIME_UPDATED'
`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://dataintegration.{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.

START_WORKSPACE Function

Starts a workspace.

Syntax

FUNCTION start_workspace (
  workspace_id varchar2,
  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_di_data_integration_start_workspace_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace 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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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.
`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.
`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://dataintegration.{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.

STOP_WORKSPACE Function

Stops a workspace.

Syntax

FUNCTION stop_workspace (
  workspace_id varchar2,
  quiesce_timeout number DEFAULT NULL,
  is_force_operation number DEFAULT NULL,
  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_di_data_integration_stop_workspace_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`quiesce_timeout`	(optional) Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace.
`is_force_operation`	(optional) Used to force close down the workspace.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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.
`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.
`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://dataintegration.{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_APPLICATION Function

Updates an application.

Syntax

FUNCTION update_application (
  workspace_id varchar2,
  application_key varchar2,
  update_application_details dbms_cloud_oci_dataintegration_update_application_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_di_data_integration_update_application_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`update_application_details`	(required) The details needed to update an 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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_APPLICATION_DETAILED_DESCRIPTION Function

Updates the detailed description of an Application.

Syntax

FUNCTION update_application_detailed_description (
  workspace_id varchar2,
  application_key varchar2,
  update_application_detailed_description_details dbms_cloud_oci_dataintegration_update_detailed_description_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_di_data_integration_update_application_detailed_description_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`update_application_detailed_description_details`	(required) The details needed to update the detailed description of 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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_CONNECTION Function

Updates a connection under a data asset.

Syntax

FUNCTION update_connection (
  workspace_id varchar2,
  connection_key varchar2,
  update_connection_details dbms_cloud_oci_dataintegration_update_connection_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_di_data_integration_update_connection_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`connection_key`	(required) The connection key.
`update_connection_details`	(required) The information needed to update a connection.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_COPY_OBJECT_REQUEST Function

Updates the status of a copy object request.

Syntax

FUNCTION update_copy_object_request (
  workspace_id varchar2,
  copy_object_request_key varchar2,
  update_copy_object_request_details dbms_cloud_oci_dataintegration_update_copy_object_request_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_di_data_integration_update_copy_object_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`copy_object_request_key`	(required) The key of the object to be copied, for example this could be the key of a project.
`update_copy_object_request_details`	(required) The details needed to update the status of a copy object 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.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DATA_ASSET Function

Updates a specific data asset with default connection.

Syntax

FUNCTION update_data_asset (
  workspace_id varchar2,
  data_asset_key varchar2,
  update_data_asset_details dbms_cloud_oci_dataintegration_update_data_asset_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_di_data_integration_update_data_asset_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_asset_key`	(required) The data asset key.
`update_data_asset_details`	(required) The information needed to update a data asset.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DATA_FLOW Function

Updates a specific data flow.

Syntax

FUNCTION update_data_flow (
  workspace_id varchar2,
  data_flow_key varchar2,
  update_data_flow_details dbms_cloud_oci_dataintegration_update_data_flow_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_di_data_integration_update_data_flow_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`data_flow_key`	(required) The data flow key.
`update_data_flow_details`	(required) The details needed to updated a data flow.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DIS_APPLICATION Function

Updates a DIS Application.

Syntax

FUNCTION update_dis_application (
  workspace_id varchar2,
  dis_application_id varchar2,
  update_dis_application_details dbms_cloud_oci_dataintegration_update_dis_application_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_di_data_integration_update_dis_application_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`dis_application_id`	(required) The OCID of the DIS Application.
`update_dis_application_details`	(required) The details needed to update an 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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_DIS_APPLICATION_DETAILED_DESCRIPTION Function

Updates the detailed description of an Application.

Syntax

FUNCTION update_dis_application_detailed_description (
  workspace_id varchar2,
  application_key varchar2,
  update_dis_application_detailed_description_details dbms_cloud_oci_dataintegration_update_detailed_description_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_di_data_integration_update_dis_application_detailed_description_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`update_dis_application_detailed_description_details`	(required) The details needed to update the detailed description of 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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_EXPORT_REQUEST Function

Updates the status of a export object request.

Syntax

FUNCTION update_export_request (
  workspace_id varchar2,
  export_request_key varchar2,
  update_export_request_details dbms_cloud_oci_dataintegration_update_export_request_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_di_data_integration_update_export_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`export_request_key`	(required) The key of the object export object request
`update_export_request_details`	(required) The details needed to update the status of a export object 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.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_EXTERNAL_PUBLICATION Function

Updates the external publication object.

Syntax

FUNCTION update_external_publication (
  workspace_id varchar2,
  task_key varchar2,
  external_publications_key varchar2,
  update_external_publication_details dbms_cloud_oci_dataintegration_update_external_publication_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_di_data_integration_update_external_publication_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`external_publications_key`	(required) The external published object key.
`update_external_publication_details`	(required) The information to be updated.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_FOLDER Function

Updates a specific folder.

Syntax

FUNCTION update_folder (
  workspace_id varchar2,
  folder_key varchar2,
  update_folder_details dbms_cloud_oci_dataintegration_update_folder_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_di_data_integration_update_folder_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`folder_key`	(required) The folder key.
`update_folder_details`	(required) The details needed to update a folder.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_FUNCTION_LIBRARY Function

Updates a specific Function Library.

Syntax

FUNCTION update_function_library (
  workspace_id varchar2,
  function_library_key varchar2,
  update_function_library_details dbms_cloud_oci_dataintegration_update_function_library_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_di_data_integration_update_function_library_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`function_library_key`	(required) The functionLibrary key.
`update_function_library_details`	(required) The details needed to update a FunctionL ibrary.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_IMPORT_REQUEST Function

Updates the status of a import object request.

Syntax

FUNCTION update_import_request (
  workspace_id varchar2,
  import_request_key varchar2,
  update_import_request_details dbms_cloud_oci_dataintegration_update_import_request_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_di_data_integration_update_import_request_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`import_request_key`	(required) The key of the object export object request
`update_import_request_details`	(required) The details needed to update the status of a import object 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.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_PIPELINE Function

Updates a specific pipeline.

Syntax

FUNCTION update_pipeline (
  workspace_id varchar2,
  pipeline_key varchar2,
  update_pipeline_details dbms_cloud_oci_dataintegration_update_pipeline_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_di_data_integration_update_pipeline_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`pipeline_key`	(required) The pipeline key.
`update_pipeline_details`	(required) The details needed to updated a pipeline.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_PROJECT Function

Updates a specific project.

Syntax

FUNCTION update_project (
  workspace_id varchar2,
  project_key varchar2,
  update_project_details dbms_cloud_oci_dataintegration_update_project_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_di_data_integration_update_project_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`project_key`	(required) The project key.
`update_project_details`	(required) The details needed to update a project.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_REFERENCE Function

Updates the application references. For example, to map a data asset to a different target object.

Syntax

FUNCTION update_reference (
  workspace_id varchar2,
  application_key varchar2,
  reference_key varchar2,
  update_reference_details dbms_cloud_oci_dataintegration_update_reference_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match 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_di_data_integration_update_reference_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`reference_key`	(required) The reference key.
`update_reference_details`	(required) The details needed to update the references.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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.
`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://dataintegration.{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_SCHEDULE Function

Endpoint used to update the schedule

Syntax

FUNCTION update_schedule (
  workspace_id varchar2,
  application_key varchar2,
  schedule_key varchar2,
  update_schedule_details dbms_cloud_oci_dataintegration_update_schedule_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_di_data_integration_update_schedule_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`schedule_key`	(required) Schedule Key
`update_schedule_details`	(required) Request body parameter for Schedule details
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_TASK Function

Updates a specific task. For example, you can update the task description or move the task to a different folder by changing the `aggregatorKey` to a different folder in the registry.

Syntax

FUNCTION update_task (
  workspace_id varchar2,
  task_key varchar2,
  update_task_details dbms_cloud_oci_dataintegration_update_task_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_di_data_integration_update_task_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`task_key`	(required) The task key.
`update_task_details`	(required) The details needed to update a task.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_TASK_RUN Function

Updates the status of the task run. For example, aborts a task run.

Syntax

FUNCTION update_task_run (
  workspace_id varchar2,
  application_key varchar2,
  task_run_key varchar2,
  update_task_run_details dbms_cloud_oci_dataintegration_update_task_run_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_di_data_integration_update_task_run_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`task_run_key`	(required) The task run key.
`update_task_run_details`	(required) The details needed to update the status of a task run.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_TASK_SCHEDULE Function

Endpoint used to update the TaskSchedule

Syntax

FUNCTION update_task_schedule (
  workspace_id varchar2,
  application_key varchar2,
  task_schedule_key varchar2,
  update_task_schedule_details dbms_cloud_oci_dataintegration_update_task_schedule_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_di_data_integration_update_task_schedule_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`application_key`	(required) The application key.
`task_schedule_key`	(required) TaskSchedule Key
`update_task_schedule_details`	(required) Request body parameter for TaskSchedule details
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_USER_DEFINED_FUNCTION Function

Updates a specific UserDefinedFunction.

Syntax

FUNCTION update_user_defined_function (
  workspace_id varchar2,
  user_defined_function_key varchar2,
  update_user_defined_function_details dbms_cloud_oci_dataintegration_update_user_defined_function_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_di_data_integration_update_user_defined_function_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`user_defined_function_key`	(required) The user defined function key.
`update_user_defined_function_details`	(required) The details needed to updated a UserDefinedFunction.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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_WORKSPACE Function

Updates the specified Data Integration workspace.

Syntax

FUNCTION update_workspace (
  workspace_id varchar2,
  update_workspace_details dbms_cloud_oci_dataintegration_update_workspace_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_di_data_integration_update_workspace_response_t;

Parameters

Parameter	Description
`workspace_id`	(required) The workspace ID.
`update_workspace_details`	(required) The information needed to update the workspace.
`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. When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code.
`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://dataintegration.{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

CHANGE_COMPARTMENT Function 🔗

CHANGE_DIS_APPLICATION_COMPARTMENT Function 🔗

CREATE_APPLICATION Function 🔗

CREATE_APPLICATION_DETAILED_DESCRIPTION Function 🔗

CREATE_CONNECTION Function 🔗

CREATE_CONNECTION_VALIDATION Function 🔗

CREATE_COPY_OBJECT_REQUEST Function 🔗

CREATE_DATA_ASSET Function 🔗

CREATE_DATA_FLOW Function 🔗

CREATE_DATA_FLOW_VALIDATION Function 🔗

CREATE_DIS_APPLICATION Function 🔗

CREATE_DIS_APPLICATION_DETAILED_DESCRIPTION Function 🔗

CREATE_ENTITY_SHAPE Function 🔗

CREATE_EXPORT_REQUEST Function 🔗

CREATE_EXTERNAL_PUBLICATION Function 🔗

CREATE_EXTERNAL_PUBLICATION_VALIDATION Function 🔗

CREATE_FOLDER Function 🔗

CREATE_FUNCTION_LIBRARY Function 🔗

CREATE_IMPORT_REQUEST Function 🔗

CREATE_PATCH Function 🔗

CREATE_PIPELINE Function 🔗

CREATE_PIPELINE_VALIDATION Function 🔗

CREATE_PROJECT Function 🔗

CREATE_SCHEDULE Function 🔗

CREATE_TASK Function 🔗

CREATE_TASK_RUN Function 🔗

CREATE_TASK_SCHEDULE Function 🔗

CREATE_TASK_VALIDATION Function 🔗

CREATE_USER_DEFINED_FUNCTION Function 🔗

CREATE_USER_DEFINED_FUNCTION_VALIDATION Function 🔗

CREATE_WORKSPACE Function 🔗

DELETE_APPLICATION Function 🔗

DELETE_APPLICATION_DETAILED_DESCRIPTION Function 🔗

DELETE_CONNECTION Function 🔗

DELETE_CONNECTION_VALIDATION Function 🔗

DELETE_COPY_OBJECT_REQUEST Function 🔗

DELETE_DATA_ASSET Function 🔗

DELETE_DATA_FLOW Function 🔗

DELETE_DATA_FLOW_VALIDATION Function 🔗

DELETE_DIS_APPLICATION Function 🔗

DELETE_DIS_APPLICATION_DETAILED_DESCRIPTION Function 🔗

DELETE_EXPORT_REQUEST Function 🔗

DELETE_EXTERNAL_PUBLICATION Function 🔗

DELETE_EXTERNAL_PUBLICATION_VALIDATION Function 🔗

DELETE_FOLDER Function 🔗

DELETE_FUNCTION_LIBRARY Function 🔗

DELETE_IMPORT_REQUEST Function 🔗

DELETE_PATCH Function 🔗

DELETE_PIPELINE Function 🔗

DELETE_PIPELINE_VALIDATION Function 🔗

DELETE_PROJECT Function 🔗

DELETE_SCHEDULE Function 🔗

DELETE_TASK Function 🔗

DELETE_TASK_RUN Function 🔗

DELETE_TASK_SCHEDULE Function 🔗

DELETE_TASK_VALIDATION Function 🔗

DELETE_USER_DEFINED_FUNCTION Function 🔗

DELETE_USER_DEFINED_FUNCTION_VALIDATION Function 🔗

DELETE_WORKSPACE Function 🔗

GET_APPLICATION Function 🔗

GET_APPLICATION_DETAILED_DESCRIPTION Function 🔗

GET_COMPOSITE_STATE Function 🔗

GET_CONNECTION Function 🔗

GET_CONNECTION_VALIDATION Function 🔗

GET_COPY_OBJECT_REQUEST Function 🔗

GET_COUNT_STATISTIC Function 🔗

GET_DATA_ASSET Function 🔗

GET_DATA_ENTITY Function 🔗

GET_DATA_FLOW Function 🔗

GET_DATA_FLOW_VALIDATION Function 🔗

GET_DEPENDENT_OBJECT Function 🔗

GET_DIS_APPLICATION Function 🔗

GET_DIS_APPLICATION_DETAILED_DESCRIPTION Function 🔗

GET_EXPORT_REQUEST Function 🔗

GET_EXTERNAL_PUBLICATION Function 🔗

GET_EXTERNAL_PUBLICATION_VALIDATION Function 🔗

GET_FOLDER Function 🔗

GET_FUNCTION_LIBRARY Function 🔗

GET_IMPORT_REQUEST Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_COMPARTMENT Function

CHANGE_DIS_APPLICATION_COMPARTMENT Function

CREATE_APPLICATION Function

CREATE_APPLICATION_DETAILED_DESCRIPTION Function

CREATE_CONNECTION Function

CREATE_CONNECTION_VALIDATION Function

CREATE_COPY_OBJECT_REQUEST Function

CREATE_DATA_ASSET Function

CREATE_DATA_FLOW Function

CREATE_DATA_FLOW_VALIDATION Function

CREATE_DIS_APPLICATION Function

CREATE_DIS_APPLICATION_DETAILED_DESCRIPTION Function

CREATE_ENTITY_SHAPE Function

CREATE_EXPORT_REQUEST Function

CREATE_EXTERNAL_PUBLICATION Function

CREATE_EXTERNAL_PUBLICATION_VALIDATION Function

CREATE_FOLDER Function

CREATE_FUNCTION_LIBRARY Function

CREATE_IMPORT_REQUEST Function

CREATE_PATCH Function

CREATE_PIPELINE Function

CREATE_PIPELINE_VALIDATION Function

CREATE_PROJECT Function

CREATE_SCHEDULE Function

CREATE_TASK Function

CREATE_TASK_RUN Function

CREATE_TASK_SCHEDULE Function

CREATE_TASK_VALIDATION Function

CREATE_USER_DEFINED_FUNCTION Function

CREATE_USER_DEFINED_FUNCTION_VALIDATION Function

CREATE_WORKSPACE Function

DELETE_APPLICATION Function

DELETE_APPLICATION_DETAILED_DESCRIPTION Function

DELETE_CONNECTION Function

DELETE_CONNECTION_VALIDATION Function

DELETE_COPY_OBJECT_REQUEST Function

DELETE_DATA_ASSET Function

DELETE_DATA_FLOW Function

DELETE_DATA_FLOW_VALIDATION Function

DELETE_DIS_APPLICATION Function

DELETE_DIS_APPLICATION_DETAILED_DESCRIPTION Function

DELETE_EXPORT_REQUEST Function

DELETE_EXTERNAL_PUBLICATION Function

DELETE_EXTERNAL_PUBLICATION_VALIDATION Function

DELETE_FOLDER Function

DELETE_FUNCTION_LIBRARY Function

DELETE_IMPORT_REQUEST Function

DELETE_PATCH Function

DELETE_PIPELINE Function

DELETE_PIPELINE_VALIDATION Function

DELETE_PROJECT Function

DELETE_SCHEDULE Function

DELETE_TASK Function

DELETE_TASK_RUN Function

DELETE_TASK_SCHEDULE Function

DELETE_TASK_VALIDATION Function

DELETE_USER_DEFINED_FUNCTION Function

DELETE_USER_DEFINED_FUNCTION_VALIDATION Function

DELETE_WORKSPACE Function

GET_APPLICATION Function

GET_APPLICATION_DETAILED_DESCRIPTION Function

GET_COMPOSITE_STATE Function

GET_CONNECTION Function

GET_CONNECTION_VALIDATION Function

GET_COPY_OBJECT_REQUEST Function

GET_COUNT_STATISTIC Function

GET_DATA_ASSET Function

GET_DATA_ENTITY Function

GET_DATA_FLOW Function

GET_DATA_FLOW_VALIDATION Function

GET_DEPENDENT_OBJECT Function

GET_DIS_APPLICATION Function

GET_DIS_APPLICATION_DETAILED_DESCRIPTION Function

GET_EXPORT_REQUEST Function

GET_EXTERNAL_PUBLICATION Function

GET_EXTERNAL_PUBLICATION_VALIDATION Function

GET_FOLDER Function

GET_FUNCTION_LIBRARY Function

GET_IMPORT_REQUEST Function