Search
K
Konnect Service Catalog

List API Mappings for a Service

Returns a paginated collection of API mappings for the given service.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

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

filterobject

Filters a collection of catalog service API mappings for a given Service. Supported filter attributes are:

  • api_id
  • id
* Additional properties are NOT allowed.
Show Child Parameters

Path Parameters

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

application/json

A paginated list response for a collection of catalog service API mappings.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Represents an API mapping associated with a service in the catalog.

Show Child Parameters
get/catalog-services/{serviceId}/api-mappings
 
application/json

Create API Mapping for a Service

Creates a new API mapping for the given service.

post

Path Parameters

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Body

application/json

Request body schema for creating a new API mapping for catalog service.

* Additional properties are NOT allowed.
api_idstring(uuid)required

The ID of the API Entity to map.

Response

application/json

A response containing a single catalog service API mapping.

CatalogServiceApiMapping

Represents an API mapping associated with a service in the catalog.

idstring(uuid)required

The mapping ID.

service_idstring(uuid)required

The ID of the service.

api_idstring(uuid)required

The ID of the API.

created_atstring(date-time)required

Creation timestamp.

updated_atstring(date-time)required

Last update timestamp.

post/catalog-services/{serviceId}/api-mappings

Body

{ "api_id": "api_id" }
 
application/json

Get API Mapping for a Service

Returns information about a specific API mapping for the given service.

get

Path Parameters

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

mappingIdstring(uuid)required

ID of the catalog service API mapping.

Example:d277faad-ed4e-4c56-a0fb-acce065dee34

Response

application/json

A response containing a single catalog service API mapping.

CatalogServiceApiMapping

Represents an API mapping associated with a service in the catalog.

idstring(uuid)required

The mapping ID.

service_idstring(uuid)required

The ID of the service.

api_idstring(uuid)required

The ID of the API.

created_atstring(date-time)required

Creation timestamp.

updated_atstring(date-time)required

Last update timestamp.

get/catalog-services/{serviceId}/api-mappings/{mappingId}
 
application/json

Delete API Mapping for a Service

Deletes a specific API mapping for the given service.

delete

Path Parameters

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

mappingIdstring(uuid)required

ID of the catalog service API mapping.

Example:d277faad-ed4e-4c56-a0fb-acce065dee34

Response

Catalog service API mapping was deleted successfully.

delete/catalog-services/{serviceId}/api-mappings/{mappingId}
 

List Service Mappings for an API

Returns a paginated collection of Service mappings for the given API.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

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

filterobject

Filters a collection of catalog API service mappings for a given API. Supported filter attributes are:

  • service_id
  • id
* Additional properties are NOT allowed.
Show Child Parameters

Path Parameters

apiIdstring(uuid)required

ID of the API.

Response

application/json

A paginated list response for a collection of catalog service API mappings.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Represents an API mapping associated with a service in the catalog.

Show Child Parameters
get/apis/{apiId}/service-mappings
 
application/json