SystemSuggestionRule
Contains information about the system defined suggestion rule.
The suggestion rule ID.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
The display name of the suggestion rule.
>= 1 characters<= 120 characters
The description of the suggestion rule
Default:null
>= 1 characters<= 2048 characters
Example:Suggestion rule description
The integration binding object name
Example:pagerduty_service
Determines if this suggestion rule should be evaluated when generating suggested actions.
Determines if the suggested action should be applied automatically.
true: Suggested action will be applied automaticallyfalse: Suggested action will not be automatically applied, user input required
The action configuration for this system suggestion rule.
Show Child Parameters
SuggestionRulePayload
objectPayload to create a suggestion rule for an integration.
The display name of the suggestion rule
>= 1 characters<= 120 characters
The description of the suggestion rule
Default:null
>= 1 characters<= 2048 characters
Example:Suggestion rule description
The integration binding object name
Example:pagerduty_service
Determines if this suggestion rule should be evaluated when generating suggested actions.
Determines if the suggested action should be applied automatically.
true: Suggested action will be applied automaticallyfalse: Suggested action will not be automatically applied, user input required
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:"])
One OfShow Child Parameters
One OfDetermines how this suggestion rule ranks against existing suggestion rules for the integration.
When rank is not specified, this suggestion rule will placed as the lowest priority rule.
Show Child Parameters
TestSuggestionRulePayload
objectPayload to test suggestion rule configuration against an integration record.
The integration binding object name
Example:pagerduty_service
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:"])
One OfShow Child Parameters
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"}}
SuggestionRule
Contains information about the suggestion rule.
The suggestion rule ID.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
The display name of the suggestion rule.
>= 1 characters<= 120 characters
The description of the suggestion rule
Default:null
>= 1 characters<= 2048 characters
Example:Suggestion rule description
The integration binding object name
Example:pagerduty_service
Determines if this suggestion rule should be evaluated when generating suggested actions.
Determines if the suggested action should be applied automatically.
true: Suggested action will be applied automaticallyfalse: Suggested action will not be automatically applied, user input required
One OfThe action configuration for this system suggestion rule.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
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:"])
TestSuggestionRule
objectContains evaluation results of a suggestion rule configuration against an integration record.
Evaluation result of suggesetion rule configuration against given integration record.
Show Child Parameters
List of errors that occured when evaluating suggestion rule configuration against given integration record.