Konnect Service Catalog

CriteriaParameters

object

Input parameters for the given criteria template.

* Additional properties are allowed.
Example

ScorecardCriteriaService

idstring(uuid)requiredread-only

The service ID.

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

namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Match pattern:^[0-9a-z.-]+$

>= 1 characters<= 120 characters

Example:user-svc

display_namestringrequired

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstringrequired

Optionally provide a description of the Service.

<= 2048 characters

custom_fieldsobjectrequired

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

labelsrequired
scoreobject

Evaluation for a scorecard criteria relative to the given service service.
Has a null value when the criteria has not yet been evaluated for the service.

Show Child Parameters
Example

ScorecardCriteriaServiceEvaluation

object

Evaluation for a scorecard criteria relative to the given service service.
Has a null value when the criteria has not yet been evaluated for the service.

is_passingbooleanrequired

Whether or not the service has most recently passed the criteria check.

evaluation_contextobjectrequired

Provides additional metadata about the criteria evaluation result.

Example:{"raw_value":{"unit":"minutes","value":25},"display_text":"25 minutes"}

Show Child Parameters
evaluation_errorobjectrequired

Details about an error that occurred during evaluation preventing computation of a pass/fail result.
Will be null when no error occurred.

Show Child Parameters
attempted_atstring(date-time)required

The timestamp denoting the last evaluation attempt of the criteria for the service.

Example:2023-02-15T07:20:50Z

successfully_evaluated_atstring(date-time)required

The timestamp denoting when the criteria was last successfully evaluated for the service.
Error states preventing the evaluation from being performed will not update this timestamp.

Example:2023-02-15T07:20:50Z

Example

CriteriaEvaluationResultDetails

object

Provides additional metadata about the criteria evaluation result.

raw_valueOne Of
required

Raw value of the criteria evaluation.

For example, a service may be failing the time_to_acknowledge criteria evaluation when
the the mean time-to-ack is greater than 15 minutes. This value represents the actual
mean time-to-ack value for the service which if not passing could be 25 minutes.

Variant 1number
display_textstringrequired

Renderable text providing human-readable context about the evaluation value.

Example:25 minutes

Example

CriteriaEvaluationError

object

Details about an error that occurred during evaluation preventing computation of a pass/fail result.
Will be null when no error occurred.

typestringrequired

The type of error that occurred.

Example:integration_unauthorized

detailsstringrequired

Human-readable error message about the error.

Example:The GitHub integration is unauthorized. Please ensure that the integration is re-authorized for the criteria to be successfully evaluated.

Example