Skip to main content

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.

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 stringrequired
    operator required

    Possible values: [between, notBetween, =]

    value

    object

    required

    oneOf

    from date-timerequired
    to date-timerequired
  • ]

  • 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 stringrequired
    operator required

    Possible values: [between, notBetween, =]

    value

    object

    required

    oneOf

    from date-timerequired
    to date-timerequired
  • ]

  • ]

  • 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

Default Response

Loading...