Search
K
Konnect Service Catalog

CatalogResourceFilterParameters

object
idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.display_nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.idOne Of
UuidFieldFilterobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.display_nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
typeobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
configOne Of
CatalogResourceConfigFieldFilterobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration_dataOne Of
CatalogResourceIntegrationDataFieldFilterobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
archivedboolean

Filter by a boolean value (true/false).

service_associationsOne Of

Filter by a numeric value.

Variant 1number

Value strictly equals the given numeric value.

Example:21

created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

updated_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

Example

CatalogResourceRefFilterParameters

object
idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.display_nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.idOne Of
UuidFieldFilterobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.display_nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
typeobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
configOne Of
CatalogResourceConfigFieldFilterobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration_dataOne Of
CatalogResourceIntegrationDataFieldFilterobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
service_associationsOne Of

Filter by a numeric value.

Variant 1number

Value strictly equals the given numeric value.

Example:21

created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

updated_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

Example

CatalogResourceConfigFieldFilter

object

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

containsstring

The field contains the provided value.

Example:?filter[field_name_here][contains]=foo

ocontainsstring

The field contains any of the provided values.

Example:?filter[field_name_here][ocontains]=foo,bar

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example

CatalogResourceIntegrationDataFieldFilter

object

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

containsstring

The field contains the provided value.

Example:?filter[field_name_here][contains]=foo

ocontainsstring

The field contains any of the provided values.

Example:?filter[field_name_here][ocontains]=foo,bar

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example

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