CatalogServiceRef
objectShort-hand descriptor of a catalog service.
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The machine name of the service that uniquely identifies it within the catalog.
Example:user-svc
The display name of the service.
Example:User Service
IntegrationRef
objectShort-hand descriptor of an integration installed within the catalog.
Example:gateway-manager
Example:gateway-manager
Short-hand descriptor of an integration instance.
Show Child Parameters
IntegrationRefWithoutInstance
objectShort-hand descriptor of an integration that omits instance metadata.
Example:gateway-manager
Example:gateway-manager
IntegrationInstanceRef
objectShort-hand descriptor of an integration instance.
The integration instance ID.
Example:772b9caf-ddbc-4f4f-8aa4-8dfbbe420351
The machine name of the integration instance that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
Example:aws-lambda-prod
The display name of the integration instance.
Example:AWS (prod)
CatalogResourceRef
objectShort-hand descriptor of a catalog resource.
The resource ID.
>= 16 characters<= 16 characters
Example:4UdXnoaDYYJsH_Ir
The name of the resource.
Short-hand descriptor of an integration installed within the catalog.
Show Child Parameters
The resource type. Available resource types are compiled from the integrations installed within the catalog.
>= 1 characters<= 120 characters
Example:gateway_svc
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"}