Search
K
Konnect Service Catalog

TestSuggestionRulePayload

object

Payload to test suggestion rule configuration against an integration record.

* Additional properties are NOT allowed.
bindingstringrequired

The integration binding object name

Example:pagerduty_service

discovery_selectorstringrequired

A boolean string or JQ expression that must evaluate to a boolean value.
Supports JQ expressions syntax on discovered entity’s integration_record property.

<= 2048 characters

Example:.gateway_service.tags | contains(["_KonnectDeployment:"])

actionOne Of
required
ArchiveActionPayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
integration_recordobjectrequired

JSON object that may contain additional context about the entity.

Example:{"control_plane":{"id":"0a7647d1-483a-4817-a5ac-28937b511563","name":"control_plane_name"},"gateway_service":{"id":"3fd1bff6-b60d-4c22-bb74-e4cac63196fb","name":"gateway_service_name"}}

* Additional properties are allowed.
Example

SuggestionRule

Contains information about the suggestion rule.

idstring(uuid)requiredread-only

The suggestion rule ID.

Example:22f72bd1-2897-473e-9471-302de3ccf38b

namestringrequired

The display name of the suggestion rule.

>= 1 characters<= 120 characters

descriptionstringrequired

The description of the suggestion rule

Default:null

>= 1 characters<= 2048 characters

Example:Suggestion rule description

bindingstringrequired

The integration binding object name

Example:pagerduty_service

activebooleanrequired

Determines if this suggestion rule should be evaluated when generating suggested actions.

auto_acceptbooleanrequired

Determines if the suggested action should be applied automatically.

  • true: Suggested action will be applied automatically
  • false: Suggested action will not be automatically applied, user input required
actionOne Of
required
ArchiveActionPayloadobject

The action configuration for this system suggestion rule.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

discovery_selectorstringrequired

A boolean string or JQ expression that must evaluate to a boolean value.
Supports JQ expressions syntax on discovered entity’s integration_record property.

Example:.gateway_service.tags | contains(["_KonnectDeployment:"])

Example

TestSuggestionRule

object

Contains evaluation results of a suggestion rule configuration against an integration record.

* Additional properties are NOT allowed.
evaluationobjectrequired

Evaluation result of suggesetion rule configuration against given integration record.

* Additional properties are NOT allowed.
Show Child Parameters
errorsarray[object]required

List of errors that occured when evaluating suggestion rule configuration against given integration record.

Show Child Parameters
Example

SuggestionRuleError

Represents any errors which occured when evaluating a suggestion rule

idstring

The id of the suggestion rule error

Example:e4698717-7f0b-434d-aa16-a472089c2504

resource_idstring

The id of the related resource which generated this error

Example:qLgnGlFp4iveGUFl

suggestion_rule_idstringrequired

The id of the suggestion rule which generated this error

Example:fd109d4a-e183-4488-98f2-10eab0964155

detailsarray[object]required

Details of the error generated from the related suggested rule when evaluated

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

SuggestedRuleActionEvaluated

One Of
typestringrequired

Allowed values:archive

Example