Enterprise Data Catalog REST API Overview
Representational State Transfer (REST) Web Services provide interoperability between computers that communicate through internet. You can use a REST Web Service to interact with Web resources and perform updates on Web resources. A REST Web Service conforms to the principles of REST by being client-server oriented and stateless and uses the HTTP protocol and methods for communication. APIs that conform to the REST principles are known as REST APIs. You can use REST APIs to extract, create, modify or delete information in the system through REST Web Services. The REST APIs are created using Swagger specification.
You can use the Enterprise Data Catalog REST APIs to extract information from models and objects and update models and objects. The APIs expose the following concepts:
- Model
- A model defines the structure for the metadata that the scanner ingests in the catalog.
- Data
- Data represents the metadata ingested in the catalog.
Concepts Exposed by the Model
- Attributes
- A model property that you can set on an object as a fact.
- Association
- A model link that you can create between two objects.
- Association Kinds
- Types of associations.
- Data Types
- Types of attributes.
- Classes
- Types of objects.
- Reference Attributes
- Type of attribute that projects a value from a source object to a target object.
Concepts Exposed by Data
- Object
- An object is an asset in the catalog. The object includes facts and you can link an object to other objects. Scanners or users create facts and links.
- Fact
- An instantiated attribute of an object. For example, Created by and Modified by are facts.
- Links
- An instantiated association between two objects.