Search
K
Konnect Service Catalog

CustomFieldSchema

object

Contains information about a custom field schema.

idstring(uuid)requiredread-only

The Custom Field ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The name of the custom field.

<= 120 characters

Example:slack-url

schemaobjectrequired

JSON object containing the custom field schema definition.

Default:{}

Example:{"display_name":"slack url","description":"Slack URL metadata.","required":false,"type":"string"}

* Additional properties are allowed.
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

CatalogServiceApiMapping

object

Represents an API mapping associated with a service in the catalog.

idstring(uuid)required

The mapping ID.

service_idstring(uuid)required

The ID of the service.

api_idstring(uuid)required

The ID of the API.

created_atstring(date-time)required

Creation timestamp.

updated_atstring(date-time)required

Last update timestamp.

Example

CatalogServiceApiMappingFilterParameters

object
* Additional properties are NOT allowed.
api_idobject

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

* Additional properties are NOT allowed.
Show Child Parameters
idobject

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

* Additional properties are NOT allowed.
Show Child Parameters
Example

CatalogApiServiceMappingFilterParameters

object
* Additional properties are NOT allowed.
service_idobject

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

* Additional properties are NOT allowed.
Show Child Parameters
idobject

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

* Additional properties are NOT allowed.
Show Child Parameters
Example

StringFieldEqualsFilter

Filters on the given string field value by exact match.

eqstring
Example