Files
developer.sailpoint.com/static/api-specs/idn/beta/schemas/reports/TaskResultDetails.yaml
2023-07-24 15:52:57 +00:00

146 lines
3.6 KiB
YAML

type: object
description: >-
Details about job or task type, state and lifecycle.
properties:
type:
type: string
enum:
- QUARTZ
- QPOC
- MENTOS
- QUEUED_TASK
description: >-
Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a
refresh/sync task.
example: 'MENTOS'
id:
type: string
description: >-
Unique task definition identifier.
example: 'a248c16fe22222b2bd49615481311111'
name:
type: string
description: >-
Name of the requesting report.
example: 'Identities Details Report'
description:
type: string
description: >-
Description of the report purpose and/or contents.
example: 'A detailed view of the identities in the system.'
parentName:
type: string
nullable: true
description: >-
Name of the parent task/report if exists.
example: 'Audit Report'
launcher:
type: string
description: >-
Name of the report processing initiator.
example: 'cloudadmin'
created:
type: integer
format: int64
description: >-
Report creation date in legacy long (int64) representation.
example: 1688633986104
launched:
type: integer
nullable: true
format: int64
description: >-
Report start date in legacy long (int64) representation.
example: 1688633988104
completed:
type: integer
nullable: true
format: int64
description: >-
Report completion date in legacy long (int64) representation.
example: 1688633989504
completionStatus:
type: string
nullable: true
enum:
- Success
- Warning
- Error
- Terminated
- TempError
description: >-
Report completion status.
example: 'Success'
messages:
type: array
description: >-
List of the messages dedicated to the report.
From task definition perspective here usually should be warnings or errors.
example: []
items:
type: object
properties:
type:
type: string
description: >-
Type of the message.
enum:
- Info
- Warn
- Error
example: 'Warn'
error:
type: boolean
default: false
description: >-
Flag whether message is an error.
example: false
warning:
type: boolean
default: false
description: >-
Flag whether message is a warning.
example: true
key:
type: string
description: >-
Message string identifier.
example: 'The following account(s) failed to correlate: A,B,C'
localizedText:
type: string
description: >-
Message context with the locale based language.
example: 'The following account(s) failed to correlate: A,B,C'
returns:
type: array
description: >-
Task definition results, if necessary.
example: []
items:
type: object
properties:
displayLabel:
type: string
description: >-
Attribute description.
example: ' '
attributeName:
type: string
description: >-
System or database attribute name.
example: ' '
attributes:
type: object
description: >-
Extra attributes map(dictionary) needed for the report.
example:
org: 'an-org'
pod: 'the-pod'
additionalProperties:
type: object
progress:
type: string
nullable: true
description: >-
Current report state.
example: 'Initializing...'