Search
K
Konnect Service Catalog

Delete Scorecard

Deletes a scorecard.

delete

Path Parameters

idstring(uuid)required

The id of the scorecard.

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

Response

204

Scorecard was deleted successfully.

delete/scorecards/{id}
 
204

List Scorecard Services

Lists services targeted by a scorecard.

get

Query Parameters

filterobject

Filters a collection of services targeted by a scorecard.

Show Child Parameters
sort

Sorts a collection of services targeted by a scorecard. Supported sort attributes are:

  • display_name
  • name
  • score.value
  • score.raw_value

Default sort is display_name in ascending order.

Path Parameters

idstring(uuid)required

The id of the scorecard.

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

Response

200 application/json

A paginated list response for a collection of services targeted by a scorecard.

* Additional properties are NOT allowed.
metarequired
dataarrayrequired

Service object that includes its score for the given scorecard.

Show Child Parameters
get/scorecards/{id}/services
 
200 application/json

List Scorecard Criteria

Lists criteria, including passing service counts, belonging to a scorecard.

get

Query Parameters

filterobject

Filters a collection of criteria belonging to a scorecard.

sort

Sorts a collection of criteria belonging to a scorecard. Supported sort attributes are:

  • evaluation.passing_services_count

By default, criteria will be returned in the order that they are configured in the scorecard.

Path Parameters

idstring(uuid)required

The id of the scorecard.

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

Response

200 application/json

A paginated list response for a collection of criteria belonging to a scorecard.

* Additional properties are NOT allowed.
metarequired
dataarrayrequired
Show Child Parameters
get/scorecards/{id}/criteria
 
200 application/json

List Scorecard Criteria Services

Lists services targeted by a scorecard criteria with evaluation results per-service.

get

Query Parameters

filterobject

Filters a collection of services targeted by a scorecard criteria.

Show Child Parameters
sort

Sorts a collection of services targeted by a scorecard criteria. Supported sort attributes are:

  • display_name
  • name
  • evaluation.is_passing
  • evaluation.successfully_evaluated_at
  • evaluation.attempted_at

Default sort is display_name in ascending order.

Path Parameters

scorecardIdstring(uuid)required

The id of the scorecard.

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

criteriaIdstring(uuid)required

The id of the criteria.

Example:5c1121f9-3f3a-47c7-9bb6-c81a51128714

Response

200 application/json

A paginated list response for a collection of services targeted by a scorecard criteria.

* Additional properties are NOT allowed.
metarequired
dataarrayrequired

Service object that includes its evaluation result for the given scorecard criteria.

Show Child Parameters
get/scorecards/{scorecardId}/criteria/{criteriaId}/services
 
200 application/json

List Catalog Service Scorecards

Returns a paginated collection of scorecards targeting the given service.

get

Query Parameters

filterobject

Filters a collection of scorecards.

sort

Sorts a collection of scorecards. Supported sort attributes are:

  • name
  • score.value
  • score.raw_value

Default sort is name in ascending order.

Path Parameters

idstringrequired

The id of the service.

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

Response

200 application/json

A paginated list response for a collection of scorecards targeting a service.

* Additional properties are NOT allowed.
metarequired
dataarray[object]required

Representation of a scorecard.

Show Child Parameters
get/services/{id}/scorecards
 
200 application/json