Search
K
Konnect Service Catalog

ScorecardFilterParameters

object

Scorecard

object

Representation of a scorecard.

idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

scoreobjectrequired

The current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.

Show Child Parameters
entity_selectorOne Of
required
Variant 1One Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

Show Child Parameters
scorecard_templatestringrequired

The name of the scorecard template used to create the scorecard.
Otherwise, null.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example

ScorecardWithCriteria

idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

scoreobjectrequired

The current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.

Show Child Parameters
entity_selectorOne Of
required
Variant 1One Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

Show Child Parameters
scorecard_templatestringrequired

The name of the scorecard template used to create the scorecard.
Otherwise, null.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

criteriaarray[object]required
Show Child Parameters
Example

CatalogServiceScorecard

idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

scoreobjectrequired

The current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.

Show Child Parameters
entity_selectorOne Of
required
Variant 1One Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

Show Child Parameters
scorecard_templatestringrequired

The name of the scorecard template used to create the scorecard.
Otherwise, null.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

criteriaarray[object]required
Show Child Parameters
Example

ScorecardEntitySelector

One Of
Variant 1One Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

Show Child Parameters
Example