Catalog Resource Mappings
Resource mappings represent the link between a resource and a service.
Once a resource is mapped to a service, a rich view of the resource will be presented on the service page.
A resource may be mapped to multiple services, but it cannot be mapped to the same service twice.
If a resource mapped to a service is later archived, the resource mapping will be deleted.
Create Resource Mapping
Creates a mapping between a catalog resource and service.
Body
application/json
Body
CreateCatalogResourceMapping
The id or name of the service to map the resource to.
Example:user-svc
One OfThe resource ID.
>= 16 characters<= 16 characters
Example:4UdXnoaDYYJsH_Ir
Response
application/json
Response
A response containing a single catalog resource mapping.
CatalogResourceMapping
Describes a mapping between a catalog resource and a service.
The resource mapping ID.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Short-hand descriptor of a catalog resource.
Show Child Parameters
Short-hand descriptor of a catalog service.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
Authentication
Body
List Resource Mappings
Returns a paginated collection of catalog resource mappings.
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
Filters a collection of resource mappings.
Show Child Parameters
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
Response
A paginated list response for a collection of catalog resource mappings.
returns the pagination information
Show Child Parameters
Describes a mapping between a catalog resource and a service.
Show Child Parameters
Authentication
Query Parameters
Get a Resource Mapping
Fetches a resource mapping by ID.
Path Parameters
The id of the resource mapping.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Response
application/json
Response
A response containing a single catalog resource mapping.
CatalogResourceMapping
Describes a mapping between a catalog resource and a service.
The resource mapping ID.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Short-hand descriptor of a catalog resource.
Show Child Parameters
Short-hand descriptor of a catalog service.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Delete Resource Mapping
Removes an existing mapping between a catalog resource and service.
Path Parameters
The id of the resource mapping.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Response
Response
Resource Mapping was deleted successfully.