CreateScorecardCriteria

evaluation.passing_services_countOne Of

NumericFieldFilterOne Of

Filter by a numeric value.

Variant 1number

Value strictly equals the given numeric value.

Example:21

Example

idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.

Show Child Parameters

nameOne Of

Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.

Show Child Parameters

display_nameOne Of

Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.

Show Child Parameters

custom_fieldsOne Of

Filter by custom fields using dot-notation to specify the custom field.
Filter operators are dictated by the custom field type. For example:

filter[custom_fields.owner]
filter[custom_fields.owner][neq]=kong
filter[custom_fields.dashboard.link][contains]=https

StringFieldFilterOne Of

Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.

Show Child Parameters

labelsOne Of

Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.

Show Child Parameters

created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

updated_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

evaluation.is_passingOne Of

BooleanFieldFilterboolean

Filter by a boolean value (true/false).

evaluation.successfully_evaluated_atOne Of

DateTimeFieldFilterOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

evaluation.attempted_atOne Of

DateTimeFieldFilterOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

Example

* 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

* 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

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

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

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

ScorecardCriteriaFilterParameters

ScorecardCriteriaServiceFilterParameters

UpdateScorecardCriteria

ScorecardCriteria