Catalog Service API Mappings
Service API mappings represent the link between Service and API entities.
Once an API is mapped to a Service, a rich view of the linked APIs will be presented on the APIs tab of the Catalog Service.
Similarly, Services mapped to an API will be listed on the API overview page under Catalog.
An API may be mapped to multiple services, but it cannot be mapped to the same service twice.
If a mapped API is unlinked from a Service, the mapping will be deleted.
List API Mappings for a Service
Returns a paginated collection of API mappings for the given service.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Filters a collection of catalog service API mappings for a given Service. Supported filter attributes are:
api_id
Show Child Parameters
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A paginated list response for a collection of catalog service API mappings.
returns the pagination information
Show Child Parameters
Represents an API mapping associated with a service in the catalog.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create API Mapping for a Service
Creates a new API mapping for the given service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
Request body schema for creating a new API mapping for catalog service.
The ID of the API Entity to map.
Response
application/json
Response
A response containing a single catalog service API mapping.
CatalogServiceApiMapping
Represents an API mapping associated with a service in the catalog.
The mapping ID.
The ID of the service.
The ID of the API.
Creation timestamp.
Last update timestamp.
Authentication
Path Parameters
Body
Get API Mapping for a Service
Returns information about a specific API mapping for the given service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the catalog service API mapping.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Response
application/json
Response
A response containing a single catalog service API mapping.
CatalogServiceApiMapping
Represents an API mapping associated with a service in the catalog.
The mapping ID.
The ID of the service.
The ID of the API.
Creation timestamp.
Last update timestamp.
Authentication
Path Parameters
Delete API Mapping for a Service
Deletes a specific API mapping for the given service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the catalog service API mapping.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Response
Response
Catalog service API mapping was deleted successfully.