Skip to main content

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

    blueprint_identifier stringrequired

    Possible values: non-empty

    The identifier of the blueprint you want to run scorecards for.

Body

required

    identifier stringrequired

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

    A unique identifier for the scorecard.

    title stringrequired

    The 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]

    The combinator to use when evaluating the conditions.

    conditions

    object[]

    required

    Possible values: >= 1

    The conditions to evaluate.

  • 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@_=\\-]+$

    title stringrequired
    description string
    level stringrequired

    Possible values: [Gold, Silver, Bronze]

    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...
Last updated on