LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

add method and model docs for powershell and python v2025

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-04-01 09:23:12 -04:00
parent c12ffb7efc
commit 5d8f458a33
2414 changed files with 191212 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
docs/tools/sdk/python/Reference/V2025/Models/TaskStatus.md Normal file
View File

@@ -0,0 +1,89 @@
---
id: v2025-task-status
title: TaskStatus
pagination_label: TaskStatus
sidebar_label: TaskStatus
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'TaskStatus', 'V2025TaskStatus']
slug: /tools/sdk/python/v2025/models/task-status
tags: ['SDK', 'Software Development Kit', 'TaskStatus', 'V2025TaskStatus']
---
# 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**](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**](task-status-message) | Messages associated with the task this TaskStatus represents | [required]
**returns** | [**[]TaskReturnDetails**](task-return-details) | 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**](task-definition-summary) | | [optional]
}
## Example
```python
from sailpoint.v2025.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.v2025.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.v2025.models.task_status_message.TaskStatusMessage(
type = 'INFO',
localized_text = sailpoint.v2025.models.localized_message.LocalizedMessage(
locale = 'An error has occurred!',
message = 'Error has occurred!', ),
key = 'akey',
parameters = [{name=value}], )
],
returns=[
sailpoint.v2025.models.task_return_details.TaskReturnDetails(
name = 'label',
attribute_name = 'identityCount', )
],
attributes={identityCount=0},
progress='Started',
percent_complete=100,
task_definition_summary=sailpoint.v2025.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]](#)