LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 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

95
docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md
View File

@@ -78,7 +78,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -86,6 +85,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
@@ -93,12 +93,12 @@ with ApiClient(configuration) as api_client:
try:
# Approve an Approval Item
results =WorkItemsApi(api_client).approve_approval_item(id, approval_item_id)
results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id)
print("The response of WorkItemsApi->approve_approval_item:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e)
```
@@ -139,7 +139,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -147,18 +146,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Bulk approve Approval Items
results =WorkItemsApi(api_client).approve_approval_items_in_bulk(id)
results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id)
print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e)
```
@@ -177,6 +177,7 @@ This API completes a work item. Either an admin, or the owning/current user must
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the work item
Body | body | **str** | (optional) | Body is the request payload to create form definition request
### Return type
[**WorkItems**](../models/work-items)
@@ -193,13 +194,12 @@ Code | Description | Data Type | Response headers |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -207,18 +207,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional)
try:
# Complete a Work Item
results =WorkItemsApi(api_client).complete_work_item(id)
results = WorkItemsApi(api_client).complete_work_item(id=id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).complete_work_item(id)
# results = WorkItemsApi(api_client).complete_work_item(id, new_body)
print("The response of WorkItemsApi->complete_work_item:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e)
```
@@ -261,7 +263,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -269,6 +270,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional)
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)
@@ -278,12 +280,12 @@ with ApiClient(configuration) as api_client:
try:
# Completed Work Items
results =WorkItemsApi(api_client).get_completed_work_items()
results = WorkItemsApi(api_client).get_completed_work_items()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count)
print("The response of WorkItemsApi->get_completed_work_items:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e)
```
@@ -323,7 +325,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items_count import WorkItemsCount
@@ -331,18 +332,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Completed Work Items
results =WorkItemsApi(api_client).get_count_completed_work_items()
results = WorkItemsApi(api_client).get_count_completed_work_items()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id)
print("The response of WorkItemsApi->get_count_completed_work_items:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e)
```
@@ -382,7 +384,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items_count import WorkItemsCount
@@ -390,18 +391,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Work Items
results =WorkItemsApi(api_client).get_count_work_items()
results = WorkItemsApi(api_client).get_count_work_items()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_count_work_items(owner_id)
print("The response of WorkItemsApi->get_count_work_items:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e)
```
@@ -428,6 +430,7 @@ Path | id | **str** | True | ID of the work item.
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | The work item with the given ID. | WorkItems | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
@@ -441,7 +444,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -449,18 +451,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item.
try:
# Get a Work Item
results =WorkItemsApi(api_client).get_work_item(id)
results = WorkItemsApi(api_client).get_work_item(id=id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_work_item(id)
print("The response of WorkItemsApi->get_work_item:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e)
```
@@ -500,7 +503,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items_summary import WorkItemsSummary
@@ -508,18 +510,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Work Items Summary
results =WorkItemsApi(api_client).get_work_items_summary()
results = WorkItemsApi(api_client).get_work_items_summary()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_work_items_summary(owner_id)
print("The response of WorkItemsApi->get_work_items_summary:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e)
```
@@ -562,7 +565,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -570,6 +572,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)
@@ -579,12 +582,12 @@ with ApiClient(configuration) as api_client:
try:
# List Work Items
results =WorkItemsApi(api_client).list_work_items()
results = WorkItemsApi(api_client).list_work_items()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id)
print("The response of WorkItemsApi->list_work_items:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e)
```
@@ -626,7 +629,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -634,6 +636,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
@@ -641,12 +644,12 @@ with ApiClient(configuration) as api_client:
try:
# Reject an Approval Item
results =WorkItemsApi(api_client).reject_approval_item(id, approval_item_id)
results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id)
print("The response of WorkItemsApi->reject_approval_item:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e)
```
@@ -687,7 +690,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -695,18 +697,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Bulk reject Approval Items
results =WorkItemsApi(api_client).reject_approval_items_in_bulk(id)
results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id)
print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e)
```
@@ -747,7 +750,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_item_forward import WorkItemForward
@@ -755,22 +757,22 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
work_item_forward = {
work_item_forward = '''{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
} # WorkItemForward |
}''' # WorkItemForward |
try:
# Forward a Work Item
new_work_item_forward = WorkItemForward()
new_work_item_forward.from_json(work_item_forward)
WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward)
new_work_item_forward = WorkItemForward.from_json(work_item_forward)
WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters
# WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e)
```
@@ -812,7 +814,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
@@ -820,20 +821,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName
try:
# Submit Account Selections
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =WorkItemsApi(api_client).submit_account_selection(id, new_request_body)
new_request_body = RequestBody.from_json(request_body)
results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body)
print("The response of WorkItemsApi->submit_account_selection:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e)
```