idstring(uuid)required
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Delete Scorecard
Deletes a scorecard.
delete
Path Parameters
Response
Response
Scorecard was deleted successfully.
delete/scorecards/{id}
Authentication
Path Parameters
Schedule Scorecard Evaluation
Schedules an evaluation of the scorecard selected services.
post
Path Parameters
idstring(uuid)required
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
Response
The scheduling for scorecard evaluation was accepted.
post/scorecards/{id}/schedule-evaluation
Authentication
Path Parameters
List Scorecard Services
Lists services targeted by a scorecard.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[number]integer
Determines which page of the entities to retrieve.
Example:1
filterobject
Filters a collection of services targeted by a scorecard.
Show Child Parameters
sortstring
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Path Parameters
idstring(uuid)required
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
application/json
Response
application/json
A paginated list response for a collection of services targeted by a scorecard.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
Service object that includes its score for the given scorecard.
Show Child Parameters
get/scorecards/{id}/catalog-services
Authentication
Path Parameters
Query Parameters
application/json
List Scorecard Criteria
Lists criteria, including passing service counts, belonging to a scorecard.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[number]integer
Determines which page of the entities to retrieve.
Example:1
filterobject
Filters a collection of criteria belonging to a scorecard.
Show Child Parameters
sortstring
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Path Parameters
idstring(uuid)required
The id of the scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
Response
application/json
Response
application/json
A paginated list response for a collection of criteria belonging to a scorecard.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
Show Child Parameters
get/scorecards/{id}/criteria
Authentication
Path Parameters
Query Parameters
application/json
List Scorecard Criteria Services
Lists services targeted by a scorecard criteria with evaluation results per-service.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[number]integer
Determines which page of the entities to retrieve.
Example:1
filterobject
Filters a collection of services targeted by a scorecard criteria.
Show Child Parameters
sortstring
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
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
application/json
Response
application/json
A paginated list response for a collection of services targeted by a scorecard criteria.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
Service object that includes its evaluation result for the given scorecard criteria.
Show Child Parameters
get/scorecards/{scorecardId}/criteria/{criteriaId}/catalog-services
Authentication
Path Parameters
Query Parameters
application/json