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

starting point for adding python sdk docs

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-20 12:59:19 -05:00
parent 3b9e39ca19
commit c18583ede4
2726 changed files with 370294 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/tools/sdk/python/Reference/V3/Models/TaskResultDetails.md Normal file
View File

@@ -0,0 +1,60 @@
---
id: task-result-details
title: TaskResultDetails
pagination_label: TaskResultDetails
sidebar_label: TaskResultDetails
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'TaskResultDetails', 'TaskResultDetails']
slug: /tools/sdk/python/v3/models/task-result-details
tags: ['SDK', 'Software Development Kit', 'TaskResultDetails', 'TaskResultDetails']
---
# TaskResultDetails
Details about job or task type, state and lifecycle.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'QUARTZ', 'QPOC', 'MENTOS', 'QUEUED_TASK' ] | 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. | [optional]
**id** | **str** | Unique task definition identifier. | [optional]
**report_type** | **Enum** [ 'ACCOUNTS', 'IDENTITIES_DETAILS', 'IDENTITIES', 'IDENTITY_PROFILE_IDENTITY_ERROR', 'ORPHAN_IDENTITIES', 'SEARCH_EXPORT', 'UNCORRELATED_ACCOUNTS' ] | Use this property to define what report should be processed in the RDE service. | [optional]
**description** | **str** | Description of the report purpose and/or contents. | [optional]
**parent_name** | **str** | Name of the parent task/report if exists. | [optional]
**launcher** | **str** | Name of the report processing initiator. | [optional]
**created** | **datetime** | Report creation date | [optional]
**launched** | **datetime** | Report start date | [optional]
**completed** | **datetime** | Report completion date | [optional]
**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR' ] | Report completion status. | [optional]
**messages** | [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional]
**returns** | [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional]
**attributes** | **map[string]object** | Extra attributes map(dictionary) needed for the report. | [optional]
**progress** | **str** | Current report state. | [optional]
}
## Example
```python
from sailpoint.v3.models.task_result_details import TaskResultDetails
task_result_details = TaskResultDetails(
type='MENTOS',
id='a248c16fe22222b2bd49615481311111',
report_type=IDENTITIES_DETAILS,
description='A detailed view of the identities in the system.',
parent_name='Audit Report',
launcher='cloudadmin',
created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
completion_status='Success',
messages=[],
returns=[],
attributes={org=an-org},
progress='Initializing...'
)
```
[[Back to top]](#)