Search
K
Konnect Service Catalog

List Resource Mappings

Returns a paginated collection of catalog resource mappings.

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

filterobject

Filters a collection of resource mappings.

Show Child Parameters
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

Response

application/json

A paginated list response for a collection of catalog resource mappings.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Describes a mapping between a catalog resource and a service.

Show Child Parameters
get/resource-mappings
 
application/json

Get a Resource Mapping

Fetches a resource mapping by ID.

get

Path Parameters

resourceMappingIdstring(uuid)required

The id of the resource mapping.

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

Response

application/json

A response containing a single catalog resource mapping.

CatalogResourceMapping

Describes a mapping between a catalog resource and a service.

idstring(uuid)required

The resource mapping ID.

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

resourceobjectrequired

Short-hand descriptor of a catalog resource.

Show Child Parameters
serviceobjectrequired

Short-hand descriptor of a catalog service.

Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

get/resource-mappings/{resourceMappingId}
 
application/json

Delete Resource Mapping

Removes an existing mapping between a catalog resource and service.

delete

Path Parameters

resourceMappingIdstring(uuid)required

The id of the resource mapping.

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

Response

Resource Mapping was deleted successfully.

delete/resource-mappings/{resourceMappingId}
 

Catalog Service Resources

Represents all the resources mapped to a specific service.

List Service Resources

Returns a paginated collection of resources mapped to a 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

filterobject

Filters a collection of resources.

Show Child Parameters

Path Parameters

idstringrequired

The id of the service.

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

Response

application/json

A paginated list response for a collection of resources mapped to a service.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Information about a catalog resource.

Show Child Parameters
get/catalog-services/{id}/resources
 
application/json