Skip to main content

TaskStatus

Details and current status of a specific task

Properties

NameTypeDescriptionNotes
idstrSystem-generated unique ID of the task this TaskStatus represents[required]
typeEnum [ 'QUARTZ', 'QPOC', 'QUEUED_TASK' ]Type of task this TaskStatus represents[required]
unique_namestrName of the task this TaskStatus represents[required]
descriptionstrDescription of the task this TaskStatus represents[required]
parent_namestrName of the parent of the task this TaskStatus represents[required]
launcherstrService to execute the task this TaskStatus represents[required]
targetTarget[optional]
createddatetimeCreation date of the task this TaskStatus represents[required]
modifieddatetimeLast modification date of the task this TaskStatus represents[required]
launcheddatetimeLaunch date of the task this TaskStatus represents[required]
completeddatetimeCompletion date of the task this TaskStatus represents[required]
completion_statusEnum [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMPERROR' ]Completion status of the task this TaskStatus represents[required]
messages[]TaskStatusMessageMessages associated with the task this TaskStatus represents[required]
returns[]TaskReturnDetailsReturn values from the task this TaskStatus represents[required]
attributesmap[string]objectAttributes of the task this TaskStatus represents[required]
progressstrCurrent progress of the task this TaskStatus represents[required]
percent_completeintCurrent percentage completion of the task this TaskStatus represents[required]
task_definition_summaryTaskDefinitionSummary[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 = {mantisExecutor=com.sailpoint.mantis.sources.task.AccountAggregationTask, eventClassesCsv=sailpoint.thunderbolt.events.AggregationEvents, serviceClass=sailpoint.thunderbolt.service.AggregationService, serviceMethod=accountAggregationTask}, )
)

[Back to top]