mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 04:19:16 +00:00
78 lines
2.4 KiB
YAML
78 lines
2.4 KiB
YAML
get:
|
|
operationId: getTargetSummaries
|
|
tags:
|
|
- Certification Summaries
|
|
summary: Target Summaries for a Certification
|
|
description: >-
|
|
This API returns a list of the target summaries for a specific certification. A token with ORG_ADMIN or CERT_ADMIN
|
|
authority is required to call this API. Reviewers for this certification can also call this API.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- $ref: '../../v3/parameters/limit.yaml'
|
|
- $ref: '../../v3/parameters/offset.yaml'
|
|
- $ref: '../../v3/parameters/count.yaml'
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: >-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
|
|
**id**: *eq, in*
|
|
|
|
|
|
**completed**: *eq, ne*
|
|
|
|
|
|
**name**: *eq, sw*
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: >-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
|
|
Sorting is supported for the following fields: **name**
|
|
responses:
|
|
'200':
|
|
description: List of target summaries
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../../beta/schemas/TargetSummary.yaml'
|
|
example:
|
|
- id: 2c91808772a504f50172a9540e501ba7
|
|
name: Derek Grey
|
|
targetId: 2c9180857182306001719937379633e4
|
|
completed: false
|
|
- id: 2c91808772a504f50172a9540e501ba8
|
|
name: Mary LeMasters
|
|
targetId: 2c9180857182306001719937377a33de
|
|
completed: true
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|