integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
resourceIdstringrequired
The id of the resource.
Example:AflTNLY0tTQhv2my
Update Resource
Updates a resource.
patch
Path Parameters
Body
application/json
Body
application/json
UpdateCatalogResource
* Additional properties are NOT allowed.
archivedboolean
Whether or not to archive the resource.
When a resource is archived, all catalog service mappings will be removed.
Example:false
Response
application/json
Response
application/json
A response containing a single resource object.
CatalogResource
Information about a catalog resource.
idstring(base64url)required
The resource ID.
>= 16 characters<= 16 characters
Example:4UdXnoaDYYJsH_Ir
namestring | nullrequired
The name of the resource.
Will be null when the resource has not yet been hydrated by the integration.
>= 1 characters<= 255 characters
integrationobjectrequired
Short-hand descriptor of an integration installed within the catalog.
Show Child Parameters
typestringrequired
The resource type. Available resource types are compiled from the integrations installed within the catalog.
>= 1 characters<= 120 characters
Example:gateway_svc
configobjectrequired
JSON object representing the properties used to identify the resource in the third-party system.
The schema depends on the resource type and is dynamically registered at runtime.
Example:{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"}
* Additional properties are allowed.
integration_dataobject | nullrequired
JSON object containing schemaless integration data of the resource.
This field is always populated by the system backing the integration.
When null, the resource has been manually initialized via API but has
yet to be hydrated by the integration.
* Additional properties are allowed.
archivedbooleanrequired
Whether or not the resource has been archived.
Example:false
service_associationsnumberrequiredread-only
The number of catalog services this resource is mapped to.
>= 0
Example:2
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
patch/integration-instances/{integrationInstanceId}/resources/{resourceId}
Authentication
Path Parameters
Body
{
"archived": true
}
application/json
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.
post
Body
application/json
Body
application/json
CreateCatalogResourceMapping
* Additional properties are NOT allowed.
servicestringrequired
The id or name of the service to map the resource to.
Example:user-svc
resource
One Ofrequired
CatalogResourceIdstring(base64url)
The resource ID.
>= 16 characters<= 16 characters
Example:4UdXnoaDYYJsH_Ir
Response
application/json
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
post/resource-mappings
Authentication
Body
{
"service": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"resource": "rQIGLHo1vhgy5VYb"
}
application/json
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
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
Authentication
Query Parameters
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
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}
Authentication
Path Parameters
application/json