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 between condition
- Property containsAny condition
- Property comparison
- Relation comparison
- Property empty condition
- Relation empty condition
- Date range
- Date preset
- string
- number
- boolean
- string
- number
- boolean
]
Array [
Array [
- Property between condition
- Property containsAny condition
- Property comparison
- Relation comparison
- Property empty condition
- Relation empty condition
- Date range
- Date preset
- MOD1
- MOD2
- MOD3
- MOD1
- MOD2
- MOD3
]
]
Array [
]
A unique identifier for the scorecard.
Possible values: Value must match regular expression ^[A-Za-z0-9@_.:\\/=-]+$
The title of the scorecard.
filter
object
An optional set of conditions to filter entities that will be evaluated by the scorecard.
The combinator to use when evaluating the conditions.
Possible values: [and, or]
conditions
object[]
required
Possible values: >= 1
The conditions to evaluate.
anyOf
Possible values: [between, notBetween, =]
value
object
required
oneOf
Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]
Possible values: [containsAny]
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: [between, notBetween, =]
value
object
required
oneOf
Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]
Possible values: [containsAny]
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]
levels
object[]
The available levels of the new scorecard, each with its own name and color.
The name of the level.
The color associated with the level, for visualization in Port's UI.
Possible values: [blue, turquoise, orange, purple, pink, yellow, green, red, gold, silver, paleBlue, darkGray, lightGray, bronze]
Responses
- 200
- 400
Default Response
Default Response