mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
93 lines
2.4 KiB
YAML
93 lines
2.4 KiB
YAML
description: Details and current status of a specific task
|
|
required:
|
|
- id
|
|
- type
|
|
- uniqueName
|
|
- description
|
|
- parentName
|
|
- attributes
|
|
- created
|
|
- modified
|
|
- launched
|
|
- launcher
|
|
- completed
|
|
- completionStatus
|
|
- messages
|
|
- progress
|
|
- percentComplete
|
|
- returns
|
|
type: object
|
|
properties:
|
|
id:
|
|
description: System-generated unique ID of the task this TaskStatus represents
|
|
type: string
|
|
example: id12345
|
|
type:
|
|
description: Type of task this TaskStatus represents
|
|
type: string
|
|
enum:
|
|
- QUARTZ
|
|
- QPOC
|
|
- QUEUED_TASK
|
|
uniqueName:
|
|
description: Name of the task this TaskStatus represents
|
|
type: string
|
|
example: Big Task
|
|
description:
|
|
description: Description of the task this TaskStatus represents
|
|
type: string
|
|
example: A Really Big Task
|
|
parentName:
|
|
description: Name of the parent of the task this TaskStatus represents
|
|
type: string
|
|
example: Parent Task
|
|
launcher:
|
|
description: Service to execute the task this TaskStatus represents
|
|
type: string
|
|
example: sweep
|
|
created:
|
|
description: Creation date of the task this TaskStatus represents
|
|
type: string
|
|
format: date-time
|
|
modified:
|
|
description: Last modification date of the task this TaskStatus represents
|
|
type: string
|
|
format: date-time
|
|
launched:
|
|
description: Launch date of the task this TaskStatus represents
|
|
type: string
|
|
format: date-time
|
|
completed:
|
|
description: Completion date of the task this TaskStatus represents
|
|
type: string
|
|
format: date-time
|
|
completionStatus:
|
|
description: Completion status of the task this TaskStatus represents
|
|
type: string
|
|
enum:
|
|
- Success
|
|
- Warning
|
|
- Error
|
|
- Terminated
|
|
- TempError
|
|
messages:
|
|
description: Messages associated with the task this TaskStatus represents
|
|
type: array
|
|
items:
|
|
$ref: './TaskStatusMessage.yaml'
|
|
returns:
|
|
description: Return values from the task this TaskStatus represents
|
|
type: array
|
|
items:
|
|
$ref: './TaskReturnDetails.yaml'
|
|
attributes:
|
|
description: Attributes of the task this TaskStatus represents
|
|
type: object
|
|
additionalProperties: true
|
|
progress:
|
|
description: Current progress of the task this TaskStatus represents
|
|
type: string
|
|
percentComplete:
|
|
description: Current percentage completion of the task this TaskStatus represents
|
|
type: integer
|