Konnect Service Catalog

ScorecardCriteriaEvaluation

object
passing_services_countnumberrequired

Number of targeted Services passing the criteria.

Example:3

Example

CriteriaTemplateName

string

Reference to the unique name of the criteria template.

Example

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