mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-08 12:27:48 +00:00
1013fe10a3
* Fixed sorter/filter descriptions for several endpoints. Moved beta collection tags into alphabetic order. * Fixed the remaining sorter/filter linter errors * Removed default value from sorter params as they are not valid.' by github action: 6708027043
68 lines
1.9 KiB
YAML
68 lines
1.9 KiB
YAML
get:
|
|
tags:
|
|
- Task Management
|
|
summary: Retrieve a task status list.
|
|
description: Get a TaskStatus list.
|
|
operationId: getTaskStatusList
|
|
parameters:
|
|
- $ref: '../../v3/parameters/limit.yaml'
|
|
- $ref: '../../v3/parameters/offset.yaml'
|
|
- $ref: '../../v3/parameters/count.yaml'
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
example: completionStatus eq "Success"
|
|
required: false
|
|
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*
|
|
|
|
|
|
**sourceId**: *eq, in*
|
|
|
|
|
|
**completionStatus**: *eq, in*
|
|
|
|
|
|
**type**: *eq, in*
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: -created
|
|
required: false
|
|
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: **created**
|
|
responses:
|
|
"200":
|
|
description: Responds with a TaskStatus for the task with the given task ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/TaskStatus.yaml'
|
|
'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'
|
|
security:
|
|
- UserContextAuth: [idn:task-management:read] |