Interface Management
Interfaces define how a schema is accessed and what authentication method is required.
A schema may contain one or more interfaces depending on how it is exposed to external systems. Supported interface types are REST, SOAP, Database, OpenAPI Schema, Postman Collection, Swagger, and Manifest.
Supported authentication methods are APIKEY, BASIC, OAUTH2.0, and NONE.
For dependency relationships, see Dependency Tracking.
Creating an Interface
To add an interface to a schema:
- Open a schema from the Entity Catalog.
- Open the Interfaces section.
- Click Add Interface.
- Enter the required interface details.
- Click Save.
Required details may include:
- Interface type
- Endpoint
- Specification URL
- Authentication method
Available interface types:
| Interface Type | Use |
|---|---|
| REST | REST API exposure or integration details |
| SOAP | SOAP service exposure or integration details |
| Database | Database-backed schema access |
| OpenAPI Schema | OpenAPI schema specification |
| Postman Collection | Postman collection specification |
| Swagger | Swagger specification |
| Manifest | CDM manifest-based schema reference |
Available authentication methods:
| Authentication Method | Use |
|---|---|
| APIKEY | API key authentication |
| BASIC | Basic authentication |
| OAUTH2.0 | OAuth 2.0 authentication |
| NONE | No authentication requirement recorded |
The interface appears in the schema interface list after saving.
Editing an Interface
To update an interface:
- Open the schema.
- Select the interface.
- Update interface details in the Properties panel.
- Click
Save.
Changes are reflected immediately.
Deleting an Interface
To remove an interface:
- Open the schema.
- Select the interface.
- Click Delete.
- Confirm deletion.
Deleting an interface removes only the interface configuration and does not delete the schema.
Filtering Interfaces
Use filters to locate interfaces more efficiently:
- Search bar — search endpoints or specification URLs
- Interface Type filter — filter by interface type
- Authentication Method filter — filter by authentication method
- Clear Filters — remove active filters
Filtering is useful for schemas containing multiple interfaces.