Skip to content
GitmoapAPIBeta
Schema

ScorecardCheck

One check on a scorecard.

Shape

  • keyCheckKey (string)The built-in check's key for a derived check; your own name for the check otherwise.
  • ruleCheckRule
  • configobjectoptionalThe check's own parameters, such as {"days": 90} for released_within. An unknown parameter is refused with a 400 rather than ignored.
  • creates_work_itembooleanoptionalWhether a failure opens a work item in the owning group's backlog. Off by default, and it takes effect only while the scorecard's campaign is active.

Example

Synthesized example
{
"key": "key-d8c9",
"rule": {
"type": "derived"
},
"config": {},
"creates_work_item": false
}

Graph

Used inside
Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.