Oracle Data Catalog API
The dataCatalog API from Oracle — 86 operation(s) for datacatalog.
Oracle Data Catalog API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Data Catalog. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 143 operations across 86 paths, and defines 173 schemas. It is described by OpenAPI 3.2.0, at version 20190325.
Requests are made against a single base URL, /20190325.
143 operations
86 paths
173 schemas
20 DELETE54 GET53 POST16 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 143
Across 86 paths, the API surfaces 143 operations — 20 DELETE, 54 GET, 53 POST, 16 PUT. Each is listed below with its method, path, parameters, and response codes.
dataCatalog 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.
Schemas 173
The contract defines 173 schemas that model the data the API accepts and returns. The most detailed are Attribute (35 properties), SearchResult (32 properties), Entity (30 properties), AttributeSummary (29 properties). Each schema is shown below with its type and property counts.
AttributeSummary
object
Summary of an entity attribute.
29 properties
1 required
TypeCollection
object
Results of a types listing. Types define the basic type of catalog objects and are immutable.
2 properties
1 required
EntityTagCollection
object
Results of an entity tags listing. Entity tags allow assciation of business terms with entities.
2 properties
1 required
LineageObject
object
Object describing an individual element of object lineage.
11 properties
PropertyDefinition
object
Details of a single type property.
4 properties
UpdateTermRelationshipDetails
object
Properties used in term relationship update operations.
2 properties
Glossary
object
Full glossary details. A glossary of business terms, such as 'Customer', 'Account', 'Contact' , 'Address', or 'Product', with definitions, used to provide comm…
17 properties
1 required
CatalogPrivateEndpointSummary
object
A private network reverse connection creates a connection from service to customer subnet over a private network.
13 properties
4 required
TermSummary
object
Summary of a term. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for ex…
12 properties
1 required
ChangeMetastoreCompartmentDetails
object
Information about a change in metastore compartment.
1 property
1 required
AttachCatalogPrivateEndpointDetails
object
Information about the attaching the private endpoint resource to a catalog
1 property
1 required
JobDefinitionSummary
object
A list of job definition resources. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list o…
16 properties
1 required
EntityCollection
object
Results of a data entities listing. Data entities are representation of a dataset with a set of attributes.
2 properties
1 required
RecommendationCollection
object
Results of a get recommendation.
2 properties
1 required
EntitySummary
object
Summary of an data entity. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with 'table' or 'view'…
22 properties
1 required
AsynchronousExportGlossaryDetails
object
Details needed by the glossary export request.
CreateAttributeDetails
object
Properties used in attribute create operations.
18 properties
3 required
ImportGlossaryDetails
object
Import glossary from the contents of the glossary definition file.
1 property
CustomPropertyGetUsage
object
Details of a single custom property
14 properties
TermAssociatedObject
object
Projection of an object that is tagged to a term.
3 properties
1 required
JobExecution
object
A job execution is a unit of work being executed on behalf of a job.
20 properties
1 required
FacetedSearchSortRequest
object
Object with sort criteria details
2 properties
UpdatePatternDetails
object
Properties used in pattern update operations.
8 properties
DataAssetExportScope
object
Scope of asset export, which consists of a container object (bucket, folder, schema, etc) within the asset, and types of child objects contained by that object…
2 properties
CatalogPrivateEndpoint
object
A private network reverse connection creates a connection from service to customer subnet over a private network.
13 properties
4 required
JobMetric
object
A set of metrics are collected periodically to assess the state and performance characteristics of the execution instance of a job. The metrics are grouped bas…
15 properties
1 required
WorkRequest
object
A description of workrequest status.
9 properties
7 required
UpdateTermDetails
object
Properties used in term update operations.
6 properties
WorkRequestLog
object
A log message from the execution of a work request.
2 properties
2 required
DataSelectorPatternDetails
object
List of pattern Ids. Used in the addition and removal of patterns in data assets.
1 property
1 required
CreateTermDetails
object
Properties used in term create operations.
7 properties
1 required
ParseConnectionDetails
object
Parse connections from the connection metadata and Oracle wallet file. An error will be returned if more than one of connectionPayload, walletSecretId or walle…
4 properties
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties
3 required
FacetedSearchAggregation
object
Aggregation/facets on properties of data object.
4 properties
SearchTermSummary
object
Summary of a term associated with an object. This is a brief summary returned as part of the search result.
6 properties
1 required
TypeCustomPropertyDetails
object
Array of custom property IDs for which we have to associate the custom property to the type
2 properties
JobMetricCollection
object
Results of a job metrics listing. Job metrics are datum about a job execution in key value pairs.
2 properties
1 required
Connection
object
Detailed representation of a connection to a data asset, minus any sensitive properties.
16 properties
1 required
TermRelationshipCollection
object
Results of a terms relationship listing. Term relationships are associations between two terms in business glossary.
2 properties
1 required
EventConfig
object
Describes an event configuration, for a given object type and property. Primarily, whether a property change will result in an event being emitted.
9 properties
ConnectionSummary
object
Summary representation of a connection to a data asset.
10 properties
1 required
UpdateGlossaryDetails
object
Properties used in glossary update operations.
5 properties
UpdateDataAssetDetails
object
Properties used in data asset update operations.
4 properties
NamespaceSummary
object
Summary of a namespace
6 properties
1 required
ImportConnectionDetails
object
Import connection from the connection metadata and oracle wallet file.
2 properties
1 required
EntityTagSummary
object
Summary of an entity tag.
DataAsset
object
Data asset representation. A physical store, or stream, of data known to the data catalog and containing one or many data entities, possibly in an organized st…
17 properties
1 required
UpdateCustomPropertyDetails
object
Properties used in custom atrribute update operations.
12 properties
AsynchronousExportDataAssetResult
object
Details about the job which performs an export.
UploadCredentialsDetails
object
Upload credential file and connection metadata.
2 properties
1 required
JobLogSummary
object
A list of job execution logs. A job log is an audit log record inserted during the lifecycle of a job execution instance. There can be one or more logs for an…
6 properties
1 required
Term
object
Full term definition. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for…
18 properties
1 required
AsynchronousExportResult
object
Details about the job which performs an export.
5 properties
JobLogCollection
object
Results of a job logs Listing. A job log is an audit log record inserted during the lifecycle of a job execution instance.
2 properties
1 required
JobSummary
object
Details of a job. Jobs are scheduled instances of a job definition.
23 properties
1 required
CustomPropertyTypeUsage
object
Object which describes the indivial object stats for every custom property
4 properties
GlossaryTreeElement
object
Glossary tree element with child terms.
ChangeCatalogPrivateEndpointCompartmentDetails
object
Information about the change compartment for the private endpoint resource
1 property
1 required
SuggestResults
object
The list of potential matches returned from the suggest operation for the given input text. The size of the list will be determined by the limit parameter.
4 properties
2 required
CreateCatalogDetails
object
The information about a new data catalog.
4 properties
1 required
ValidatePatternResult
object
Details regarding the validation of a pattern resource.
5 properties
1 required
CreateJobExecutionDetails
object
Properties for creating a new job execution.
14 properties
DataAssetTagCollection
object
Results of a data asset tag listing. Data asset tags represent an association of a data asset to a term.
2 properties
1 required
SearchResultCollection
object
The list of search result items matching the criteria returned from the search operation. Search errors and messages, if any , will be part of the standard err…
5 properties
UpdateNamespaceDetails
object
Properties used in namespace update operations.
3 properties
WorkRequestError
object
An error encountered while executing a work request.
3 properties
3 required
SearchResult
object
The search result object is the definition of an element that is returned as part of search. It contains basic information about the object such as key, name a…
32 properties
PatternCollection
object
Results of a pattern listing. Patterns are used in entity harvesting.
2 properties
1 required
GlossarySummary
object
Summary of a glossary. A glossary of business terms, such as 'Customer', 'Account', 'Contact', 'Address', or 'Product', with definitions, used to provide commo…
12 properties
1 required
TypeSummary
object
Summary data catalog type information. All types are statically defined in the system and are immutable. It isn't possible to create new types or update existi…
9 properties
1 required
SearchCriteria
object
Search Query object that allows complex search predicates that cannot be expressed through simple query params.
5 properties
NamespaceCollection
object
Results of a namespaces listing. A namespace is an unique name tied to the first class object of data catalog which will be used to create a custom property
2 properties
1 required
RuleSummary
object
A list of rule resources. One or more rules can be defined for a data entity. Each rule can be defined on one or more attributes of the data entity.
17 properties
1 required
FacetedSearchCustomProperty
object
Details about custom property
3 properties
DataAssetSummary
object
Summary of a data asset. A physical store, or stream, of data known to the data catalog and containing one or many data entities, possibly in an organized stru…
10 properties
1 required
Namespace
object
Namespace Definition
9 properties
1 required
AsynchronousExportGlossaryResult
object
Details about the job which performs an export.
CreateJobDefinitionDetails
object
Representation of a job definition Resource. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. T…
10 properties
2 required
UpdateConnectionDetails
object
Properties used in connection update operations.
6 properties
ConnectionCollection
object
Results of a connections listing. Each member of the result is a summary representation of a connection to a data asset.
2 properties
1 required
Entity
object
Data entity details. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with 'table' or 'view' in a…
30 properties
1 required
ImportLineageJobResult
object
Information about lineage import operation.
5 properties
2 required
FolderTagSummary
object
Summary of a folder tag.
EntityLineage
object
Lineage for a data entity.
UpdateMetastoreDetails
object
Information to be updated for an existing metastore.
3 properties
ImportLineageDetails
object
Specifies the lineage contents to be imported.
1 property
1 required
FolderTagCollection
object
Results of a folders tag listing. Folder tags allow association of folder objects to business terms.
2 properties
1 required
EntityTag
object
Represents an association of an entity to a term.
JobLog
object
Job log details. A job log is an audit log record inserted during the lifecycle of a job execution instance.
9 properties
1 required
ValidatePatternDetails
object
Validate pattern using the expression and file list.
4 properties
UpdateFolderDetails
object
Properties used in folder update operations.
9 properties
JobDefinition
object
Representation of a job definition resource. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. T…
23 properties
1 required
Pattern
object
A pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for ease of use.
15 properties
1 required
TermRelationshipSummary
object
Summary of a term relationship. Business term relationship between two terms in a business glossary.
16 properties
1 required
JobExecutionCollection
object
Results of a job executions listing. Job executions are execution instances of a scheduled job.
2 properties
1 required
FolderCollection
object
Results of a folders listing. Folders are external organization concept that groups data entities.
2 properties
1 required
ObjectLineageRequestDetails
object
Details needed by a lineage fetch request.
4 properties
CreateConnectionDetails
object
Properties used in connection create operations.
7 properties
3 required
JobMetricSummary
object
Job metric summary.
12 properties
1 required
FacetedSearchFilterRequest
object
Object with details about filter criteria.
2 properties
GlossaryCollection
object
Results of a glossaries listing. Glossary is an organizing concept for business terms to provide a unified semantic model across disparate data assets.
2 properties
1 required
ConnectionAliasSummary
object
Summary representation of database aliases parsed from the file metadata.
2 properties
1 required
CustomPropertySummary
object
Summary of a custom property
23 properties
1 required
JobExecutionSummary
object
A list of job executions. A job execution is a unit of work being executed on behalf of a job.
10 properties
1 required
CreateEntityDetails
object
Properties used in data entity create operations.
14 properties
2 required
AsynchronousExportDataAssetDetails
object
Details needed by the Data Asset export request.
AttributeTagSummary
object
Summary of an entity attribute tag.
Type
object
Full data catalog type definition. Fully defines a type of the data catalog. All types are statically defined in the system and are immutable. It isn't possibl…
15 properties
1 required
DerivedLogicalEntities
object
Entities derived from the application of a pattern to a list of file paths.
3 properties
UpdateEntityDetails
object
Properties used in entity update operations.
13 properties
FetchEntityLineageDetails
object
The information needed to obtain desired lineage.
UpdateCatalogPrivateEndpointDetails
object
Information about the modified private endpoint resource
5 properties
CreateCatalogPrivateEndpointDetails
object
Information about the new private endpoint resource
7 properties
3 required
Metastore
object
A Data Catalog Metastore provides a centralized metastore repository for use by other OCI services.
11 properties
4 required
FacetedSearchStringFilterRequest
object
Object with string filter criteria
2 properties
CreatePatternDetails
object
Properties used in pattern create operations.
8 properties
1 required
SuggestListItem
object
Details of a potential match returned from the suggest operation for the given input text. by the limit parameter.
2 properties
FacetedSearchDateFilterRequest
object
Object with date filter criteria
3 properties
CreateJobDetails
object
Properties used to create a job.
7 properties
2 required
JobDefinitionCollection
object
Results of a job definition listing. Job definitions are resources that describe the scope and type of jobs (eg: harvest, profiling, sampling) that are defined…
2 properties
1 required
ValidateConnectionDetails
object
Validate connection from the connection metadata or oracle wallet file.
2 properties
CreateFolderDetails
object
Properties used in folder create operations.
10 properties
2 required
CustomPropertySetUsage
object
Details of a single custom property.
4 properties
AttributeCollection
object
Results of an attributes listing. Attributes describe an item of data with name and datatype.
2 properties
1 required
Error
object
Error Information.
2 properties
2 required
CreateMetastoreDetails
object
Information about a new metastore.
6 properties
3 required
ObjectLineage
object
Lineage for an object.
5 properties
2 required
RecommendationDetails
object
Details of a recommendation.
11 properties
3 required
DetachCatalogPrivateEndpointDetails
object
Information about the detaching the private endpoint resource from a catalog
1 property
1 required
CatalogSummary
object
Summary of the data catalog.
11 properties
2 required
RuleAttribute
object
Object that defines a usage of an attribute in the context of a rule. Example: For a UNIQUEKEY rule, declares the attribute in a table whose value must be uniq…
3 properties
1 required
ProcessRecommendationDetails
object
Details of recommendation to be processed.
3 properties
2 required
FolderTag
object
Represents an association of a folder to a term.
Catalog
object
A data catalog enables you to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.
13 properties
2 required
PatternSummary
object
Summary of a pattern. A pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for…
8 properties
1 required
AsynchronousExportRequestDetails
object
Details for an export request.
1 property
Job
object
Details of a job. Jobs are scheduled instances of a job definition.
25 properties
1 required
ValidateConnectionResult
object
Details regarding the validation of a connection resource.
2 properties
1 required
MetastoreSummary
object
Summary of a metastore.
9 properties
2 required
ChangeCatalogCompartmentDetails
object
Information about the change compartment
1 property
1 required
LineageRelationship
object
Declares how two elements of object lineage are related.
3 properties
CreateTermRelationshipDetails
object
Properties used in term relationship create operations.
3 properties
2 required
AttributeTag
object
Represents an association of an entity attribute to a term.
CreateGlossaryDetails
object
Properties used in glossary create operations.
5 properties
1 required
DataAssetTag
object
Represents an association of a data asset to a term.
Attribute
object
Details of an entity attribute. An attribute of a data entity describing an item of data, with a name and data type. Synonymous with 'column' in a database.
35 properties
1 required
ObjectRelationship
object
Details regarding a specific object and its relationship to the referencing object.
10 properties
SearchTagSummary
object
Represents the association of an object to a term. Returned as part of search result.
2 properties
1 required
TermCollection
object
Results of a terms listing. Terms are defined in business glossary and are used in tagging catalog objects.
2 properties
1 required
Folder
object
A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term…
24 properties
1 required
UpdateAttributeDetails
object
Properties used in attribute update operations.
17 properties
UpdateCatalogDetails
object
The information to be updated for catalog resource.
3 properties
BaseTag
object
Represents the association of an object to a term. Tags are immutable.
9 properties
1 required
UpdateJobDefinitionDetails
object
Update information for a job definition resource.
9 properties
RuleCollection
object
Results of an rule listing. Rules describe an item of data with name and ruletype.
2 properties
1 required
BaseTagSummary
object
Represents the association of an object to a term.
9 properties
1 required
DataAssetTagSummary
object
Summary of a data asset tag.
JobCollection
object
Results of a jobs listing. Jobs are scheduled instances of a job definition.
2 properties
1 required
CreateNamespaceDetails
object
Properties used in custom property create operations.
3 properties
1 required
UpdateJobDetails
object
Job properties that can be updated.
6 properties
ImportDataAssetJobResult
object
Information about a data asset import operation.
5 properties
1 required
CustomPropertyCollection
object
Results of a custom properties listing. A custom property is an user defined attribute tied to the first class object of data catalog
2 properties
1 required
FolderSummary
object
Summary of a folder. A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a…
16 properties
1 required
AttributeTagCollection
object
Results of an attribute tags listing. Attribnute tags allow association of business terms with attributes.
2 properties
1 required
CustomProperty
object
Custom Property Definition
25 properties
1 required
ExportDataAssetDetails
object
The details of what needs to be exported.
1 property
CreateDataAssetDetails
object
Properties used in data asset create operations.
5 properties
2 required
ObjectStorageObjectReference
object
A reference to an Object Storage object.
3 properties
3 required
CreateCustomPropertyDetails
object
Properties used in custom property create operations.
13 properties
1 required
DataAssetCollection
object
Results of a data assets listing. A data asset is often synonymous with a 'System', such as a database, or may be a file container or a message stream.
2 properties
1 required
TermRelationship
object
Full term relationship definition. Business term relationship between two terms in a business glossary.
16 properties
1 required
CreateTagDetails
object
Properties used in tag create operations.
2 properties
ImportDataAssetDetails
object
Specifies the file contents to be imported.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#Data Catalog
Where this information came from
This is an independent, third-party profile of Oracle Data Catalog API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.