CatalogResource

object

Information about a catalog resource.

idstring(base64url)required

The resource ID.

>= 16 characters<= 16 characters

Example:4UdXnoaDYYJsH_Ir

namestringrequired

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_dataobjectrequired

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.

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

Example

CatalogResourceId

string

The resource ID.

>= 16 characters<= 16 characters

Example

CatalogResourceConfig

object

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.

* Additional properties are allowed.
Example

CatalogResourceType

string

The resource type. Available resource types are compiled from the integrations installed within the catalog.

>= 1 characters<= 120 characters

Example

ScheduleResourceIngestion

object
* Additional properties are NOT allowed.
ingest_fromstring(date-time)

A timestamp indicating when to start ingestion from.
RFC-3339 format is used with a “T” character separating date from time within the field value.
Omitting this property indicates ingestion will be triggered from the beginning of time until the present.

Example