Oracle

Oracle Data Catalog API

The dataCatalog API from Oracle — 86 operation(s) for datacatalog.

GitHub OpenAPI

Operations 143

GET /catalogPrivateEndpoints Lists all the catalog private endpoints in the specified compartment #
POST /catalogPrivateEndpoints Create a new private reverse connection endpoint. #
DELETE /catalogPrivateEndpoints/{catalogPrivateEndpointId} Delete a private reverse connection endpoint. #
GET /catalogPrivateEndpoints/{catalogPrivateEndpointId} Get private reverse connection endpoint. #
PUT /catalogPrivateEndpoints/{catalogPrivateEndpointId} Update the private reverse connection endpoint identified by the id. #
POST /catalogPrivateEndpoints/{catalogPrivateEndpointId}/actions/changeCompartment Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource. #
GET /catalogs Lists all the data catalogs in the specified compartment. #
POST /catalogs Creates a new data catalog. #
DELETE /catalogs/{catalogId} Delete a provisioned data catalog. #
GET /catalogs/{catalogId} Get data catalog. #
PUT /catalogs/{catalogId} Update the data catalog identified by the id. #
POST /catalogs/{catalogId}/actions/attachCatalogPrivateEndpoint Attaches a private reverse connection endpoint resource to a data catalog resource. #
POST /catalogs/{catalogId}/actions/changeCompartment Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource. #
POST /catalogs/{catalogId}/actions/detachCatalogPrivateEndpoint Detaches a private reverse connection endpoint resource to a data catalog resource. #
POST /catalogs/{catalogId}/actions/getRecommendations Returns a list of recommendations for the given object and recommendation type. #
POST /catalogs/{catalogId}/actions/objectStats Returns stats on objects in the repository. #
POST /catalogs/{catalogId}/actions/processRecommendation Act on a recommendation. #
POST /catalogs/{catalogId}/actions/suggest Returns a list of potential string matches for a given input string. #
POST /catalogs/{catalogId}/actions/users Returns active users in the system. #
GET /catalogs/{catalogId}/dataAssets Returns a list of data assets within a data catalog. #
POST /catalogs/{catalogId}/dataAssets Create a new data asset. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey} Delete a specific data asset identified by it's key. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey} Get a specific data asset for the given key within a data catalog. #
PUT /catalogs/{catalogId}/dataAssets/{dataAssetKey} Update a specific data asset identified by the given key. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/addDataSelectorPatterns Add data selector pattern to the data asset used to derive logical entities during harvesting. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/asynchronousExport Export technical objects from a Data Asset in Excel format. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/import Import technical objects to a Data Asset from an exported file. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/importConnection Import connections from an Oracle wallet file that contains relevant metadata for creating connections. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/importLineage Imports lineage metadata. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/parseConnection Parse connection from a request payload that contains data asset references. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/removeDataSelectorPatterns Remove data selector pattern from the data asset used in deriving logical entities during harvesting. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/synchronousExport Export technical objects from a Data Asset in Excel file format. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/validateConnection Validate connection from a request payload that contains connection metadata. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections Returns a list of all connections for a data asset. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections Create a new connection. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey} Delete a specific connection of a data asset. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey} Get a specific data asset connection by key. #
PUT /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey} Update a specific connection of a data asset. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}/actions/test Test the connection credentials to the parent data asset. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}/actions/uploadCredentials Upload connection credentials file and metadata for this connection for update. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities Returns a list of all entities of a data asset. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities Create a new data entity. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey} Delete a specific data entity. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey} Get a specific data entity by key for a data asset. #
PUT /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey} Update a specific data entity. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/fetchLineage Returns lineage for a given entity object. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/listAggregatedPhysicalEntities List the physical entities aggregated by this logical entity. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes Returns a list of all attributes of an data entity. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes Create a new entity attribute. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey} Delete a specific entity attribute. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey} Get a specific entity attribute by key. #
PUT /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey} Update a specific data asset attribute. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags Returns a list of all tags for an entity attribute. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags Create a new entity attribute tag. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags/{tagKey} Delete a specific entity attribute tag. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags/{tagKey} Get a specific entity attribute tag by key. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/rules Returns a list of all rules of a data entity. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags Returns a list of all tags for a data entity. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags Create a new entity tag. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags/{tagKey} Delete a specific entity tag. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags/{tagKey} Get a specific entity tag by key. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders Returns a list of all folders for a data asset. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders Create a new folder. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey} Delete a specific folder of a data asset identified by it's key. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey} Get a specific data asset folder by key. #
PUT /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey} Update a specific folder of a data asset. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags Returns a list of all tags for a folder. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags Create a new folder tag. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags/{tagKey} Delete a specific folder tag. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags/{tagKey} Get a specific folder tag by key. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags Returns a list of all tags for a data asset. #
POST /catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags Create a new data asset tag. #
DELETE /catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags/{tagKey} Delete a specific data asset tag. #
GET /catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags/{tagKey} Get a specific data asset tag by key. #
GET /catalogs/{catalogId}/glossaries Returns a list of all glossaries within a data catalog. #
POST /catalogs/{catalogId}/glossaries Create a new glossary. #
DELETE /catalogs/{catalogId}/glossaries/{glossaryKey} Delete a specific glossary identified by it's key. #
GET /catalogs/{catalogId}/glossaries/{glossaryKey} Get a specific glossary by key within a data catalog. #
PUT /catalogs/{catalogId}/glossaries/{glossaryKey} Update a specific glossary identified by the given key. #
POST /catalogs/{catalogId}/glossaries/{glossaryKey}/actions/asynchronousExport Exports the contents of a glossary in Excel format. #
POST /catalogs/{catalogId}/glossaries/{glossaryKey}/actions/expandTree Glossaries contain nested hierarchies of parent and child terms. Returns an expanded tree of this glossary. #
POST /catalogs/{catalogId}/glossaries/{glossaryKey}/actions/export Glossaries can be exported as csv or json formats. Returns the succesfully exported glossary in the format requested. #
POST /catalogs/{catalogId}/glossaries/{glossaryKey}/actions/import Glossaries can be imported from csv or json file formats. Returns the succesfully imported glossary. #
GET /catalogs/{catalogId}/glossaries/{glossaryKey}/terms Returns a list of all terms within a glossary. #
POST /catalogs/{catalogId}/glossaries/{glossaryKey}/terms Create a new term within a glossary. #
DELETE /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey} Delete a specific glossary term. #
GET /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey} Get a specific glossary term by key. #
PUT /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey} Update a specific glossary term. #
GET /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships Returns a list of all term relationships for a term within a glossary. #
POST /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships Create a new term relationship for this term within a glossary. #
DELETE /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships/{termRelationshipKey} Delete a specific glossary term relationship. #
GET /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships/{termRelationshipKey} Get a specific glossary term relationship by key. #
PUT /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships/{termRelationshipKey} Update a specific glossary term relationship. #
GET /catalogs/{catalogId}/jobDefinitions Returns a list of job definitions within a data catalog. #
POST /catalogs/{catalogId}/jobDefinitions Create a new job definition. #
DELETE /catalogs/{catalogId}/jobDefinitions/{jobDefinitionKey} Delete a specific job definition identified by it's key. #
GET /catalogs/{catalogId}/jobDefinitions/{jobDefinitionKey} Get a specific job definition by key within a data catalog. #
PUT /catalogs/{catalogId}/jobDefinitions/{jobDefinitionKey} Update a specific job definition identified by the given key. #
GET /catalogs/{catalogId}/jobs Returns a list of jobs within a data catalog. #
POST /catalogs/{catalogId}/jobs Create a new job. #
DELETE /catalogs/{catalogId}/jobs/{jobKey} Delete a specific job identified by it's key. #
GET /catalogs/{catalogId}/jobs/{jobKey} Get a specific job by key within a data catalog. #
PUT /catalogs/{catalogId}/jobs/{jobKey} Update a specific job identified by the given key. #
GET /catalogs/{catalogId}/jobs/{jobKey}/executions Returns a list of job executions for a job. #
POST /catalogs/{catalogId}/jobs/{jobKey}/executions Create a new job execution. #
GET /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey} Get a specific job execution by key. #
GET /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/logs Returns a list of job logs. #
GET /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/logs/{jobLogKey} Get a specific job log by key. #
GET /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/metrics Returns a list of job metrics. #
GET /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/metrics/{jobMetricsKey} Get a specific job metric by key. #
GET /catalogs/{catalogId}/namespaces Returns a list of namespaces within a data catalog. #
POST /catalogs/{catalogId}/namespaces Create a new Namespace to be used by a custom property #
DELETE /catalogs/{catalogId}/namespaces/{namespaceId} Delete a specific Namespace identified by it's key. #
GET /catalogs/{catalogId}/namespaces/{namespaceId} Get a specific namespace for the given key within a data catalog. #
PUT /catalogs/{catalogId}/namespaces/{namespaceId} Update a specific namespace identified by the given key. #
GET /catalogs/{catalogId}/namespaces/{namespaceId}/customProperties Returns a list of custom properties within a data catalog. #
POST /catalogs/{catalogId}/namespaces/{namespaceId}/customProperties Create a new Custom Property #
DELETE /catalogs/{catalogId}/namespaces/{namespaceId}/customProperties/{customPropertyKey} Delete a specific custom property identified by it's key. #
GET /catalogs/{catalogId}/namespaces/{namespaceId}/customProperties/{customPropertyKey} Get a specific custom property for the given key within a data catalog. #
PUT /catalogs/{catalogId}/namespaces/{namespaceId}/customProperties/{customPropertyKey} Update a specific custom property identified by the given key. #
GET /catalogs/{catalogId}/patterns Returns a list of patterns defined in this data catalog. #
POST /catalogs/{catalogId}/patterns Create a new pattern. #
DELETE /catalogs/{catalogId}/patterns/{patternKey} Delete a specific pattern identified by it's key. #
GET /catalogs/{catalogId}/patterns/{patternKey} Get a specific pattern for the given key within a data catalog. #
PUT /catalogs/{catalogId}/patterns/{patternKey} Update a specific pattern identified by the given key. #
POST /catalogs/{catalogId}/patterns/{patternKey}/actions/listDerivedLogicalEntities List the logical entities derived using this pattern usually as part of the harvest. #
POST /catalogs/{catalogId}/patterns/{patternKey}/actions/validate Validate the pattern based on the expression and input set of files to return file groups and logical entities #
POST /catalogs/{catalogId}/search Returns a list of search results within a data catalog. #
GET /catalogs/{catalogId}/tags Returns a list of all user created tags in the system. #
GET /catalogs/{catalogId}/types Returns a list of all types within a data catalog. #
GET /catalogs/{catalogId}/types/{typeKey} Get a specific type by key within a data catalog. #
POST /catalogs/{catalogId}/types/{typeKey}/actions/associateCustomProperties Associate the custom property for the given type #
POST /catalogs/{catalogId}/types/{typeKey}/actions/disassociateCustomProperties Remove the custom property for the given type #
GET /metastores Lists all metastores in the specified compartment. #
POST /metastores Creates a new metastore. #
DELETE /metastores/{metastoreId} Delete a metastore. #
GET /metastores/{metastoreId} Get a metastore. #
PUT /metastores/{metastoreId} Update a metastore. #
POST /metastores/{metastoreId}/actions/changeCompartment Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource. #
GET /workRequests List work requests. #
GET /workRequests/{workRequestId} Get work request status. #
GET /workRequests/{workRequestId}/errors Lists work request errors. #
GET /workRequests/{workRequestId}/logs Lists work request logs. #

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-datacatalog-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/oracle-datacatalog-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-datacatalog-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'Use the Data Catalog APIs to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.

    For more information, see [Data Catalog](https://docs.oracle.com/iaas/data-catalog/home.htm).

    '
  title: Data Catalog API
  version: '20190325'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/e68b9d092d83c0a95c4348810fdde44cd5f555052f5567599fa994204407882a.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Data Catalog API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/e68b9d092d83c0a95c4348810fdde44cd5f555052f5567599fa994204407882a.yaml
    what: the harvested document for Data Catalog API
servers:
- url: /20190325
tags:
- name: dataCatalog
paths:
  /catalogPrivateEndpoints:
    get:
      description: 'Returns a list of all the catalog private endpoints in the specified compartment.

        '
      operationId: ListCatalogPrivateEndpoints
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of private reverse connection endpoint summary objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CatalogPrivateEndpointSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists all the catalog private endpoints in the specified compartment
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Create a new private reverse connection endpoint.
      operationId: CreateCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The private reverse connection endpoint will be created.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create a new private reverse connection endpoint.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CatalogPrivateEndpoint'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCatalogPrivateEndpointDetails'
        description: The information used to create the private reverse connection.
        required: true
  /catalogPrivateEndpoints/{catalogPrivateEndpointId}:
    delete:
      description: Deletes a private reverse connection endpoint by identifier.
      operationId: DeleteCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CatalogPrivateEndpointIdentifierPathParam'
      responses:
        202:
          description: Accepted the request. The private reverse connection will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a private reverse connection endpoint.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CatalogPrivateEndpoint'
    get:
      description: Gets a specific private reverse connection by identifier.
      operationId: GetCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/CatalogPrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the private reverse connection with given id.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogPrivateEndpoint'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Get private reverse connection endpoint.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the private reverse connection endpoint.
      operationId: UpdateCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/CatalogPrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The private reverse connection will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update the private reverse connection endpoint identified by the id.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CatalogPrivateEndpoint'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCatalogPrivateEndpointDetails'
        description: The information to be updated in private reverse connection
        required: true
  /catalogPrivateEndpoints/{catalogPrivateEndpointId}/actions/changeCompartment:
    post:
      description: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: ChangeCatalogPrivateEndpointCompartment
      parameters:
      - $ref: '#/components/parameters/CatalogPrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Request has been accepted for changing compartment of private endpoint resource
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CatalogPrivateEndpoint'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCatalogPrivateEndpointCompartmentDetails'
        description: Details for the target compartment.
        required: true
  /catalogs:
    get:
      description: 'Returns a list of all the data catalogs in the specified compartment.

        '
      operationId: ListCatalogs
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of catalog summary objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CatalogSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists all the data catalogs in the specified compartment.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: '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.

        '
      operationId: CreateCatalog
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The data catalog will be created.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Creates a new data catalog.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCatalogDetails'
        description: Details for the new data catalog.
        required: true
  /catalogs/{catalogId}:
    delete:
      description: Deletes a data catalog resource by identifier.
      operationId: DeleteCatalog
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The data catalog will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a provisioned data catalog.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
    get:
      description: Gets a data catalog by identifier.
      operationId: GetCatalog
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the data catalog with the given id.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalog'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Get data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the data catalog.
      operationId: UpdateCatalog
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The data catalog will be updated and returned by this request.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalog'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update the data catalog identified by the id.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCatalogDetails'
        description: The data catalog information to be updated.
        required: true
  /catalogs/{catalogId}/actions/attachCatalogPrivateEndpoint:
    post:
      description: Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: AttachCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Request has been accepted for processing attach private endpoint
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Attaches a private reverse connection endpoint resource to a data catalog resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachCatalogPrivateEndpointDetails'
        description: Details for private reverse connection endpoint to be used for attachment.
        required: true
  /catalogs/{catalogId}/actions/changeCompartment:
    post:
      description: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: ChangeCatalogCompartment
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Request has been accepted for processing change compartment for catalog resource
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCatalogCompartmentDetails'
        description: Details for the target compartment.
        required: true
  /catalogs/{catalogId}/actions/detachCatalogPrivateEndpoint:
    post:
      description: Detaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: DetachCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Request has been accepted for processing detach private endpoint
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Detaches a private reverse connection endpoint resource to a data catalog resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DetachCatalogPrivateEndpointDetails'
        description: Details for private reverse connection endpoint to be used for attachment
        required: true
  /catalogs/{catalogId}/actions/getRecommendations:
    post:
      description: '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.

        '
      operationId: Recommendations
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RecommendationTypeQueryParam'
      - $ref: '#/components/parameters/SourceObjectKeyQueryParam'
      - $ref: '#/components/parameters/SourceObjectTypeQueryParam'
      - $ref: '#/components/parameters/RecommendationStatusQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of recommendations.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns a list of recommendations for the given object and recommendation type.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: false
      x-related-resource: '#/definitions/Catalog'
  /catalogs/{catalogId}/actions/objectStats:
    post:
      description: Returns stats on objects by type in the repository.
      operationId: ObjectStats
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Stats on objects by type in the repository.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns stats on objects in the repository.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Catalog'
  /catalogs/{catalogId}/actions/processRecommendation:
    post:
      description: '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.

        '
      operationId: ProcessRecommendation
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The recommendation was successfully processed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            ap

# --- truncated at 32 KB (652 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-datacatalog-api-openapi.yml