Create a scorecard
POST/v1/blueprints/:blueprint_identifier/scorecards
This route allows you to create a scorecard for a given blueprint. A scorecard is a set of rules that define the quality of a blueprint.
To learn more about scorecards, check out the documentation.
Request
Path Parameters
Possible values: non-empty
The identifier of the blueprint you want to run scorecards for.
- application/json
Body
required
Array [
- Property comparison
- Relation comparison
- Property empty condition
- Relation empty condition
- string
- number
- boolean
- string
- number
- boolean
]
Array [
Array [
- Property comparison
- Relation comparison
- Property empty condition
- Relation empty condition
- MOD1
- MOD2
- MOD3
- MOD1
- MOD2
- MOD3
]
]
Possible values: Value must match regular expression ^[A-Za-z0-9@_.:\\/=-]+$
A unique identifier for the scorecard.
The title of the scorecard.
filter
object
An optional set of conditions to filter entities that will be evaluated by the scorecard.
Possible values: [and
, or
]
The combinator to use when evaluating the conditions.
conditions
object[]
required
Possible values: >= 1
The conditions to evaluate.
anyOf
Possible values: [=
, !=
, >
, <
, >=
, <=
, contains
, doesNotContains
, beginsWith
, doesNotBeginsWith
, endsWith
, doesNotEndsWith
]
value
object
required
oneOf
string
number
boolean
Possible values: [=
, !=
, contains
, doesNotContains
, beginsWith
, doesNotBeginsWith
, endsWith
, doesNotEndsWith
]
value
object
required
oneOf
string
number
boolean
Possible values: [isEmpty
, isNotEmpty
]
Possible values: [isEmpty
, isNotEmpty
]
rules
object[]
required
The rules that define the scorecard.
Possible values: Value must match regular expression ^[A-Za-z0-9@_=\\-]+$
Possible values: [Gold
, Silver
, Bronze
]
query
object
required
Possible values: [and
, or
]
conditions
object[]
required
Possible values: >= 1
anyOf
Possible values: [=
, !=
, >
, <
, >=
, <=
, contains
, doesNotContains
, beginsWith
, doesNotBeginsWith
, endsWith
, doesNotEndsWith
]
value
object
required
oneOf
string
number
boolean
Possible values: [=
, !=
, contains
, doesNotContains
, beginsWith
, doesNotBeginsWith
, endsWith
, doesNotEndsWith
]
value
object
required
oneOf
string
number
boolean
Possible values: [isEmpty
, isNotEmpty
]
Possible values: [isEmpty
, isNotEmpty
]
Responses
- 200
- 400
Default Response
Default Response