ScorecardCriteriaServiceFilterParameters
objectFilter using one of the following operators: eq, oeq, neq
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter 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]=kongfilter[custom_fields.dashboard.link][contains]=https
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
One OfFilter by a boolean value (true/false).
One OfOne OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
One OfOne OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
CreateScorecardCriteria
object>= 1 characters<= 2048 characters
Example:Median time to merge opened PRs is less than 6 hours over the last 3 months.
Example:true
Reference to the unique name of the criteria template.
Example:time_to_merge
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}}
Organizational section name for the criteria within the scorecard.
>= 1 characters<= 120 characters
Example:Source Code Management
UpdateScorecardCriteria
objectExample:5c1121f9-3f3a-47c7-9bb6-c81a51128714
>= 1 characters<= 2048 characters
Example:Median time to merge opened PRs is less than 6 hours over the last 3 months.
Example:true
Reference to the unique name of the criteria template.
Example:time_to_merge
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}}
Organizational section name for the criteria within the scorecard.
>= 1 characters<= 120 characters
Example:Source Code Management
ScorecardCriteria
objectExample:5c1121f9-3f3a-47c7-9bb6-c81a51128714
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.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
The integration name when it provides the criteria template. Otherwise null.
Whether the criteria is enabled for the given scorecard.
Example:true
Reference to the unique name of the criteria template.
Example:time_to_merge
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}}
Organizational section name for the criteria within the scorecard.
>= 1 characters<= 120 characters
Example:Documentation
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
CatalogServiceScorecardCriteria
objectExample:5c1121f9-3f3a-47c7-9bb6-c81a51128714
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.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
The integration name when it provides the criteria template. Otherwise null.
Whether the criteria is enabled for the given scorecard.
Example:true
Reference to the unique name of the criteria template.
Example:time_to_merge
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}}
Organizational section name for the criteria within the scorecard.
>= 1 characters<= 120 characters
Example:Documentation
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
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.