Konnect Service Catalog

CreateScorecardCriteria

object
* Additional properties are NOT allowed.
namestring

>= 1 characters<= 2048 characters

Example:Median time to merge opened PRs is less than 6 hours over the last 3 months.

enabledbooleanrequired

Example:true

template_namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

template_parametersobjectrequired

Input parameters for the given criteria template.
The available parameters, and its schema, are found on the criteria template definition via
the schema property. Criteria template definitions are determined by the /v1/criteria-templates
endpoint.

Example:{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}}

* Additional properties are allowed.
section_namestringrequired

Organizational section name for the criteria within the scorecard.

>= 1 characters<= 120 characters

Example:Source Code Management

Example

UpdateScorecardCriteria

object
* Additional properties are NOT allowed.
idstring(uuid)required

Example:5c1121f9-3f3a-47c7-9bb6-c81a51128714

namestring

>= 1 characters<= 2048 characters

Example:Median time to merge opened PRs is less than 6 hours over the last 3 months.

enabledbooleanrequired

Example:true

template_namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

template_parametersobjectrequired

Input parameters for the given criteria template.
The available parameters, and its schema, are found on the criteria template definition via
the schema property. Criteria template definitions are determined by the /v1/criteria-templates
endpoint.

Example:{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}}

* Additional properties are allowed.
section_namestringrequired

Organizational section name for the criteria within the scorecard.

>= 1 characters<= 120 characters

Example:Source Code Management

Example

ScorecardCriteria

object
idstring(uuid)required

Example:5c1121f9-3f3a-47c7-9bb6-c81a51128714

namestringrequired

Override display name for the criteria, for greater contextual clarity within a given scorecard.

Example:Time to restore service is less than 6 hours over the last 3 months.

scorecard_idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

integrationstringrequired

The integration name when it provides the criteria template. Otherwise null.

enabledbooleanrequired

Whether the criteria is enabled for the given scorecard.

Example:true

template_namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

template_parametersobjectrequired

Input parameters for the given criteria template.
The available parameters, and its schema, are found on the criteria template definition via
the schema property. Criteria template definitions are determined by the /v1/criteria-templates
endpoint.

Example:{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}}

* Additional properties are allowed.
section_namestringrequired

Organizational section name for the criteria within the scorecard.

>= 1 characters<= 120 characters

Example:Documentation

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

CatalogServiceScorecardCriteria

object
idstring(uuid)required

Example:5c1121f9-3f3a-47c7-9bb6-c81a51128714

namestringrequired

Override display name for the criteria, for greater contextual clarity within a given scorecard.

Example:Time to restore service is less than 6 hours over the last 3 months.

scorecard_idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

integrationstringrequired

The integration name when it provides the criteria template. Otherwise null.

enabledbooleanrequired

Whether the criteria is enabled for the given scorecard.

Example:true

template_namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

template_parametersobjectrequired

Input parameters for the given criteria template.
The available parameters, and its schema, are found on the criteria template definition via
the schema property. Criteria template definitions are determined by the /v1/criteria-templates
endpoint.

Example:{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}}

* Additional properties are allowed.
section_namestringrequired

Organizational section name for the criteria within the scorecard.

>= 1 characters<= 120 characters

Example:Documentation

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

evaluationobjectrequired

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

ScorecardCriteriaWithEvaluation

object
idstring(uuid)required

Example:5c1121f9-3f3a-47c7-9bb6-c81a51128714

namestringrequired

Override display name for the criteria, for greater contextual clarity within a given scorecard.

Example:Time to restore service is less than 6 hours over the last 3 months.

scorecard_idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

integrationstringrequired

The integration name when it provides the criteria template. Otherwise null.

enabledbooleanrequired

Whether the criteria is enabled for the given scorecard.

Example:true

template_namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

template_parametersobjectrequired

Input parameters for the given criteria template.
The available parameters, and its schema, are found on the criteria template definition via
the schema property. Criteria template definitions are determined by the /v1/criteria-templates
endpoint.

Example:{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}}

* Additional properties are allowed.
section_namestringrequired

Organizational section name for the criteria within the scorecard.

>= 1 characters<= 120 characters

Example:Documentation

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

evaluationobjectrequired
Show Child Parameters
Example