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

identifierstringrequired

The new identifier of the scorecard.


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

titlestringrequired

The new title of the scorecard.


filter

object

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


combinatorstringrequired

Possible values: [and, or]

conditions

object[]

required

Possible values: >= 1

Array [

anyOf

Property between condition

propertystringrequired

operatorrequired

Possible values: [between, notBetween, =]

value

object

required

oneOf

Date range

fromdate-timerequired

todate-timerequired

Preset date range

presetstringrequired

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

Property containsAny condition

propertystringrequired

operatorstringrequired

Possible values: [containsAny]

valuestring[]required

Property comparison

propertystringrequired

operatorstringrequired

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

value

object

required

oneOf

string

string

number

number

boolean

boolean

Relation comparison

relationstringrequired

operatorstringrequired

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

value

object

required

oneOf

string

string

number

number

boolean

boolean

Property empty condition

notboolean

propertystringrequired

operatorstringrequired

Possible values: [isEmpty, isNotEmpty]

Relation empty condition

notboolean

relationstringrequired

operatorstringrequired

Possible values: [isEmpty, isNotEmpty]

]

rules

object[]

required

The rules that define the scorecard.


Array [

identifierstringrequired

The identifier of the rule.


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

titlestringrequired

The title of the rule.


descriptionstring

A description for the rule.


levelstringrequired

The level of the rule.


Possible values: [Gold, Silver, Bronze]

query

object

required

combinatorstringrequired

Possible values: [and, or]

conditions

object[]

required

Possible values: >= 1

Array [

anyOf

Property between condition

propertystringrequired

operatorrequired

Possible values: [between, notBetween, =]

value

object

required

oneOf

Date range

fromdate-timerequired

todate-timerequired

Preset date range

presetstringrequired

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

Property containsAny condition

propertystringrequired

operatorstringrequired

Possible values: [containsAny]

valuestring[]required

Property comparison

propertystringrequired

operatorstringrequired

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

value

object

required

oneOf

string

string

number

number

boolean

boolean

Relation comparison

relationstringrequired

operatorstringrequired

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

value

object

required

oneOf

string

string

number

number

boolean

boolean

Property empty condition

notboolean

propertystringrequired

operatorstringrequired

Possible values: [isEmpty, isNotEmpty]

Relation empty condition

notboolean

relationstringrequired

operatorstringrequired

Possible values: [isEmpty, isNotEmpty]

]

]

levels

object[]

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


Array [

titlestringrequired

The name of the level.


colorstringrequired

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

Default Response