diff --git a/idn/beta/paths/task-status-list.yaml b/idn/beta/paths/task-status-list.yaml new file mode 100644 index 00000000..8f19b73b --- /dev/null +++ b/idn/beta/paths/task-status-list.yaml @@ -0,0 +1,61 @@ +# +# Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. +# +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* + **schedule**: *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: + - oauth2: [idn:task-management:read] \ No newline at end of file diff --git a/idn/beta/paths/task-status.yaml b/idn/beta/paths/task-status.yaml index 42058d02..15f8f2f0 100644 --- a/idn/beta/paths/task-status.yaml +++ b/idn/beta/paths/task-status.yaml @@ -4,7 +4,7 @@ get: tags: - Task Management - summary: Retrieve a task status by task ID. + summary: Get task status by ID. description: Get a TaskStatus for a task by task ID. operationId: getTaskStatus parameters: @@ -28,13 +28,22 @@ get: description: Forbidden, generally due to a lack of security rights "404": description: TaskStatus with the given id was not found. + "400": + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' security: - UserContextAuth: [idn:task-management:read] patch: tags: - Task Management - summary: Update task status by task ID + summary: Update task status by ID description: Update a current TaskStatus for a task by task ID. + operationId: updateTaskStatus parameters: - name: id in: path @@ -64,5 +73,11 @@ patch: $ref: '../../v3/responses/403.yaml' "404": $ref: '../../v3/responses/404.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' security: - UserContextAuth: [idn:task-management:write] diff --git a/idn/beta/schemas/TaskReturnDetails.yaml b/idn/beta/schemas/TaskReturnDetails.yaml index 25ee3c3c..a47800ce 100644 --- a/idn/beta/schemas/TaskReturnDetails.yaml +++ b/idn/beta/schemas/TaskReturnDetails.yaml @@ -11,3 +11,4 @@ properties: attributeName: description: Attribute the TaskReturnDetails is for type: string + example: identityCount diff --git a/idn/beta/schemas/TaskStatus.yaml b/idn/beta/schemas/TaskStatus.yaml index cde42441..538797a8 100644 --- a/idn/beta/schemas/TaskStatus.yaml +++ b/idn/beta/schemas/TaskStatus.yaml @@ -29,6 +29,7 @@ properties: - QUARTZ - QPOC - QUEUED_TASK + example: QUARTZ uniqueName: description: Name of the task this TaskStatus represents type: string @@ -49,18 +50,22 @@ properties: description: Creation date of the task this TaskStatus represents type: string format: date-time + example: '2020-07-11T21:23:15.000Z' modified: description: Last modification date of the task this TaskStatus represents type: string format: date-time + example: '2020-07-11T21:23:15.000Z' launched: description: Launch date of the task this TaskStatus represents type: string format: date-time + example: '2020-07-11T21:23:15.000Z' completed: description: Completion date of the task this TaskStatus represents type: string format: date-time + example: '2020-07-11T21:23:15.000Z' completionStatus: description: Completion status of the task this TaskStatus represents type: string @@ -70,6 +75,7 @@ properties: - Error - Terminated - TempError + example: Success messages: description: Messages associated with the task this TaskStatus represents type: array @@ -84,9 +90,12 @@ properties: description: Attributes of the task this TaskStatus represents type: object additionalProperties: true + example: {"identityCount": 0} progress: description: Current progress of the task this TaskStatus represents type: string + example: 'Started' percentComplete: description: Current percentage completion of the task this TaskStatus represents type: integer + example: 100 diff --git a/idn/beta/schemas/TaskStatusMessage.yaml b/idn/beta/schemas/TaskStatusMessage.yaml index c4751a9f..b0e7a66d 100644 --- a/idn/beta/schemas/TaskStatusMessage.yaml +++ b/idn/beta/schemas/TaskStatusMessage.yaml @@ -13,14 +13,17 @@ properties: - INFO - WARN - ERROR + example: INFO localizedText: description: Localized form of the message $ref: './LocalizedMessage.yaml' key: description: Key of the message type: string + example: akey parameters: description: Message parameters for internationalization type: array items: type: object + example: [{ "name": "value"}]