Data Catalog Functions

Package: DBMS_CLOUD_OCI_DC_DATA_CATALOG

ADD_CATALOG_LOCK Function

Adds a lock to a Catalog resource.

Syntax

FUNCTION add_catalog_lock (
  catalog_id varchar2,
  add_resource_lock_details dbms_cloud_oci_datacatalog_add_resource_lock_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_dc_data_catalog_add_catalog_lock_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`add_resource_lock_details`	(required) AddResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

ADD_CATALOG_PRIVATE_ENDPOINT_LOCK Function

Adds a lock to a CatalogPrivateEndpoint resource.

Syntax

FUNCTION add_catalog_private_endpoint_lock (
  catalog_private_endpoint_id varchar2,
  add_resource_lock_details dbms_cloud_oci_datacatalog_add_resource_lock_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_dc_data_catalog_add_catalog_private_endpoint_lock_response_t;

Parameters

Parameter	Description
`catalog_private_endpoint_id`	(required) Unique private reverse connection identifier.
`add_resource_lock_details`	(required) AddResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

ADD_DATA_SELECTOR_PATTERNS Function

Add data selector pattern to the data asset.

Syntax

FUNCTION add_data_selector_patterns (
  catalog_id varchar2,
  data_asset_key varchar2,
  data_selector_pattern_details dbms_cloud_oci_datacatalog_data_selector_pattern_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_dc_data_catalog_add_data_selector_patterns_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`data_selector_pattern_details`	(required) The information used to add the patterns for deriving logical entities.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

ADD_METASTORE_LOCK Function

Adds a lock to a Metastore resource.

Syntax

FUNCTION add_metastore_lock (
  metastore_id varchar2,
  add_resource_lock_details dbms_cloud_oci_datacatalog_add_resource_lock_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_dc_data_catalog_add_metastore_lock_response_t;

Parameters

Parameter	Description
`metastore_id`	(required) The metastore's OCID.
`add_resource_lock_details`	(required) AddResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

ASSOCIATE_CUSTOM_PROPERTY Function

Associate the custom property for the given type

Syntax

FUNCTION associate_custom_property (
  catalog_id varchar2,
  type_key varchar2,
  associate_custom_property_details dbms_cloud_oci_datacatalog_type_custom_property_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_dc_data_catalog_associate_custom_property_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`type_key`	(required) Unique type key.
`associate_custom_property_details`	(required) The information used to associate the custom property for the type.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

ASYNCHRONOUS_EXPORT_GLOSSARY Function

Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export.

Syntax

FUNCTION asynchronous_export_glossary (
  catalog_id varchar2,
  glossary_key varchar2,
  asynchronous_export_glossary_details dbms_cloud_oci_datacatalog_asynchronous_export_glossary_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_dc_data_catalog_asynchronous_export_glossary_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`asynchronous_export_glossary_details`	(required) Details needed by the glossary export request.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

ATTACH_CATALOG_PRIVATE_ENDPOINT Function

Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.

Syntax

FUNCTION attach_catalog_private_endpoint (
  attach_catalog_private_endpoint_details dbms_cloud_oci_datacatalog_attach_catalog_private_endpoint_details_t,
  catalog_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_attach_catalog_private_endpoint_response_t;

Parameters

Parameter	Description
`attach_catalog_private_endpoint_details`	(required) Details for private reverse connection endpoint to be used for attachment.
`catalog_id`	(required) Unique catalog identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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_CATALOG_COMPARTMENT Function

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

Syntax

FUNCTION change_catalog_compartment (
  change_catalog_compartment_details dbms_cloud_oci_datacatalog_change_catalog_compartment_details_t,
  catalog_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_change_catalog_compartment_response_t;

Parameters

Parameter	Description
`change_catalog_compartment_details`	(required) Details for the target compartment.
`catalog_id`	(required) Unique catalog identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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_CATALOG_PRIVATE_ENDPOINT_COMPARTMENT Function

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

Syntax

FUNCTION change_catalog_private_endpoint_compartment (
  change_catalog_private_endpoint_compartment_details dbms_cloud_oci_datacatalog_change_catalog_private_endpoint_compartment_details_t,
  catalog_private_endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_change_catalog_private_endpoint_compartment_response_t;

Parameters

Parameter	Description
`change_catalog_private_endpoint_compartment_details`	(required) Details for the target compartment.
`catalog_private_endpoint_id`	(required) Unique private reverse connection identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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_METASTORE_COMPARTMENT Function

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

Syntax

FUNCTION change_metastore_compartment (
  change_metastore_compartment_details dbms_cloud_oci_datacatalog_change_metastore_compartment_details_t,
  metastore_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_change_metastore_compartment_response_t;

Parameters

Parameter	Description
`change_metastore_compartment_details`	(required) Information about a change in metastore compartment.
`metastore_id`	(required) The metastore's OCID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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_ATTRIBUTE Function

Creates a new entity attribute.

Syntax

FUNCTION create_attribute (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  create_attribute_details dbms_cloud_oci_datacatalog_create_attribute_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_dc_data_catalog_create_attribute_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`create_attribute_details`	(required) The information used to create an entity attribute.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ATTRIBUTE_TAG Function

Creates a new entity attribute tag.

Syntax

FUNCTION create_attribute_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  attribute_key varchar2,
  create_attribute_tag_details dbms_cloud_oci_datacatalog_create_tag_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_dc_data_catalog_create_attribute_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`attribute_key`	(required) Unique attribute key.
`create_attribute_tag_details`	(required) The information used to create an entity attribute tag.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CATALOG Function

Creates a new data catalog instance that includes a console and an API URL for managing metadata operations. For more information, please see the documentation.

Syntax

FUNCTION create_catalog (
  create_catalog_details dbms_cloud_oci_datacatalog_create_catalog_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_create_catalog_response_t;

Parameters

Parameter	Description
`create_catalog_details`	(required) Details for the new data catalog.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CATALOG_PRIVATE_ENDPOINT Function

Create a new private reverse connection endpoint.

Syntax

FUNCTION create_catalog_private_endpoint (
  create_catalog_private_endpoint_details dbms_cloud_oci_datacatalog_create_catalog_private_endpoint_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_dc_data_catalog_create_catalog_private_endpoint_response_t;

Parameters

Parameter	Description
`create_catalog_private_endpoint_details`	(required) The information used to create the private reverse connection.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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 new connection.

Syntax

FUNCTION create_connection (
  catalog_id varchar2,
  data_asset_key varchar2,
  create_connection_details dbms_cloud_oci_datacatalog_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_dc_data_catalog_create_connection_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`create_connection_details`	(required) The information used to create the connection.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CUSTOM_PROPERTY Function

Create a new Custom Property

Syntax

FUNCTION create_custom_property (
  catalog_id varchar2,
  namespace_id varchar2,
  create_custom_property_details dbms_cloud_oci_datacatalog_create_custom_property_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_dc_data_catalog_create_custom_property_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`namespace_id`	(required) Unique namespace identifier.
`create_custom_property_details`	(required) The information used to create the Custom Property.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Create a new data asset.

Syntax

FUNCTION create_data_asset (
  catalog_id varchar2,
  create_data_asset_details dbms_cloud_oci_datacatalog_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_dc_data_catalog_create_data_asset_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`create_data_asset_details`	(required) The information used to create the data asset.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TAG Function

Creates a new data asset tag.

Syntax

FUNCTION create_data_asset_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  create_data_asset_tag_details dbms_cloud_oci_datacatalog_create_tag_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_dc_data_catalog_create_data_asset_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`create_data_asset_tag_details`	(required) The information used to create the data asset tag.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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 Function

Creates a new data entity.

Syntax

FUNCTION create_entity (
  catalog_id varchar2,
  data_asset_key varchar2,
  create_entity_details dbms_cloud_oci_datacatalog_create_entity_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_dc_data_catalog_create_entity_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`create_entity_details`	(required) The information used to create the data entity.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TAG Function

Creates a new entity tag.

Syntax

FUNCTION create_entity_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  create_entity_tag_details dbms_cloud_oci_datacatalog_create_tag_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_dc_data_catalog_create_entity_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`create_entity_tag_details`	(required) The information used to create the entity tag.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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 new folder.

Syntax

FUNCTION create_folder (
  catalog_id varchar2,
  data_asset_key varchar2,
  create_folder_details dbms_cloud_oci_datacatalog_create_folder_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_dc_data_catalog_create_folder_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`create_folder_details`	(required) The information used to create the folder.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TAG Function

Creates a new folder tag.

Syntax

FUNCTION create_folder_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  folder_key varchar2,
  create_folder_tag_details dbms_cloud_oci_datacatalog_create_tag_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_dc_data_catalog_create_folder_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`folder_key`	(required) Unique folder key.
`create_folder_tag_details`	(required) The information used to create the folder tag.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_GLOSSARY Function

Creates a new glossary.

Syntax

FUNCTION create_glossary (
  catalog_id varchar2,
  create_glossary_details dbms_cloud_oci_datacatalog_create_glossary_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_dc_data_catalog_create_glossary_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`create_glossary_details`	(required) The information used to create the glossary.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB Function

Creates a new job.

Syntax

FUNCTION create_job (
  catalog_id varchar2,
  create_job_details dbms_cloud_oci_datacatalog_create_job_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_dc_data_catalog_create_job_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`create_job_details`	(required) The information used to create the job.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_DEFINITION Function

Creates a new job definition.

Syntax

FUNCTION create_job_definition (
  catalog_id varchar2,
  create_job_definition_details dbms_cloud_oci_datacatalog_create_job_definition_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_dc_data_catalog_create_job_definition_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`create_job_definition_details`	(required) The information used to create the job definition.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_EXECUTION Function

Creates a new job execution.

Syntax

FUNCTION create_job_execution (
  catalog_id varchar2,
  job_key varchar2,
  create_job_execution_details dbms_cloud_oci_datacatalog_create_job_execution_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_dc_data_catalog_create_job_execution_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`create_job_execution_details`	(required) The information used to create the job execution.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_METASTORE Function

Creates a new metastore.

Syntax

FUNCTION create_metastore (
  create_metastore_details dbms_cloud_oci_datacatalog_create_metastore_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_dc_data_catalog_create_metastore_response_t;

Parameters

Parameter	Description
`create_metastore_details`	(required) Information about a new metastore to be created.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_NAMESPACE Function

Create a new Namespace to be used by a custom property

Syntax

FUNCTION create_namespace (
  catalog_id varchar2,
  create_namespace_details dbms_cloud_oci_datacatalog_create_namespace_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_dc_data_catalog_create_namespace_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`create_namespace_details`	(required) The information used to create the Namespace.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_PATTERN Function

Create a new pattern.

Syntax

FUNCTION create_pattern (
  catalog_id varchar2,
  create_pattern_details dbms_cloud_oci_datacatalog_create_pattern_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_dc_data_catalog_create_pattern_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`create_pattern_details`	(required) The information used to create the pattern.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM Function

Create a new term within a glossary.

Syntax

FUNCTION create_term (
  catalog_id varchar2,
  glossary_key varchar2,
  create_term_details dbms_cloud_oci_datacatalog_create_term_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_dc_data_catalog_create_term_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`create_term_details`	(required) The information used to create the term.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM_RELATIONSHIP Function

Creates a new term relationship for this term within a glossary.

Syntax

FUNCTION create_term_relationship (
  catalog_id varchar2,
  glossary_key varchar2,
  term_key varchar2,
  create_term_relationship_details dbms_cloud_oci_datacatalog_create_term_relationship_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_dc_data_catalog_create_term_relationship_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`term_key`	(required) Unique glossary term key.
`create_term_relationship_details`	(required) The information used to create the term relationship.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ATTRIBUTE Function

Deletes a specific entity attribute.

Syntax

FUNCTION delete_attribute (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  attribute_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_dc_data_catalog_delete_attribute_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`attribute_key`	(required) Unique attribute 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ATTRIBUTE_TAG Function

Deletes a specific entity attribute tag.

Syntax

FUNCTION delete_attribute_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  attribute_key varchar2,
  tag_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_dc_data_catalog_delete_attribute_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`attribute_key`	(required) Unique attribute key.
`tag_key`	(required) Unique tag 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CATALOG Function

Deletes a data catalog resource by identifier.

Syntax

FUNCTION delete_catalog (
  catalog_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_delete_catalog_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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_CATALOG_PRIVATE_ENDPOINT Function

Deletes a private reverse connection endpoint by identifier.

Syntax

FUNCTION delete_catalog_private_endpoint (
  catalog_private_endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_delete_catalog_private_endpoint_response_t;

Parameters

Parameter	Description
`catalog_private_endpoint_id`	(required) Unique private reverse connection identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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

Deletes a specific connection of a data asset.

Syntax

FUNCTION delete_connection (
  catalog_id varchar2,
  data_asset_key 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_dc_data_catalog_delete_connection_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`connection_key`	(required) Unique 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CUSTOM_PROPERTY Function

Deletes a specific custom property identified by it's key.

Syntax

FUNCTION delete_custom_property (
  catalog_id varchar2,
  namespace_id varchar2,
  custom_property_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_dc_data_catalog_delete_custom_property_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`namespace_id`	(required) Unique namespace identifier.
`custom_property_key`	(required) Unique Custom Property 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Deletes a specific data asset identified by it's key.

Syntax

FUNCTION delete_data_asset (
  catalog_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_dc_data_catalog_delete_data_asset_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TAG Function

Deletes a specific data asset tag.

Syntax

FUNCTION delete_data_asset_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  tag_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_dc_data_catalog_delete_data_asset_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`tag_key`	(required) Unique tag 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ENTITY Function

Deletes a specific data entity.

Syntax

FUNCTION delete_entity (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_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_dc_data_catalog_delete_entity_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ENTITY_TAG Function

Deletes a specific entity tag.

Syntax

FUNCTION delete_entity_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  tag_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_dc_data_catalog_delete_entity_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`tag_key`	(required) Unique tag 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Deletes a specific folder of a data asset identified by it's key.

Syntax

FUNCTION delete_folder (
  catalog_id varchar2,
  data_asset_key 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_dc_data_catalog_delete_folder_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`folder_key`	(required) Unique 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TAG Function

Deletes a specific folder tag.

Syntax

FUNCTION delete_folder_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  folder_key varchar2,
  tag_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_dc_data_catalog_delete_folder_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`folder_key`	(required) Unique folder key.
`tag_key`	(required) Unique tag 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_GLOSSARY Function

Deletes a specific glossary identified by it's key.

Syntax

FUNCTION delete_glossary (
  catalog_id varchar2,
  glossary_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_dc_data_catalog_delete_glossary_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB Function

Deletes a specific job identified by it's key.

Syntax

FUNCTION delete_job (
  catalog_id varchar2,
  job_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_dc_data_catalog_delete_job_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_DEFINITION Function

Deletes a specific job definition identified by it's key.

Syntax

FUNCTION delete_job_definition (
  catalog_id varchar2,
  job_definition_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_dc_data_catalog_delete_job_definition_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_definition_key`	(required) Unique job definition 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_METASTORE Function

Deletes a metastore resource by identifier.

Syntax

FUNCTION delete_metastore (
  metastore_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_delete_metastore_response_t;

Parameters

Parameter	Description
`metastore_id`	(required) The metastore's OCID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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_NAMESPACE Function

Deletes a specific Namespace identified by it's key.

Syntax

FUNCTION delete_namespace (
  catalog_id varchar2,
  namespace_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_dc_data_catalog_delete_namespace_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`namespace_id`	(required) Unique namespace identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_PATTERN Function

Deletes a specific pattern identified by it's key.

Syntax

FUNCTION delete_pattern (
  catalog_id varchar2,
  pattern_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_dc_data_catalog_delete_pattern_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`pattern_key`	(required) Unique pattern 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM Function

Deletes a specific glossary term.

Syntax

FUNCTION delete_term (
  catalog_id varchar2,
  glossary_key varchar2,
  term_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_dc_data_catalog_delete_term_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`term_key`	(required) Unique glossary term 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM_RELATIONSHIP Function

Deletes a specific glossary term relationship.

Syntax

FUNCTION delete_term_relationship (
  catalog_id varchar2,
  glossary_key varchar2,
  term_key varchar2,
  term_relationship_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_dc_data_catalog_delete_term_relationship_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`term_key`	(required) Unique glossary term key.
`term_relationship_key`	(required) Unique glossary term relationship 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

DETACH_CATALOG_PRIVATE_ENDPOINT Function

Detaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.

Syntax

FUNCTION detach_catalog_private_endpoint (
  detach_catalog_private_endpoint_details dbms_cloud_oci_datacatalog_detach_catalog_private_endpoint_details_t,
  catalog_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_detach_catalog_private_endpoint_response_t;

Parameters

Parameter	Description
`detach_catalog_private_endpoint_details`	(required) Details for private reverse connection endpoint to be used for attachment
`catalog_id`	(required) Unique catalog identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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.

DISASSOCIATE_CUSTOM_PROPERTY Function

Remove the custom property for the given type

Syntax

FUNCTION disassociate_custom_property (
  catalog_id varchar2,
  type_key varchar2,
  disassociate_custom_property_details dbms_cloud_oci_datacatalog_type_custom_property_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_dc_data_catalog_disassociate_custom_property_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`type_key`	(required) Unique type key.
`disassociate_custom_property_details`	(required) The information used to remove the custom properties.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

EXPAND_TREE_FOR_GLOSSARY Function

Returns the fully expanded tree hierarchy of parent and child terms in this glossary.

Syntax

FUNCTION expand_tree_for_glossary (
  catalog_id varchar2,
  glossary_key varchar2,
  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_dc_data_catalog_expand_tree_for_glossary_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

EXPORT_GLOSSARY Function

Export the glossary and the terms and return the exported glossary as csv or json.

Syntax

FUNCTION export_glossary (
  catalog_id varchar2,
  glossary_key varchar2,
  is_relationship_exported number 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_dc_data_catalog_export_glossary_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`is_relationship_exported`	(optional) Specify if the relationship metadata is exported for the glossary.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

FETCH_ENTITY_LINEAGE Function

Returns lineage for a given entity object.

Syntax

FUNCTION fetch_entity_lineage (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  fetch_entity_lineage_details dbms_cloud_oci_datacatalog_fetch_entity_lineage_details_t,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_fetch_entity_lineage_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`fetch_entity_lineage_details`	(required) The information needed to obtain desired lineage.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ATTRIBUTE Function

Gets a specific entity attribute by key.

Syntax

FUNCTION get_attribute (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  attribute_key varchar2,
  is_include_object_relationships number DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_attribute_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`attribute_key`	(required) Unique attribute key.
`is_include_object_relationships`	(optional) Indicates whether the list of objects and their relationships to this object will be provided in the response.
`fields`	(optional) Specifies the fields to return in an entity attribute response. Allowed values are: 'key', 'displayName', 'description', 'entityKey', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'externalDataType', 'externalKey', 'isIncrementalData', 'isNullable', 'length', 'position', 'precision', 'scale', 'timeExternal', 'uri', 'properties', 'path', 'minCollectionCount', 'maxCollectionCount', 'datatypeEntityKey', 'externalDatatypeEntityKey', 'parentAttributeKey', 'externalParentAttributeKey', 'typeKey'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ATTRIBUTE_TAG Function

Gets a specific entity attribute tag by key.

Syntax

FUNCTION get_attribute_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  attribute_key varchar2,
  tag_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_attribute_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`attribute_key`	(required) Unique attribute key.
`tag_key`	(required) Unique tag key.
`fields`	(optional) Specifies the fields to return in an entity attribute tag response. Allowed values are: 'key', 'name', 'termKey', 'termPath', 'termDescription', 'lifecycleState', 'timeCreated', 'createdById', 'uri', 'attributeKey'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CATALOG Function

Gets a data catalog by identifier.

Syntax

FUNCTION get_catalog (
  catalog_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_get_catalog_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CATALOG_PRIVATE_ENDPOINT Function

Gets a specific private reverse connection by identifier.

Syntax

FUNCTION get_catalog_private_endpoint (
  catalog_private_endpoint_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_dc_data_catalog_get_catalog_private_endpoint_response_t;

Parameters

Parameter	Description
`catalog_private_endpoint_id`	(required) Unique private reverse connection identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Gets a specific data asset connection by key.

Syntax

FUNCTION get_connection (
  catalog_id varchar2,
  data_asset_key varchar2,
  connection_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_connection_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`connection_key`	(required) Unique connection key.
`fields`	(optional) Specifies the fields to return in a connection response. Allowed values are: 'key', 'displayName', 'description', 'dataAssetKey', 'typeKey', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'properties', 'externalKey', 'timeStatusUpdated', 'lifecycleState', 'isDefault', 'uri'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CUSTOM_PROPERTY Function

Gets a specific custom property for the given key within a data catalog.

Syntax

FUNCTION get_custom_property (
  catalog_id varchar2,
  namespace_id varchar2,
  custom_property_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_custom_property_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`namespace_id`	(required) Unique namespace identifier.
`custom_property_key`	(required) Unique Custom Property key
`fields`	(optional) Specifies the fields to return in a custom property response. Allowed values are: 'key', 'displayName', 'description', 'dataType', 'namespaceName', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'properties'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Gets a specific data asset for the given key within a data catalog.

Syntax

FUNCTION get_data_asset (
  catalog_id varchar2,
  data_asset_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_data_asset_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`fields`	(optional) Specifies the fields to return in a data asset response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'externalKey', 'typeKey', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'uri', 'properties'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TAG Function

Gets a specific data asset tag by key.

Syntax

FUNCTION get_data_asset_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  tag_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_data_asset_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`tag_key`	(required) Unique tag key.
`fields`	(optional) Specifies the fields to return in a data asset tag response. Allowed values are: 'key', 'name', 'termKey', 'termPath', 'termDescription', 'lifecycleState', 'timeCreated', 'createdById', 'uri', 'dataAssetKey'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ENTITY Function

Gets a specific data entity by key for a data asset.

Syntax

FUNCTION get_entity (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  is_include_object_relationships number DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_entity_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`is_include_object_relationships`	(optional) Indicates whether the list of objects and their relationships to this object will be provided in the response.
`fields`	(optional) Specifies the fields to return in an entity response. Allowed values are: 'key', 'displayName', 'description', 'dataAssetKey', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'lifecycleState', 'externalKey', 'timeExternal', 'timeStatusUpdated', 'isLogical', 'isPartition', 'folderKey', 'folderName', 'typeKey', 'path', 'harvestStatus', 'lastJobKey', 'uri', 'properties'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ENTITY_TAG Function

Gets a specific entity tag by key.

Syntax

FUNCTION get_entity_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  tag_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_entity_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`tag_key`	(required) Unique tag key.
`fields`	(optional) Specifies the fields to return in an entity tag response. Allowed values are: 'key', 'name', 'termKey', 'termPath', 'termDescription', 'lifecycleState', 'timeCreated', 'createdById', 'uri', 'entityKey'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Gets a specific data asset folder by key.

Syntax

FUNCTION get_folder (
  catalog_id varchar2,
  data_asset_key varchar2,
  folder_key varchar2,
  is_include_object_relationships number DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_folder_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`folder_key`	(required) Unique folder key.
`is_include_object_relationships`	(optional) Indicates whether the list of objects and their relationships to this object will be provided in the response.
`fields`	(optional) Specifies the fields to return in a folder response. Allowed values are: 'key', 'displayName', 'description', 'parentFolderKey', 'path', 'dataAssetKey', 'properties', 'externalKey', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'timeExternal', 'lifecycleState', 'harvestStatus', 'lastJobKey', 'uri'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TAG Function

Gets a specific folder tag by key.

Syntax

FUNCTION get_folder_tag (
  catalog_id varchar2,
  data_asset_key varchar2,
  folder_key varchar2,
  tag_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_folder_tag_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`folder_key`	(required) Unique folder key.
`tag_key`	(required) Unique tag key.
`fields`	(optional) Specifies the fields to return in a folder tag response. Allowed values are: 'key', 'name', 'termKey', 'termPath', 'termDescription', 'lifecycleState', 'timeCreated', 'createdById', 'uri', 'folderKey'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_GLOSSARY Function

Gets a specific glossary by key within a data catalog.

Syntax

FUNCTION get_glossary (
  catalog_id varchar2,
  glossary_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_glossary_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`fields`	(optional) Specifies the fields to return in a glossary response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'owner', 'workflowStatus', 'uri'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB Function

Gets a specific job by key within a data catalog.

Syntax

FUNCTION get_job (
  catalog_id varchar2,
  job_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_job_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`fields`	(optional) Specifies the fields to return in a job response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'lifecycleState', 'timeCreated', 'timeUpdated', 'jobType', 'scheduleCronExpression', 'timeScheduleBegin', 'timeScheduleEnd', 'scheduleType', 'connectionKey', 'jobDefinitionKey', 'internalVersion', 'executionCount', 'timeOfLatestExecution', 'executions', 'createdById', 'updatedById', 'uri', 'jobDefinitionName', 'errorCode', 'errorMessage'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_DEFINITION Function

Gets a specific job definition by key within a data catalog.

Syntax

FUNCTION get_job_definition (
  catalog_id varchar2,
  job_definition_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_job_definition_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_definition_key`	(required) Unique job definition key.
`fields`	(optional) Specifies the fields to return in a job definition response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'jobType', 'isIncremental', 'dataAssetKey', 'connectionKey', 'internalVersion', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'uri', 'isSampleDataExtracted', 'sampleDataSizeInMBs', 'timeLatestExecutionStarted', 'timeLatestExecutionEnded', 'jobExecutionState', 'scheduleType', 'properties'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_EXECUTION Function

Gets a specific job execution by key.

Syntax

FUNCTION get_job_execution (
  catalog_id varchar2,
  job_key varchar2,
  job_execution_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_job_execution_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`job_execution_key`	(required) The key of the job execution.
`fields`	(optional) Specifies the fields to return in a job execution response. Allowed values are: 'key', 'jobKey', 'jobType', 'subType', 'parentKey', 'scheduleInstanceKey', 'lifecycleState', 'timeCreated', 'timeStarted', 'timeEnded', 'errorCode', 'errorMessage', 'processKey', 'externalUrl', 'eventKey', 'dataEntityKey', 'createdById', 'updatedById', 'properties', 'uri'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_LOG Function

Gets a specific job log by key.

Syntax

FUNCTION get_job_log (
  catalog_id varchar2,
  job_key varchar2,
  job_execution_key varchar2,
  job_log_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_job_log_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`job_execution_key`	(required) The key of the job execution.
`job_log_key`	(required) Unique job log key.
`fields`	(optional) Specifies the fields to return in a job log response. Allowed values are: 'key', 'jobExecutionKey', 'createdById', 'updatedById', 'timeUpdated', 'timeCreated', 'severity', 'logMessage', 'uri'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_METRICS Function

Gets a specific job metric by key.

Syntax

FUNCTION get_job_metrics (
  catalog_id varchar2,
  job_key varchar2,
  job_execution_key varchar2,
  job_metrics_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_job_metrics_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`job_execution_key`	(required) The key of the job execution.
`job_metrics_key`	(required) Unique job metrics key.
`fields`	(optional) Specifies the fields to return in a job metric response. Allowed values are: 'key', 'description', 'displayName', 'timeInserted', 'category', 'subCategory', 'unit', 'value', 'batchKey', 'jobExecutionKey', 'createdById', 'updatedById', 'timeUpdated', 'timeCreated', 'uri'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_METASTORE Function

Gets a metastore by identifier.

Syntax

FUNCTION get_metastore (
  metastore_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_dc_data_catalog_get_metastore_response_t;

Parameters

Parameter	Description
`metastore_id`	(required) The metastore's OCID.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_NAMESPACE Function

Gets a specific namespace for the given key within a data catalog.

Syntax

FUNCTION get_namespace (
  catalog_id varchar2,
  namespace_id varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_namespace_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`namespace_id`	(required) Unique namespace identifier.
`fields`	(optional) Specifies the fields to return in a namespace response. Allowed values are: 'key', 'displayName', 'description', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'properties'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_PATTERN Function

Gets a specific pattern for the given key within a data catalog.

Syntax

FUNCTION get_pattern (
  catalog_id varchar2,
  pattern_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_pattern_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`pattern_key`	(required) Unique pattern key.
`fields`	(optional) Specifies the fields to return in a pattern response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'expression', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'properties'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM Function

Gets a specific glossary term by key.

Syntax

FUNCTION get_term (
  catalog_id varchar2,
  glossary_key varchar2,
  term_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_term_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`term_key`	(required) Unique glossary term key.
`fields`	(optional) Specifies the fields to return in a term response. Allowed values are: 'key', 'displayName', 'description', 'glossaryKey', 'parentTermKey', 'isAllowedToHaveChildTerms', 'path', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'owner', 'workflowStatus', 'uri', 'relatedTerms', 'associatedObjectCount', 'associatedObjects'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM_RELATIONSHIP Function

Gets a specific glossary term relationship by key.

Syntax

FUNCTION get_term_relationship (
  catalog_id varchar2,
  glossary_key varchar2,
  term_key varchar2,
  term_relationship_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_term_relationship_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`term_key`	(required) Unique glossary term key.
`term_relationship_key`	(required) Unique glossary term relationship key.
`fields`	(optional) Specifies the fields to return in a term relationship response. Allowed values are: 'key', 'displayName', 'description', 'relatedTermKey', 'relatedTermDisplayName', 'parentTermKey', 'parentTermDisplayName', 'lifecycleState', 'timeCreated', 'uri'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TYPE Function

Gets a specific type by key within a data catalog.

Syntax

FUNCTION get_type (
  catalog_id varchar2,
  type_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl 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_dc_data_catalog_get_type_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`type_key`	(required) Unique type key.
`fields`	(optional) Specifies the fields to return in a type response. Allowed values are: 'key', 'description', 'name', 'catalogId', 'properties', 'isInternal', 'isTag', 'isApproved', 'typeCategory', 'externalTypeName', 'lifecycleState', 'uri'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

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

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_dc_data_catalog_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

IMPORT_CONNECTION Function

Import new connection for this data asset.

Syntax

FUNCTION import_connection (
  catalog_id varchar2,
  data_asset_key varchar2,
  import_connection_details dbms_cloud_oci_datacatalog_import_connection_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_dc_data_catalog_import_connection_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`import_connection_details`	(required) The information used to create the connections through import.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

IMPORT_DATA_ASSET Function

Import technical objects to a Data Asset

Syntax

FUNCTION import_data_asset (
  catalog_id varchar2,
  data_asset_key varchar2,
  import_data_asset_details dbms_cloud_oci_datacatalog_import_data_asset_details_t,
  import_type dbms_cloud_oci_datacatalog_varchar2_tbl,
  is_missing_value_ignored number 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_dc_data_catalog_import_data_asset_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`import_data_asset_details`	(required) The file contents to be imported.
`import_type`	(required) Type of import. Allowed values are: 'CUSTOM_PROPERTY_VALUES', 'ALL'
`is_missing_value_ignored`	(optional) Specify whether to ignore the missing values in the import file.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

IMPORT_GLOSSARY Function

Import the glossary and the terms from csv or json files and return the imported glossary resource.

Syntax

FUNCTION import_glossary (
  catalog_id varchar2,
  glossary_key varchar2,
  import_glossary_details dbms_cloud_oci_datacatalog_import_glossary_details_t,
  is_relationship_imported number 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_dc_data_catalog_import_glossary_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`import_glossary_details`	(required) The file contents to import the glossary.
`is_relationship_imported`	(optional) Specify if the relationship metadata is imported for the glossary.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_AGGREGATED_PHYSICAL_ENTITIES Function

List the physical entities aggregated by this logical entity.

Syntax

FUNCTION list_aggregated_physical_entities (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  is_include_properties number 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_dc_data_catalog_list_aggregated_physical_entities_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`fields`	(optional) Specifies the fields to return in an entity response. Allowed values are: 'key', 'displayName', 'description', 'dataAssetKey', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'lifecycleState', 'externalKey', 'timeExternal', 'timeStatusUpdated', 'isLogical', 'isPartition', 'folderKey', 'folderName', 'typeKey', 'path', 'harvestStatus', 'lastJobKey', 'uri', 'properties'
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`is_include_properties`	(optional) Indicates whether the properties map will be provided in the response.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ATTRIBUTE_TAGS Function

Returns a list of all tags for an entity attribute.

Syntax

FUNCTION list_attribute_tags (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  attribute_key varchar2,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  term_key varchar2 DEFAULT NULL,
  term_path varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_attribute_tags_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`attribute_key`	(required) Unique attribute key.
`name`	(optional) Immutable resource name.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`term_key`	(optional) Unique key of the related term.
`term_path`	(optional) Path of the related term.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`fields`	(optional) Specifies the fields to return in an entity attribute tag summary response. Allowed values are: 'key', 'name', 'termKey', 'termPath', 'termDescription', 'lifecycleState', 'timeCreated', 'uri', 'glossaryKey', 'attributeKey'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ATTRIBUTES Function

Returns a list of all attributes of an data entity.

Syntax

FUNCTION list_attributes (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  display_name varchar2 DEFAULT NULL,
  business_name varchar2 DEFAULT NULL,
  display_or_business_name_contains varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  external_key varchar2 DEFAULT NULL,
  time_external timestamp with time zone DEFAULT NULL,
  external_type_name varchar2 DEFAULT NULL,
  is_incremental_data number DEFAULT NULL,
  is_nullable number DEFAULT NULL,
  length number DEFAULT NULL,
  position number DEFAULT NULL,
  precision number DEFAULT NULL,
  scale number DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_attributes_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`business_name`	(optional) A filter to return only resources that match the entire business name given. The match is not case sensitive.
`display_or_business_name_contains`	(optional) A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`external_key`	(optional) Unique external identifier of this resource in the external source system.
`time_external`	(optional) Last modified timestamp of this object in the external system.
`external_type_name`	(optional) Data type as defined in an external system.
`is_incremental_data`	(optional) Identifies whether this attribute can be used as a watermark to extract incremental data.
`is_nullable`	(optional) Identifies whether this attribute can be assigned null value.
`length`	(optional) Max allowed length of the attribute value.
`position`	(optional) Position of the attribute in the record definition.
`precision`	(optional) Precision of the attribute value usually applies to float data type.
`scale`	(optional) Scale of the attribute value usually applies to float data type.
`fields`	(optional) Specifies the fields to return in an entity attribute summary response. Allowed values are: 'key', 'displayName', 'description', 'entityKey', 'lifecycleState', 'timeCreated', 'externalDataType', 'externalKey', 'length', 'precision', 'scale', 'isNullable', 'uri', 'path', 'minCollectionCount', 'maxCollectionCount', 'datatypeEntityKey', 'externalDatatypeEntityKey', 'parentAttributeKey', 'externalParentAttributeKey', 'position', 'typeKey'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME', 'POSITION', 'DISPLAYORBUSINESSNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CATALOG_PRIVATE_ENDPOINTS Function

Returns a list of all the catalog private endpoints in the specified compartment.

Syntax

FUNCTION list_catalog_private_endpoints (
  compartment_id varchar2,
  display_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_dc_data_catalog_list_catalog_private_endpoints_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment where you want to list resources.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CATALOGS Function

Returns a list of all the data catalogs in the specified compartment.

Syntax

FUNCTION list_catalogs (
  compartment_id varchar2,
  display_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_dc_data_catalog_list_catalogs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment where you want to list resources.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Returns a list of all Connections for a data asset.

Syntax

FUNCTION list_connections (
  catalog_id varchar2,
  data_asset_key varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  external_key varchar2 DEFAULT NULL,
  time_status_updated timestamp with time zone DEFAULT NULL,
  is_default number DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_connections_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`external_key`	(optional) Unique external identifier of this resource in the external source system.
`time_status_updated`	(optional) Time that the resource's status was last updated. An RFC3339 formatted datetime string.
`is_default`	(optional) Indicates whether this connection is the default connection.
`fields`	(optional) Specifies the fields to return in a connection summary response. Allowed values are: 'key', 'displayName', 'description', 'dataAssetKey', 'typeKey', 'timeCreated', 'externalKey', 'lifecycleState', 'isDefault', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CUSTOM_PROPERTIES Function

Returns a list of custom properties within a data catalog.

Syntax

FUNCTION list_custom_properties (
  catalog_id varchar2,
  namespace_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  data_types dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  type_name dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_custom_properties_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`namespace_id`	(required) Unique namespace identifier.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`data_types`	(optional) Return the custom properties which has specified data types Allowed values are: 'TEXT', 'RICH_TEXT', 'BOOLEAN', 'NUMBER', 'DATE'
`type_name`	(optional) A filter to return only resources that match the entire type name given. The match is not case sensitive Allowed values are: 'DATA_ASSET', 'AUTONOMOUS_DATA_WAREHOUSE', 'HIVE', 'KAFKA', 'MYSQL', 'ORACLE_OBJECT_STORAGE', 'AUTONOMOUS_TRANSACTION_PROCESSING', 'ORACLE', 'POSTGRESQL', 'MICROSOFT_AZURE_SQL_DATABASE', 'MICROSOFT_SQL_SERVER', 'IBM_DB2', 'DATA_ENTITY', 'LOGICAL_ENTITY', 'TABLE', 'VIEW', 'ATTRIBUTE', 'FOLDER', 'ORACLE_ANALYTICS_SUBJECT_AREA_COLUMN', 'ORACLE_ANALYTICS_LOGICAL_COLUMN', 'ORACLE_ANALYTICS_PHYSICAL_COLUMN', 'ORACLE_ANALYTICS_ANALYSIS_COLUMN', 'ORACLE_ANALYTICS_SERVER', 'ORACLE_ANALYTICS_CLOUD', 'ORACLE_ANALYTICS_SUBJECT_AREA', 'ORACLE_ANALYTICS_DASHBOARD', 'ORACLE_ANALYTICS_BUSINESS_MODEL', 'ORACLE_ANALYTICS_PHYSICAL_DATABASE', 'ORACLE_ANALYTICS_PHYSICAL_SCHEMA', 'ORACLE_ANALYTICS_PRESENTATION_TABLE', 'ORACLE_ANALYTICS_LOGICAL_TABLE', 'ORACLE_ANALYTICS_PHYSICAL_TABLE', 'ORACLE_ANALYTICS_ANALYSIS', 'DATABASE_SCHEMA', 'TOPIC', 'CONNECTION', 'GLOSSARY', 'TERM', 'CATEGORY', 'FILE', 'BUCKET', 'MESSAGE', 'UNRECOGNIZED_FILE'
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`fields`	(optional) Specifies the fields to return in a custom property summary response. Allowed values are: 'key', 'displayName', 'description', 'dataType', 'namespaceName', 'lifecycleState', 'timeCreated'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending Allowed values are: 'DISPLAYNAME', 'USAGECOUNT'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ASSET_TAGS Function

Returns a list of all tags for a data asset.

Syntax

FUNCTION list_data_asset_tags (
  catalog_id varchar2,
  data_asset_key varchar2,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  term_key varchar2 DEFAULT NULL,
  term_path varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_data_asset_tags_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`name`	(optional) Immutable resource name.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`term_key`	(optional) Unique key of the related term.
`term_path`	(optional) Path of the related term.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`fields`	(optional) Specifies the fields to return in a data asset tag summary response. Allowed values are: 'key', 'name', 'termKey', 'termPath', 'termDescription', 'lifecycleState', 'timeCreated', 'uri', 'glossaryKey', 'dataAssetKey'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Returns a list of data assets within a data catalog.

Syntax

FUNCTION list_data_assets (
  catalog_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  external_key varchar2 DEFAULT NULL,
  type_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_data_assets_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`external_key`	(optional) Unique external identifier of this resource in the external source system.
`type_key`	(optional) The key of the object type.
`fields`	(optional) Specifies the fields to return in a data asset summary response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'externalKey', 'typeKey', 'lifecycleState', 'timeCreated', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_DERIVED_LOGICAL_ENTITIES Function

List logical entities derived from this pattern.

Syntax

FUNCTION list_derived_logical_entities (
  catalog_id varchar2,
  pattern_key varchar2,
  display_name_contains varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  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_dc_data_catalog_list_derived_logical_entities_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`pattern_key`	(required) Unique pattern key.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ENTITIES Function

Returns a list of all entities of a data asset.

Syntax

FUNCTION list_entities (
  catalog_id varchar2,
  data_asset_key varchar2,
  display_name varchar2 DEFAULT NULL,
  business_name varchar2 DEFAULT NULL,
  display_or_business_name_contains varchar2 DEFAULT NULL,
  type_key varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  external_key varchar2 DEFAULT NULL,
  pattern_key varchar2 DEFAULT NULL,
  time_external timestamp with time zone DEFAULT NULL,
  time_status_updated timestamp with time zone DEFAULT NULL,
  is_logical number DEFAULT NULL,
  is_partition number DEFAULT NULL,
  folder_key varchar2 DEFAULT NULL,
  path varchar2 DEFAULT NULL,
  harvest_status varchar2 DEFAULT NULL,
  last_job_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_entities_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`business_name`	(optional) A filter to return only resources that match the entire business name given. The match is not case sensitive.
`display_or_business_name_contains`	(optional) A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`type_key`	(optional) The key of the object type.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`external_key`	(optional) Unique external identifier of this resource in the external source system.
`pattern_key`	(optional) Unique pattern key.
`time_external`	(optional) Last modified timestamp of this object in the external system.
`time_status_updated`	(optional) Time that the resource's status was last updated. An RFC3339 formatted datetime string.
`is_logical`	(optional) Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
`is_partition`	(optional) Identifies if an object is a sub object (partition) of a physical or materialized parent object.
`folder_key`	(optional) Key of the associated folder.
`path`	(optional) Full path of the resource for resources that support paths.
`harvest_status`	(optional) Harvest status of the harvestable resource as updated by the harvest process. Allowed values are: 'COMPLETE', 'ERROR', 'IN_PROGRESS', 'DEFERRED'
`last_job_key`	(optional) Key of the last harvest process to update this resource.
`fields`	(optional) Specifies the fields to return in an entity summary response. Allowed values are: 'key', 'displayName', 'description', 'dataAssetKey', 'timeCreated', 'timeUpdated', 'updatedById', 'lifecycleState', 'folderKey', 'folderName', 'externalKey', 'path', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME', 'DISPLAYORBUSINESSNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ENTITY_TAGS Function

Returns a list of all tags for a data entity.

Syntax

FUNCTION list_entity_tags (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  term_key varchar2 DEFAULT NULL,
  term_path varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_entity_tags_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`name`	(optional) Immutable resource name.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`term_key`	(optional) Unique key of the related term.
`term_path`	(optional) Path of the related term.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`fields`	(optional) Specifies the fields to return in an entity tag summary response. Allowed values are: 'key', 'name', 'termKey', 'termPath', 'termDescription', 'lifecycleState', 'timeCreated', 'uri', 'glossaryKey', 'entityKey'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_FOLDER_TAGS Function

Returns a list of all tags for a folder.

Syntax

FUNCTION list_folder_tags (
  catalog_id varchar2,
  data_asset_key varchar2,
  folder_key varchar2,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  term_key varchar2 DEFAULT NULL,
  term_path varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_folder_tags_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`folder_key`	(required) Unique folder key.
`name`	(optional) Immutable resource name.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`term_key`	(optional) Unique key of the related term.
`term_path`	(optional) Path of the related term.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`fields`	(optional) Specifies the fields to return in a folder tag summary response. Allowed values are: 'key', 'name', 'termKey', 'termPath', 'termDescription', 'lifecycleState', 'timeCreated', 'uri', 'glossaryKey', 'folderKey'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

Returns a list of all folders.

Syntax

FUNCTION list_folders (
  catalog_id varchar2,
  data_asset_key varchar2,
  display_name varchar2 DEFAULT NULL,
  business_name varchar2 DEFAULT NULL,
  display_or_business_name_contains varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  parent_folder_key varchar2 DEFAULT NULL,
  path varchar2 DEFAULT NULL,
  external_key varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  harvest_status varchar2 DEFAULT NULL,
  last_job_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  type_key varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_folders_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`business_name`	(optional) A filter to return only resources that match the entire business name given. The match is not case sensitive.
`display_or_business_name_contains`	(optional) A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`parent_folder_key`	(optional) Unique folder key.
`path`	(optional) Full path of the resource for resources that support paths.
`external_key`	(optional) Unique external identifier of this resource in the external source system.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`harvest_status`	(optional) Harvest status of the harvestable resource as updated by the harvest process. Allowed values are: 'COMPLETE', 'ERROR', 'IN_PROGRESS', 'DEFERRED'
`last_job_key`	(optional) Key of the last harvest process to update this resource.
`fields`	(optional) Specifies the fields to return in a folder summary response. Allowed values are: 'key', 'displayName', 'description', 'parentFolderKey', 'path', 'dataAssetKey', 'externalKey', 'timeExternal', 'timeCreated', 'lifecycleState', 'uri'
`type_key`	(optional) The key of the object type.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME', 'DISPLAYORBUSINESSNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_GLOSSARIES Function

Returns a list of all glossaries within a data catalog.

Syntax

FUNCTION list_glossaries (
  catalog_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_glossaries_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`fields`	(optional) Specifies the fields to return in a glossary summary response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'lifecycleState', 'timeCreated', 'uri', 'workflowStatus'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_DEFINITIONS Function

Returns a list of job definitions within a data catalog.

Syntax

FUNCTION list_job_definitions (
  catalog_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  job_execution_state varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  job_type varchar2 DEFAULT NULL,
  is_incremental number DEFAULT NULL,
  data_asset_key varchar2 DEFAULT NULL,
  glossary_key varchar2 DEFAULT NULL,
  connection_key varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  sample_data_size_in_m_bs varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_job_definitions_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`job_execution_state`	(optional) Job execution state. Allowed values are: 'CREATED', 'IN_PROGRESS', 'INACTIVE', 'FAILED', 'SUCCEEDED', 'CANCELED', 'SUCCEEDED_WITH_WARNINGS'
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`job_type`	(optional) Job type. Allowed values are: 'HARVEST', 'PROFILING', 'SAMPLING', 'PREVIEW', 'IMPORT', 'EXPORT', 'IMPORT_GLOSSARY', 'EXPORT_GLOSSARY', 'INTERNAL', 'PURGE', 'IMMEDIATE', 'SCHEDULED', 'IMMEDIATE_EXECUTION', 'SCHEDULED_EXECUTION', 'SCHEDULED_EXECUTION_INSTANCE', 'ASYNC_DELETE', 'IMPORT_DATA_ASSET', 'CREATE_SCAN_PROXY', 'ASYNC_EXPORT_GLOSSARY'
`is_incremental`	(optional) Whether job definition is an incremental harvest (true) or a full harvest (false).
`data_asset_key`	(optional) Unique data asset key.
`glossary_key`	(optional) Unique glossary key.
`connection_key`	(optional) Unique connection key.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`sample_data_size_in_m_bs`	(optional) The sample data size in MB, specified as number of rows, for a metadata harvest.
`fields`	(optional) Specifies the fields to return in a job definition summary response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'jobType', 'connectionKey', 'lifecycleState', 'timeCreated', 'isSampleDataExtracted', 'uri', 'timeLatestExecutionStarted', 'timeLatestExecutionEnded', 'jobExecutionState', 'scheduleType'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. Default order for TIMELATESTEXECUTIONSTARTED is descending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME', 'TIMELATESTEXECUTIONSTARTED'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_EXECUTIONS Function

Returns a list of job executions for a job.

Syntax

FUNCTION list_job_executions (
  catalog_id varchar2,
  job_key varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  job_type varchar2 DEFAULT NULL,
  sub_type varchar2 DEFAULT NULL,
  parent_key varchar2 DEFAULT NULL,
  time_start timestamp with time zone DEFAULT NULL,
  time_end timestamp with time zone DEFAULT NULL,
  error_code varchar2 DEFAULT NULL,
  error_message varchar2 DEFAULT NULL,
  process_key varchar2 DEFAULT NULL,
  external_url varchar2 DEFAULT NULL,
  event_key varchar2 DEFAULT NULL,
  data_entity_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_job_executions_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`lifecycle_state`	(optional) Job execution lifecycle state. Allowed values are: 'CREATED', 'IN_PROGRESS', 'INACTIVE', 'FAILED', 'SUCCEEDED', 'CANCELED', 'SUCCEEDED_WITH_WARNINGS'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`job_type`	(optional) Job type. Allowed values are: 'HARVEST', 'PROFILING', 'SAMPLING', 'PREVIEW', 'IMPORT', 'EXPORT', 'IMPORT_GLOSSARY', 'EXPORT_GLOSSARY', 'INTERNAL', 'PURGE', 'IMMEDIATE', 'SCHEDULED', 'IMMEDIATE_EXECUTION', 'SCHEDULED_EXECUTION', 'SCHEDULED_EXECUTION_INSTANCE', 'ASYNC_DELETE', 'IMPORT_DATA_ASSET', 'CREATE_SCAN_PROXY', 'ASYNC_EXPORT_GLOSSARY'
`sub_type`	(optional) Sub-type of this job execution.
`parent_key`	(optional) The unique key of the parent execution or null if this job execution has no parent.
`time_start`	(optional) Time that the job execution was started or in the case of a future time, the time when the job will start. An RFC3339 formatted datetime string.
`time_end`	(optional) Time that the job execution ended or null if the job is still running or hasn't run yet. An RFC3339 formatted datetime string.
`error_code`	(optional) Error code returned from the job execution or null if job is still running or didn't return an error.
`error_message`	(optional) Error message returned from the job execution or null if job is still running or didn't return an error.
`process_key`	(optional) Process identifier related to the job execution.
`external_url`	(optional) The a URL of the job for accessing this resource and its status.
`event_key`	(optional) Event that triggered the execution of this job or null.
`data_entity_key`	(optional) Unique entity key.
`fields`	(optional) Specifies the fields to return in a job execution summary response. Allowed values are: 'key', 'jobKey', 'jobType', 'parentKey', 'scheduleInstanceKey', 'lifecycleState', 'timeCreated', 'timeStarted', 'timeEnded', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order. Allowed values are: 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_LOGS Function

Returns a list of job logs.

Syntax

FUNCTION list_job_logs (
  catalog_id varchar2,
  job_key varchar2,
  job_execution_key varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  severity varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_job_logs_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`job_execution_key`	(required) The key of the job execution.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`severity`	(optional) Severity level for this Log.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`fields`	(optional) Specifies the fields to return in a job log summary response. Allowed values are: 'key', 'jobExecutionKey', 'severity', 'timeCreated', 'logMessage', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_METRICS Function

Returns a list of job metrics.

Syntax

FUNCTION list_job_metrics (
  catalog_id varchar2,
  job_key varchar2,
  job_execution_key varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  category varchar2 DEFAULT NULL,
  sub_category varchar2 DEFAULT NULL,
  unit varchar2 DEFAULT NULL,
  value varchar2 DEFAULT NULL,
  batch_key varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  time_inserted timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_job_metrics_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`job_execution_key`	(required) The key of the job execution.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`category`	(optional) Category of this metric.
`sub_category`	(optional) Sub category of this metric under the category. Used for aggregating values. May be null.
`unit`	(optional) Unit of this metric.
`value`	(optional) Value of this metric.
`batch_key`	(optional) Batch key for grouping, may be null.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`time_inserted`	(optional) The time the metric was logged or captured in the system where the job executed. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`fields`	(optional) Specifies the fields to return in a job metric summary response. Allowed values are: 'key', 'description', 'displayName', 'timeInserted', 'category', 'subCategory', 'unit', 'value', 'batchKey', 'jobExecutionKey', 'timeCreated', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOBS Function

Returns a list of jobs within a data catalog.

Syntax

FUNCTION list_jobs (
  catalog_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  job_type varchar2 DEFAULT NULL,
  job_definition_key varchar2 DEFAULT NULL,
  data_asset_key varchar2 DEFAULT NULL,
  glossary_key varchar2 DEFAULT NULL,
  schedule_cron_expression varchar2 DEFAULT NULL,
  time_schedule_begin timestamp with time zone DEFAULT NULL,
  time_schedule_end timestamp with time zone DEFAULT NULL,
  schedule_type varchar2 DEFAULT NULL,
  connection_key varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  execution_count number DEFAULT NULL,
  time_of_latest_execution timestamp with time zone DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_jobs_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) Job lifecycle state. Allowed values are: 'ACTIVE', 'INACTIVE', 'EXPIRED'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`job_type`	(optional) Job type. Allowed values are: 'HARVEST', 'PROFILING', 'SAMPLING', 'PREVIEW', 'IMPORT', 'EXPORT', 'IMPORT_GLOSSARY', 'EXPORT_GLOSSARY', 'INTERNAL', 'PURGE', 'IMMEDIATE', 'SCHEDULED', 'IMMEDIATE_EXECUTION', 'SCHEDULED_EXECUTION', 'SCHEDULED_EXECUTION_INSTANCE', 'ASYNC_DELETE', 'IMPORT_DATA_ASSET', 'CREATE_SCAN_PROXY', 'ASYNC_EXPORT_GLOSSARY'
`job_definition_key`	(optional) Unique job definition key.
`data_asset_key`	(optional) Unique data asset key.
`glossary_key`	(optional) Unique glossary key.
`schedule_cron_expression`	(optional) Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.
`time_schedule_begin`	(optional) Date that the schedule should be operational. An RFC3339 formatted datetime string.
`time_schedule_end`	(optional) Date that the schedule should end from being operational. An RFC3339 formatted datetime string.
`schedule_type`	(optional) Type of the job schedule. Allowed values are: 'SCHEDULED', 'IMMEDIATE'
`connection_key`	(optional) Unique connection key.
`fields`	(optional) Specifies the fields to return in a job summary response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'jobDefinitionKey', 'lifecycleState', 'timeCreated', 'timeUpdated', 'createdById', 'updatedById', 'jobType', 'scheduleCronExpression', 'timeScheduleBegin', 'scheduleType', 'executionCount', 'timeOfLatestExecution', 'executions', 'uri', 'jobDefinitionName', 'errorCode', 'errorMessage'
`execution_count`	(optional) The total number of executions for this job schedule.
`time_of_latest_execution`	(optional) The date and time the most recent execution for this job ,in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_METASTORES Function

Returns a list of all metastores in the specified compartment.

Syntax

FUNCTION list_metastores (
  compartment_id varchar2,
  display_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_dc_data_catalog_list_metastores_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment where you want to list resources.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_NAMESPACES Function

Returns a list of namespaces within a data catalog.

Syntax

FUNCTION list_namespaces (
  catalog_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_namespaces_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`fields`	(optional) Specifies the fields to return in a namespace summary response. Allowed values are: 'key', 'displayName', 'description', 'lifecycleState', 'timeCreated'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_PATTERNS Function

Returns a list of patterns within a data catalog.

Syntax

FUNCTION list_patterns (
  catalog_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_patterns_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`fields`	(optional) Specifies the fields to return in a pattern summary response. Allowed values are: 'key', 'displayName', 'description', 'catalogId', 'expression', 'lifecycleState', 'timeCreated'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_RULES Function

Returns a list of all rules of a data entity.

Syntax

FUNCTION list_rules (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  rule_type varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  origin_type varchar2 DEFAULT NULL,
  external_key varchar2 DEFAULT NULL,
  time_created timestamp with time zone DEFAULT NULL,
  time_updated timestamp with time zone DEFAULT NULL,
  created_by_id varchar2 DEFAULT NULL,
  updated_by_id varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_rules_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`rule_type`	(optional) Rule type used to filter the response to a list rules call. Allowed values are: 'PRIMARYKEY', 'FOREIGNKEY', 'UNIQUEKEY'
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`origin_type`	(optional) Rule origin type used to filter the response to a list rules call. Allowed values are: 'SOURCE', 'USER', 'PROFILING'
`external_key`	(optional) Unique external identifier of this resource in the external source system.
`time_created`	(optional) Time that the resource was created. An RFC3339 formatted datetime string.
`time_updated`	(optional) Time that the resource was updated. An RFC3339 formatted datetime string.
`created_by_id`	(optional) OCID of the user who created the resource.
`updated_by_id`	(optional) OCID of the user who updated the resource.
`fields`	(optional) Specifies the fields to return in a rule summary response. Allowed values are: 'key', 'displayName', 'ruleType', 'externalKey', 'referencedFolderKey', 'referencedFolderName', 'referencedEntityKey', 'referencedEntityName', 'referencedRuleKey', 'referencedRuleName', 'originType', 'lifecycleState', 'timeCreated', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TAGS Function

Returns a list of all user created tags in the system.

Syntax

FUNCTION list_tags (
  catalog_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_tags_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`fields`	(optional) Specifies the fields to return in a term summary response. Allowed values are: 'key', 'displayName', 'description', 'glossaryKey', 'parentTermKey', 'isAllowedToHaveChildTerms', 'path', 'lifecycleState', 'timeCreated', 'workflowStatus', 'associatedObjectCount', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM_RELATIONSHIPS Function

Returns a list of all term relationships within a glossary.

Syntax

FUNCTION list_term_relationships (
  catalog_id varchar2,
  glossary_key varchar2,
  term_key varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_term_relationships_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`term_key`	(required) Unique glossary term key.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`fields`	(optional) Specifies the fields to return in a term relationship summary response. Allowed values are: 'key', 'displayName', 'description', 'relatedTermKey', 'relatedTermDisplayName', 'parentTermKey', 'parentTermDisplayName', 'lifecycleState', 'timeCreated', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERMS Function

Returns a list of all terms within a glossary.

Syntax

FUNCTION list_terms (
  catalog_id varchar2,
  glossary_key varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  parent_term_key varchar2 DEFAULT NULL,
  is_allowed_to_have_child_terms number DEFAULT NULL,
  workflow_status varchar2 DEFAULT NULL,
  path varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_terms_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`display_name_contains`	(optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`parent_term_key`	(optional) Unique key of the parent term.
`is_allowed_to_have_child_terms`	(optional) Indicates whether a term may contain child terms.
`workflow_status`	(optional) Status of the approval workflow for this business term in the glossary. Allowed values are: 'NEW', 'APPROVED', 'UNDER_REVIEW', 'ESCALATED'
`path`	(optional) Full path of the resource for resources that support paths.
`fields`	(optional) Specifies the fields to return in a term summary response. Allowed values are: 'key', 'displayName', 'description', 'glossaryKey', 'parentTermKey', 'isAllowedToHaveChildTerms', 'path', 'lifecycleState', 'timeCreated', 'workflowStatus', 'associatedObjectCount', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TYPES Function

Returns a list of all types within a data catalog.

Syntax

FUNCTION list_types (
  catalog_id varchar2,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  is_internal varchar2 DEFAULT NULL,
  is_tag varchar2 DEFAULT NULL,
  is_approved varchar2 DEFAULT NULL,
  external_type_name varchar2 DEFAULT NULL,
  type_category varchar2 DEFAULT NULL,
  fields dbms_cloud_oci_datacatalog_varchar2_tbl DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_list_types_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`name`	(optional) Immutable resource name.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`is_internal`	(optional) Indicates whether the type is internal, making it unavailable for use by metadata elements.
`is_tag`	(optional) Indicates whether the type can be used for tagging metadata elements.
`is_approved`	(optional) Indicates whether the type is approved for use as a classifying object.
`external_type_name`	(optional) Data type as defined in an external system.
`type_category`	(optional) Indicates the category of this type . For example, data assets or connections.
`fields`	(optional) Specifies the fields to return in a type summary response. Allowed values are: 'key', 'description', 'name', 'catalogId', 'lifecycleState', 'typeCategory', 'uri'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

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

Syntax

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

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for CODE and MESSAGE is ascending. If no value is specified TIMESTAMP is default. Allowed values are: 'CODE', 'TIMESTAMP'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

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

Syntax

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

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for MESSAGE is ascending. If no value is specified TIMESTAMP is default. Allowed values are: 'MESSAGE', 'TIMESTAMP'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment where you want to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

OBJECT_STATS Function

Returns stats on objects by type in the repository.

Syntax

FUNCTION object_stats (
  catalog_id varchar2,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_object_stats_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

PARSE_CONNECTION Function

Parse data asset references through connections from this data asset.

Syntax

FUNCTION parse_connection (
  catalog_id varchar2,
  data_asset_key varchar2,
  parse_connection_details dbms_cloud_oci_datacatalog_parse_connection_details_t,
  connection_key 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_dc_data_catalog_parse_connection_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`parse_connection_details`	(required) The information used to parse the connections from payload or connection detail.
`connection_key`	(optional) Unique connection key.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

PROCESS_RECOMMENDATION Function

Act on a recommendation. A recommendation can be accepted or rejected. For example, if a recommendation of type LINK_GLOSSARY_TERM is accepted, the system will link the source object (e.g. an attribute) to a target glossary term.

Syntax

FUNCTION process_recommendation (
  catalog_id varchar2,
  process_recommendation_details dbms_cloud_oci_datacatalog_process_recommendation_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_dc_data_catalog_process_recommendation_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`process_recommendation_details`	(required) Recommendation to be processed.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

RECOMMENDATIONS Function

Returns a list of recommendations for the given object and recommendation type. By default, it will return inferred recommendations for review. The optional query param 'RecommendationStatus' can be set, to return only recommendations having that status.

Syntax

FUNCTION recommendations (
  catalog_id varchar2,
  recommendation_type dbms_cloud_oci_datacatalog_varchar2_tbl,
  source_object_key varchar2,
  source_object_type varchar2,
  recommendation_status 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_dc_data_catalog_recommendations_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`recommendation_type`	(required) A filter used to return only recommendations of the specified type. Allowed values are: 'LINK_GLOSSARY_TERM'
`source_object_key`	(required) A filter used to provide the unique identifier of the source object, for which a list of recommendations will be returned for review.
`source_object_type`	(required) A filter used to provide the type of the source object, for which a list of recommendations will be returned for review. Allowed values are: 'DATA_ENTITY', 'ATTRIBUTE', 'TERM', 'CATEGORY'
`recommendation_status`	(optional) A filter used to return only recommendations having the requested status. Allowed values are: 'ACCEPTED', 'REJECTED', 'INFERRED'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

REMOVE_CATALOG_LOCK Function

Removes a lock from a Catalog resource.

Syntax

FUNCTION remove_catalog_lock (
  catalog_id varchar2,
  remove_resource_lock_details dbms_cloud_oci_datacatalog_remove_resource_lock_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_dc_data_catalog_remove_catalog_lock_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`remove_resource_lock_details`	(required) RemoveResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

REMOVE_CATALOG_PRIVATE_ENDPOINT_LOCK Function

Removes a lock from a CatalogPrivateEndpoint resource.

Syntax

FUNCTION remove_catalog_private_endpoint_lock (
  catalog_private_endpoint_id varchar2,
  remove_resource_lock_details dbms_cloud_oci_datacatalog_remove_resource_lock_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_dc_data_catalog_remove_catalog_private_endpoint_lock_response_t;

Parameters

Parameter	Description
`catalog_private_endpoint_id`	(required) Unique private reverse connection identifier.
`remove_resource_lock_details`	(required) RemoveResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

REMOVE_DATA_SELECTOR_PATTERNS Function

Remove data selector pattern from the data asset.

Syntax

FUNCTION remove_data_selector_patterns (
  catalog_id varchar2,
  data_asset_key varchar2,
  data_selector_pattern_details dbms_cloud_oci_datacatalog_data_selector_pattern_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_dc_data_catalog_remove_data_selector_patterns_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`data_selector_pattern_details`	(required) The information used to remove the data selector patterns.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

REMOVE_METASTORE_LOCK Function

Removes a lock from a Metastore resource.

Syntax

FUNCTION remove_metastore_lock (
  metastore_id varchar2,
  remove_resource_lock_details dbms_cloud_oci_datacatalog_remove_resource_lock_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_dc_data_catalog_remove_metastore_lock_response_t;

Parameters

Parameter	Description
`metastore_id`	(required) The metastore's OCID.
`remove_resource_lock_details`	(required) RemoveResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

SEARCH_CRITERIA Function

Returns a list of search results within a data catalog.

Syntax

FUNCTION search_criteria (
  catalog_id varchar2,
  search_criteria_details dbms_cloud_oci_datacatalog_search_criteria_t DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  timeout varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_search_criteria_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`search_criteria_details`	(optional) The information used to create an extended search results.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`name`	(optional) Immutable resource name.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'MOVING'
`timeout`	(optional) A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

SUGGEST_MATCHES Function

Returns a list of potential string matches for a given input string.

Syntax

FUNCTION suggest_matches (
  catalog_id varchar2,
  input_text varchar2,
  timeout varchar2 DEFAULT NULL,
  limit number 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_dc_data_catalog_suggest_matches_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`input_text`	(required) Text input string used for computing potential matching suggestions.
`timeout`	(optional) A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
`limit`	(optional) Limit for the list of potential matches returned from the Suggest API. If not specified, will default to 10.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

SYNCHRONOUS_EXPORT_DATA_ASSET Function

Export technical objects from a Data Asset

Syntax

FUNCTION synchronous_export_data_asset (
  catalog_id varchar2,
  data_asset_key varchar2,
  synchronous_export_data_asset_details dbms_cloud_oci_datacatalog_export_data_asset_details_t,
  export_type dbms_cloud_oci_datacatalog_varchar2_tbl,
  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_dc_data_catalog_synchronous_export_data_asset_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`synchronous_export_data_asset_details`	(required) The details of what needs to be exported.
`export_type`	(required) Type of export. Allowed values are: 'CUSTOM_PROPERTY_VALUES', 'ALL'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

TEST_CONNECTION Function

Test the connection by connecting to the data asset using credentials in the metadata.

Syntax

FUNCTION test_connection (
  catalog_id varchar2,
  data_asset_key varchar2,
  connection_key varchar2,
  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_dc_data_catalog_test_connection_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`connection_key`	(required) Unique connection key.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ATTRIBUTE Function

Updates a specific data asset attribute.

Syntax

FUNCTION update_attribute (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  attribute_key varchar2,
  update_attribute_details dbms_cloud_oci_datacatalog_update_attribute_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_dc_data_catalog_update_attribute_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`attribute_key`	(required) Unique attribute key.
`update_attribute_details`	(required) The information to be updated in the attribute.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CATALOG Function

Updates the data catalog.

Syntax

FUNCTION update_catalog (
  catalog_id varchar2,
  update_catalog_details dbms_cloud_oci_datacatalog_update_catalog_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_update_catalog_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`update_catalog_details`	(required) The data catalog information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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_CATALOG_PRIVATE_ENDPOINT Function

Updates the private reverse connection endpoint.

Syntax

FUNCTION update_catalog_private_endpoint (
  catalog_private_endpoint_id varchar2,
  update_catalog_private_endpoint_details dbms_cloud_oci_datacatalog_update_catalog_private_endpoint_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_update_catalog_private_endpoint_response_t;

Parameters

Parameter	Description
`catalog_private_endpoint_id`	(required) Unique private reverse connection identifier.
`update_catalog_private_endpoint_details`	(required) The information to be updated in private reverse connection
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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 specific connection of a data asset.

Syntax

FUNCTION update_connection (
  catalog_id varchar2,
  data_asset_key varchar2,
  connection_key varchar2,
  update_connection_details dbms_cloud_oci_datacatalog_update_connection_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_dc_data_catalog_update_connection_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`connection_key`	(required) Unique connection key.
`update_connection_details`	(required) The information to be updated in the connection.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_CUSTOM_PROPERTY Function

Updates a specific custom property identified by the given key.

Syntax

FUNCTION update_custom_property (
  catalog_id varchar2,
  namespace_id varchar2,
  custom_property_key varchar2,
  update_custom_property_details dbms_cloud_oci_datacatalog_update_custom_property_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_dc_data_catalog_update_custom_property_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`namespace_id`	(required) Unique namespace identifier.
`custom_property_key`	(required) Unique Custom Property key
`update_custom_property_details`	(required) The information to be updated in the custom property.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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 identified by the given key.

Syntax

FUNCTION update_data_asset (
  catalog_id varchar2,
  data_asset_key varchar2,
  update_data_asset_details dbms_cloud_oci_datacatalog_update_data_asset_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_dc_data_catalog_update_data_asset_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`update_data_asset_details`	(required) The information to be updated in the data asset.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_ENTITY Function

Updates a specific data entity.

Syntax

FUNCTION update_entity (
  catalog_id varchar2,
  data_asset_key varchar2,
  entity_key varchar2,
  update_entity_details dbms_cloud_oci_datacatalog_update_entity_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_dc_data_catalog_update_entity_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`entity_key`	(required) Unique entity key.
`update_entity_details`	(required) The information to be updated in the data entity.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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 of a data asset.

Syntax

FUNCTION update_folder (
  catalog_id varchar2,
  data_asset_key varchar2,
  folder_key varchar2,
  update_folder_details dbms_cloud_oci_datacatalog_update_folder_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_dc_data_catalog_update_folder_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`folder_key`	(required) Unique folder key.
`update_folder_details`	(required) The information to be updated in the folder.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_GLOSSARY Function

Updates a specific glossary identified by the given key.

Syntax

FUNCTION update_glossary (
  catalog_id varchar2,
  glossary_key varchar2,
  update_glossary_details dbms_cloud_oci_datacatalog_update_glossary_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_dc_data_catalog_update_glossary_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`update_glossary_details`	(required) The information to be updated in the glossary.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB Function

Updates a specific job identified by the given key.

Syntax

FUNCTION update_job (
  catalog_id varchar2,
  job_key varchar2,
  update_job_details dbms_cloud_oci_datacatalog_update_job_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_dc_data_catalog_update_job_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_key`	(required) Unique job key.
`update_job_details`	(required) The information to be updated in the job.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_JOB_DEFINITION Function

Update a specific job definition identified by the given key.

Syntax

FUNCTION update_job_definition (
  catalog_id varchar2,
  job_definition_key varchar2,
  update_job_definition_details dbms_cloud_oci_datacatalog_update_job_definition_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_dc_data_catalog_update_job_definition_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`job_definition_key`	(required) Unique job definition key.
`update_job_definition_details`	(required) The information to be updated in the job definition.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_METASTORE Function

Updates a metastore resource by identifier.

Syntax

FUNCTION update_metastore (
  metastore_id varchar2,
  update_metastore_details dbms_cloud_oci_datacatalog_update_metastore_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dc_data_catalog_update_metastore_response_t;

Parameters

Parameter	Description
`metastore_id`	(required) The metastore's OCID.
`update_metastore_details`	(required) The metastore information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://datacatalog.{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_NAMESPACE Function

Updates a specific namespace identified by the given key.

Syntax

FUNCTION update_namespace (
  catalog_id varchar2,
  namespace_id varchar2,
  update_namespace_details dbms_cloud_oci_datacatalog_update_namespace_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_dc_data_catalog_update_namespace_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`namespace_id`	(required) Unique namespace identifier.
`update_namespace_details`	(required) The information to be updated in the namespace.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_PATTERN Function

Updates a specific pattern identified by the given key.

Syntax

FUNCTION update_pattern (
  catalog_id varchar2,
  pattern_key varchar2,
  update_pattern_details dbms_cloud_oci_datacatalog_update_pattern_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_dc_data_catalog_update_pattern_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`pattern_key`	(required) Unique pattern key.
`update_pattern_details`	(required) The information to be updated in the pattern.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM Function

Updates a specific glossary term.

Syntax

FUNCTION update_term (
  catalog_id varchar2,
  glossary_key varchar2,
  term_key varchar2,
  update_term_details dbms_cloud_oci_datacatalog_update_term_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_dc_data_catalog_update_term_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`term_key`	(required) Unique glossary term key.
`update_term_details`	(required) The information to be updated in the term.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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_TERM_RELATIONSHIP Function

Updates a specific glossary term relationship.

Syntax

FUNCTION update_term_relationship (
  catalog_id varchar2,
  glossary_key varchar2,
  term_key varchar2,
  term_relationship_key varchar2,
  update_term_relationship_details dbms_cloud_oci_datacatalog_update_term_relationship_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_dc_data_catalog_update_term_relationship_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`glossary_key`	(required) Unique glossary key.
`term_key`	(required) Unique glossary term key.
`term_relationship_key`	(required) Unique glossary term relationship key.
`update_term_relationship_details`	(required) The information to be updated in the term relationship.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

UPLOAD_CREDENTIALS Function

Upload connection credentails and metadata for this connection.

Syntax

FUNCTION upload_credentials (
  catalog_id varchar2,
  data_asset_key varchar2,
  connection_key varchar2,
  upload_credentials_details dbms_cloud_oci_datacatalog_upload_credentials_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_dc_data_catalog_upload_credentials_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`connection_key`	(required) Unique connection key.
`upload_credentials_details`	(required) The information used to upload the credentials file and metadata for updating this connection.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

USERS Function

Returns active users in the system.

Syntax

FUNCTION users (
  catalog_id varchar2,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_dc_data_catalog_users_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

VALIDATE_CONNECTION Function

Validate connection by connecting to the data asset using credentials in metadata.

Syntax

FUNCTION validate_connection (
  catalog_id varchar2,
  data_asset_key varchar2,
  validate_connection_details dbms_cloud_oci_datacatalog_validate_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_dc_data_catalog_validate_connection_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`data_asset_key`	(required) Unique data asset key.
`validate_connection_details`	(required) The information used to validate the connections.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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.

VALIDATE_PATTERN Function

Validate pattern by deriving file groups representing logical entities using the expression

Syntax

FUNCTION validate_pattern (
  catalog_id varchar2,
  pattern_key varchar2,
  validate_pattern_details dbms_cloud_oci_datacatalog_validate_pattern_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_dc_data_catalog_validate_pattern_response_t;

Parameters

Parameter	Description
`catalog_id`	(required) Unique catalog identifier.
`pattern_key`	(required) Unique pattern key.
`validate_pattern_details`	(required) The information used to validate the pattern.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datacatalog.{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

ADD_CATALOG_LOCK Function 🔗

ADD_CATALOG_PRIVATE_ENDPOINT_LOCK Function 🔗

ADD_DATA_SELECTOR_PATTERNS Function 🔗

ADD_METASTORE_LOCK Function 🔗

ASSOCIATE_CUSTOM_PROPERTY Function 🔗

ASYNCHRONOUS_EXPORT_GLOSSARY Function 🔗

ATTACH_CATALOG_PRIVATE_ENDPOINT Function 🔗

CHANGE_CATALOG_COMPARTMENT Function 🔗

CHANGE_CATALOG_PRIVATE_ENDPOINT_COMPARTMENT Function 🔗

CHANGE_METASTORE_COMPARTMENT Function 🔗

CREATE_ATTRIBUTE Function 🔗

CREATE_ATTRIBUTE_TAG Function 🔗

CREATE_CATALOG Function 🔗

CREATE_CATALOG_PRIVATE_ENDPOINT Function 🔗

CREATE_CONNECTION Function 🔗

CREATE_CUSTOM_PROPERTY Function 🔗

CREATE_DATA_ASSET Function 🔗

CREATE_DATA_ASSET_TAG Function 🔗

CREATE_ENTITY Function 🔗

CREATE_ENTITY_TAG Function 🔗

CREATE_FOLDER Function 🔗

CREATE_FOLDER_TAG Function 🔗

CREATE_GLOSSARY Function 🔗

CREATE_JOB Function 🔗

CREATE_JOB_DEFINITION Function 🔗

CREATE_JOB_EXECUTION Function 🔗

CREATE_METASTORE Function 🔗

CREATE_NAMESPACE Function 🔗

CREATE_PATTERN Function 🔗

CREATE_TERM Function 🔗

CREATE_TERM_RELATIONSHIP Function 🔗

DELETE_ATTRIBUTE Function 🔗

DELETE_ATTRIBUTE_TAG Function 🔗

DELETE_CATALOG Function 🔗

DELETE_CATALOG_PRIVATE_ENDPOINT Function 🔗

DELETE_CONNECTION Function 🔗

DELETE_CUSTOM_PROPERTY Function 🔗

DELETE_DATA_ASSET Function 🔗

DELETE_DATA_ASSET_TAG Function 🔗

DELETE_ENTITY Function 🔗

DELETE_ENTITY_TAG Function 🔗

DELETE_FOLDER Function 🔗

DELETE_FOLDER_TAG Function 🔗

DELETE_GLOSSARY Function 🔗

DELETE_JOB Function 🔗

DELETE_JOB_DEFINITION Function 🔗

DELETE_METASTORE Function 🔗

DELETE_NAMESPACE Function 🔗

DELETE_PATTERN Function 🔗

DELETE_TERM Function 🔗

DELETE_TERM_RELATIONSHIP Function 🔗

DETACH_CATALOG_PRIVATE_ENDPOINT Function 🔗

DISASSOCIATE_CUSTOM_PROPERTY Function 🔗

EXPAND_TREE_FOR_GLOSSARY Function 🔗

EXPORT_GLOSSARY Function 🔗

FETCH_ENTITY_LINEAGE Function 🔗

GET_ATTRIBUTE Function 🔗

GET_ATTRIBUTE_TAG Function 🔗

GET_CATALOG Function 🔗

GET_CATALOG_PRIVATE_ENDPOINT Function 🔗

GET_CONNECTION Function 🔗

GET_CUSTOM_PROPERTY Function 🔗

GET_DATA_ASSET Function 🔗

GET_DATA_ASSET_TAG Function 🔗

GET_ENTITY Function 🔗

GET_ENTITY_TAG Function 🔗

GET_FOLDER Function 🔗

GET_FOLDER_TAG Function 🔗

GET_GLOSSARY Function 🔗

GET_JOB Function 🔗

GET_JOB_DEFINITION Function 🔗

GET_JOB_EXECUTION Function 🔗

GET_JOB_LOG Function 🔗

GET_JOB_METRICS Function 🔗

GET_METASTORE Function 🔗

GET_NAMESPACE Function 🔗

GET_PATTERN Function 🔗

GET_TERM Function 🔗

GET_TERM_RELATIONSHIP Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

ADD_CATALOG_LOCK Function

ADD_CATALOG_PRIVATE_ENDPOINT_LOCK Function

ADD_DATA_SELECTOR_PATTERNS Function

ADD_METASTORE_LOCK Function

ASSOCIATE_CUSTOM_PROPERTY Function

ASYNCHRONOUS_EXPORT_GLOSSARY Function

ATTACH_CATALOG_PRIVATE_ENDPOINT Function

CHANGE_CATALOG_COMPARTMENT Function

CHANGE_CATALOG_PRIVATE_ENDPOINT_COMPARTMENT Function

CHANGE_METASTORE_COMPARTMENT Function

CREATE_ATTRIBUTE Function

CREATE_ATTRIBUTE_TAG Function

CREATE_CATALOG Function

CREATE_CATALOG_PRIVATE_ENDPOINT Function

CREATE_CONNECTION Function

CREATE_CUSTOM_PROPERTY Function

CREATE_DATA_ASSET Function

CREATE_DATA_ASSET_TAG Function

CREATE_ENTITY Function

CREATE_ENTITY_TAG Function

CREATE_FOLDER Function

CREATE_FOLDER_TAG Function

CREATE_GLOSSARY Function

CREATE_JOB Function

CREATE_JOB_DEFINITION Function

CREATE_JOB_EXECUTION Function

CREATE_METASTORE Function

CREATE_NAMESPACE Function

CREATE_PATTERN Function

CREATE_TERM Function

CREATE_TERM_RELATIONSHIP Function

DELETE_ATTRIBUTE Function

DELETE_ATTRIBUTE_TAG Function

DELETE_CATALOG Function

DELETE_CATALOG_PRIVATE_ENDPOINT Function

DELETE_CONNECTION Function

DELETE_CUSTOM_PROPERTY Function

DELETE_DATA_ASSET Function

DELETE_DATA_ASSET_TAG Function

DELETE_ENTITY Function

DELETE_ENTITY_TAG Function

DELETE_FOLDER Function

DELETE_FOLDER_TAG Function

DELETE_GLOSSARY Function

DELETE_JOB Function

DELETE_JOB_DEFINITION Function

DELETE_METASTORE Function

DELETE_NAMESPACE Function

DELETE_PATTERN Function

DELETE_TERM Function

DELETE_TERM_RELATIONSHIP Function

DETACH_CATALOG_PRIVATE_ENDPOINT Function

DISASSOCIATE_CUSTOM_PROPERTY Function

EXPAND_TREE_FOR_GLOSSARY Function

EXPORT_GLOSSARY Function

FETCH_ENTITY_LINEAGE Function

GET_ATTRIBUTE Function

GET_ATTRIBUTE_TAG Function

GET_CATALOG Function

GET_CATALOG_PRIVATE_ENDPOINT Function

GET_CONNECTION Function

GET_CUSTOM_PROPERTY Function

GET_DATA_ASSET Function

GET_DATA_ASSET_TAG Function

GET_ENTITY Function

GET_ENTITY_TAG Function

GET_FOLDER Function

GET_FOLDER_TAG Function

GET_GLOSSARY Function

GET_JOB Function

GET_JOB_DEFINITION Function

GET_JOB_EXECUTION Function

GET_JOB_LOG Function

GET_JOB_METRICS Function

GET_METASTORE Function

GET_NAMESPACE Function

GET_PATTERN Function

GET_TERM Function

GET_TERM_RELATIONSHIP Function