Search
K
Konnect Service Catalog

ScorecardScore

object

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.

valuestringrequired

The human-readable score value coverted to the Scorecard’s assigned grading system.

Example:88%

raw_valuenumberrequired

The raw, numeric score calculated during evaluation of the scorecard.
Rounded to 3 decimal places.

>= 0<= 100

Example:87.5

Example

ScorecardServiceFilterParameters

object
idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
display_nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
custom_fieldsOne Of

Filter by custom fields using dot-notation to specify the custom field.
Filter operators are dictated by the custom field type. For example:

  • filter[custom_fields.owner]
  • filter[custom_fields.owner][neq]=kong
  • filter[custom_fields.dashboard.link][contains]=https
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
labelsOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

updated_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

score.valueOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
score.raw_valueOne Of
NumericFieldFilterOne Of

Filter by a numeric value.

Variant 1number

Value strictly equals the given numeric value.

Example:21

Example

ScorecardService

object

Service object that includes its score for the given scorecard.

idstring(uuid)requiredread-only

The service ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Match pattern:^[0-9a-z.-]+$

>= 1 characters<= 120 characters

Example:user-svc

display_namestringrequired

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstringrequired

Optionally provide a description of the Service.

<= 2048 characters

custom_fieldsobjectrequired

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

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
Example

ScorecardCriteriaFilterParameters

object
evaluation.passing_services_countOne Of
NumericFieldFilterOne Of

Filter by a numeric value.

Variant 1number

Value strictly equals the given numeric value.

Example:21

Example

ScorecardCriteriaServiceFilterParameters

object
idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
display_nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
custom_fieldsOne Of

Filter by custom fields using dot-notation to specify the custom field.
Filter operators are dictated by the custom field type. For example:

  • filter[custom_fields.owner]
  • filter[custom_fields.owner][neq]=kong
  • filter[custom_fields.dashboard.link][contains]=https
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
labelsOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

updated_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

evaluation.is_passingOne Of
BooleanFieldFilterboolean

Filter by a boolean value (true/false).

evaluation.successfully_evaluated_atOne Of
DateTimeFieldFilterOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

evaluation.attempted_atOne Of
DateTimeFieldFilterOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

Example