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

Update to python SDK docs: 13820107626

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md
View File

@@ -57,13 +57,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
@@ -75,7 +75,7 @@ with ApiClient(configuration) as api_client:
TaskManagementApi(api_client).get_pending_task_headers()
# Below is a request that includes all optional parameters
# TaskManagementApi(api_client).get_pending_task_headers(offset, limit, count)
except Exception as e:
except Exception as e:
print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e)
```
@@ -118,7 +118,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_status import TaskStatus
@@ -126,6 +125,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
@@ -134,12 +134,12 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve Pending Task Status List
results =TaskManagementApi(api_client).get_pending_tasks()
results = TaskManagementApi(api_client).get_pending_tasks()
# Below is a request that includes all optional parameters
# results = TaskManagementApi(api_client).get_pending_tasks(offset, limit, count)
print("The response of TaskManagementApi->get_pending_tasks:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e)
```
@@ -180,7 +180,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_status import TaskStatus
@@ -188,18 +187,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID.
try:
# Get Task Status by ID
results =TaskManagementApi(api_client).get_task_status(id)
results = TaskManagementApi(api_client).get_task_status(id=id)
# Below is a request that includes all optional parameters
# results = TaskManagementApi(api_client).get_task_status(id)
print("The response of TaskManagementApi->get_task_status:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e)
```
@@ -245,7 +245,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_status import TaskStatus
@@ -253,6 +252,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
@@ -263,12 +263,12 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve Task Status List
results =TaskManagementApi(api_client).get_task_status_list()
results = TaskManagementApi(api_client).get_task_status_list()
# Below is a request that includes all optional parameters
# results = TaskManagementApi(api_client).get_task_status_list(limit, offset, count, filters, sorters)
print("The response of TaskManagementApi->get_task_status_list:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e)
```
@@ -310,7 +310,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -319,26 +318,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID.
[sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | The JSONPatch payload used to update the object.
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object.
try:
# Update Task Status by ID
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =TaskManagementApi(api_client).update_task_status(id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = TaskManagementApi(api_client).update_task_status(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = TaskManagementApi(api_client).update_task_status(id, new_json_patch_operation)
print("The response of TaskManagementApi->update_task_status:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e)
```