Change a scorecard

PUT 
/v1/blueprints/:blueprint_identifier/scorecards/:scorecard_identifier

This route allows you to modify a specific scorecard. 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

scorecard_identifier stringrequired

Possible values: non-empty

The identifier of the scorecard you want to change.


blueprint_identifier stringrequired

Possible values: non-empty

The identifier of the blueprint whose scorecard you want to change.

application/json

Body

required

identifier stringrequired

Possible values: Value must match regular expression ^[A-Za-z0-9@_.:\\/=-]+$

The new identifier of the scorecard.


title stringrequired

The new title of the scorecard.


filter

object

An optional set of conditions to filter entities that will be evaluated by the scorecard.


combinator stringrequired

Possible values: [and, or]

conditions

object[]

required

Possible values: >= 1

Array [

anyOf

Property between condition

property stringrequired

operator required

Possible values: [between, notBetween, =]

value

object

required

oneOf

Date range

from date-timerequired

to date-timerequired

Preset date range

preset stringrequired

Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]

Property containsAny condition

property stringrequired

operator stringrequired

Possible values: [containsAny]

value string[]required

Property comparison

property stringrequired

operator stringrequired

Possible values: [=, !=, >, <, >=, <=, contains, doesNotContains, beginsWith, doesNotBeginsWith, endsWith, doesNotEndsWith]

value

object

required

oneOf

string

string

number

number

boolean

boolean

Relation comparison

relation stringrequired

operator stringrequired

Possible values: [=, !=, contains, doesNotContains, beginsWith, doesNotBeginsWith, endsWith, doesNotEndsWith]

value

object

required

oneOf

string

string

number

number

boolean

boolean

Property empty condition

not boolean

property stringrequired

operator stringrequired

Possible values: [isEmpty, isNotEmpty]

Relation empty condition

not boolean

relation stringrequired

operator stringrequired

Possible values: [isEmpty, isNotEmpty]

]

rules

object[]

required

The rules that define the scorecard.


Array [

identifier stringrequired

Possible values: Value must match regular expression ^[A-Za-z0-9@_=\\-]+$

The identifier of the rule.


title stringrequired

The title of the rule.


description string

A description for the rule.


level stringrequired

Possible values: [Gold, Silver, Bronze]

The level of the rule.


query

object

required

combinator stringrequired

Possible values: [and, or]

conditions

object[]

required

Possible values: >= 1

Array [

anyOf

Property between condition

property stringrequired

operator required

Possible values: [between, notBetween, =]

value

object

required

oneOf

Date range

from date-timerequired

to date-timerequired

Preset date range

preset stringrequired

Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]

Property containsAny condition

property stringrequired

operator stringrequired

Possible values: [containsAny]

value string[]required

Property comparison

property stringrequired

operator stringrequired

Possible values: [=, !=, >, <, >=, <=, contains, doesNotContains, beginsWith, doesNotBeginsWith, endsWith, doesNotEndsWith]

value

object

required

oneOf

string

string

number

number

boolean

boolean

Relation comparison

relation stringrequired

operator stringrequired

Possible values: [=, !=, contains, doesNotContains, beginsWith, doesNotBeginsWith, endsWith, doesNotEndsWith]

value

object

required

oneOf

string

string

number

number

boolean

boolean

Property empty condition

not boolean

property stringrequired

operator stringrequired

Possible values: [isEmpty, isNotEmpty]

Relation empty condition

not boolean

relation stringrequired

operator stringrequired

Possible values: [isEmpty, isNotEmpty]

]

]

levels

object[]

The available levels of the new scorecard, each with its own name and color.


Array [

title stringrequired

The name of the level.


color stringrequired

Possible values: [blue, turquoise, orange, purple, pink, yellow, green, red, gold, silver, paleBlue, darkGray, lightGray, bronze]

The color associated with the level, for visualization in Port's UI.


]

Responses

200

Default Response

Loading...