developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Models/TaskStatus.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-task-status	TaskStatus	TaskStatus	TaskStatus	pythonsdk	python Python sdk TaskStatus V2024TaskStatus	/tools/sdk/python/v2024/models/task-status	SDK Software Development Kit TaskStatus V2024TaskStatus

TaskStatus

Details and current status of a specific task

Properties

Name	Type	Description	Notes
id	str	System-generated unique ID of the task this TaskStatus represents	[required]
type	Enum [ 'QUARTZ', 'QPOC', 'QUEUED_TASK' ]	Type of task this TaskStatus represents	[required]
unique_name	str	Name of the task this TaskStatus represents	[required]
description	str	Description of the task this TaskStatus represents	[required]
parent_name	str	Name of the parent of the task this TaskStatus represents	[required]
launcher	str	Service to execute the task this TaskStatus represents	[required]
target	Target		[optional]
created	datetime	Creation date of the task this TaskStatus represents	[required]
modified	datetime	Last modification date of the task this TaskStatus represents	[required]
launched	datetime	Launch date of the task this TaskStatus represents	[required]
completed	datetime	Completion date of the task this TaskStatus represents	[required]
completion_status	Enum [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMPERROR' ]	Completion status of the task this TaskStatus represents	[required]
messages	[]TaskStatusMessage	Messages associated with the task this TaskStatus represents	[required]
returns	[]TaskReturnDetails	Return values from the task this TaskStatus represents	[required]
attributes	map[string]object	Attributes of the task this TaskStatus represents	[required]
progress	str	Current progress of the task this TaskStatus represents	[required]
percent_complete	int	Current percentage completion of the task this TaskStatus represents	[required]
task_definition_summary	TaskDefinitionSummary		[optional]
}

Example

from sailpoint.v2024.models.task_status import TaskStatus

task_status = TaskStatus(
id='id12345',
type='QUARTZ',
unique_name='Big Task',
description='A Really Big Task',
parent_name='Parent Task',
launcher='sweep',
target=sailpoint.v2024.models.target.Target(
                    id = 'c6dc37bf508149b28ce5b7d90ca4bbf9', 
                    type = 'APPLICATION', 
                    name = 'Active Directory [source]', ),
created='2020-07-11T21:23:15Z',
modified='2020-07-11T21:23:15Z',
launched='2020-07-11T21:23:15Z',
completed='2020-07-11T21:23:15Z',
completion_status='SUCCESS',
messages=[
                    sailpoint.v2024.models.task_status_message.TaskStatusMessage(
                        type = 'INFO', 
                        localized_text = sailpoint.v2024.models.localized_message.LocalizedMessage(
                            locale = 'An error has occurred!', 
                            message = 'Error has occurred!', ), 
                        key = 'akey', 
                        parameters = [{name=value}], )
                    ],
returns=[
                    sailpoint.v2024.models.task_return_details.TaskReturnDetails(
                        name = 'label', 
                        attribute_name = 'identityCount', )
                    ],
attributes={identityCount=0},
progress='Started',
percent_complete=100,
task_definition_summary=sailpoint.v2024.models.task_definition_summary.TaskDefinitionSummary(
                    id = '2c91808475b4334b0175e1dff64b63c5', 
                    unique_name = 'Cloud Account Aggregation', 
                    description = 'Aggregates from the specified application.', 
                    parent_name = 'Cloud Account Aggregation', 
                    executor = 'sailpoint.task.ServiceTaskExecutor', 
                    arguments = { }, )
)

[Back to top]