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

Update python SDK docs: 15116515953

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -29,23 +29,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items
[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items
[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items
[**get-work-item**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item
[**get-work-items-summary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary
[**list-work-items**](#list-work-items) | **GET** `/work-items` | List Work Items
[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item
[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**send-work-item-forward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item
[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve approval items
[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a work item
[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed work items
[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count completed work items
[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count work items
[**get-work-item**](#get-work-item) | **GET** `/work-items/{id}` | Get a work item
[**get-work-items-summary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work items summary
[**list-work-items**](#list-work-items) | **GET** `/work-items` | List work items
[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item
[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject approval items
[**send-work-item-forward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a work item
[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit account selections
## approve-approval-item
Approve an Approval Item
Approve an approval item
This API approves an Approval Item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-item)
@@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client:
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Approve an Approval Item
# Approve an approval item
results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## approve-approval-items-in-bulk
Bulk approve Approval Items
Bulk approve approval items
This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-items-in-bulk)
@@ -149,7 +149,7 @@ 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
# Bulk approve approval items
results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
@@ -165,7 +165,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## complete-work-item
Complete a Work Item
Complete a work item
This API completes a work item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-work-item)
@@ -210,7 +210,7 @@ with ApiClient(configuration) as api_client:
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
# Complete a work item
results = WorkItemsApi(api_client).complete_work_item(id=id)
# Below is a request that includes all optional parameters
@@ -226,7 +226,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-completed-work-items
Completed Work Items
Completed work items
This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-completed-work-items)
@@ -274,7 +274,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# Completed Work Items
# Completed work items
results = WorkItemsApi(api_client).get_completed_work_items()
# Below is a request that includes all optional parameters
@@ -291,7 +291,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-count-completed-work-items
Count Completed Work Items
Count completed work items
This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-completed-work-items)
@@ -333,7 +333,7 @@ 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
# Count completed work items
results = WorkItemsApi(api_client).get_count_completed_work_items()
# Below is a request that includes all optional parameters
@@ -349,7 +349,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-count-work-items
Count Work Items
Count work items
This gets a count of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-work-items)
@@ -391,7 +391,7 @@ 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
# Count work items
results = WorkItemsApi(api_client).get_count_work_items()
# Below is a request that includes all optional parameters
@@ -407,7 +407,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-work-item
Get a Work Item
Get a work item
This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-item)
@@ -450,7 +450,7 @@ 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
# Get a work item
results = WorkItemsApi(api_client).get_work_item(id=id)
# Below is a request that includes all optional parameters
@@ -466,7 +466,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-work-items-summary
Work Items Summary
Work items summary
This gets a summary of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-items-summary)
@@ -508,7 +508,7 @@ 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
# Work items summary
results = WorkItemsApi(api_client).get_work_items_summary()
# Below is a request that includes all optional parameters
@@ -524,7 +524,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-work-items
List Work Items
List work items
This gets a collection of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-work-items)
@@ -572,7 +572,7 @@ 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:
# List Work Items
# List work items
results = WorkItemsApi(api_client).list_work_items()
# Below is a request that includes all optional parameters
@@ -589,7 +589,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-approval-item
Reject an Approval Item
Reject an approval item
This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-item)
@@ -634,7 +634,7 @@ with ApiClient(configuration) as api_client:
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Reject an Approval Item
# Reject an approval item
results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
@@ -650,7 +650,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-approval-items-in-bulk
Bulk reject Approval Items
Bulk reject approval items
This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-items-in-bulk)
@@ -693,7 +693,7 @@ 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
# Bulk reject approval items
results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
@@ -709,7 +709,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## send-work-item-forward
Forward a Work Item
Forward a work item
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/send-work-item-forward)
@@ -757,7 +757,7 @@ with ApiClient(configuration) as api_client:
}''' # WorkItemForward |
try:
# Forward a Work Item
# Forward a work item
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
@@ -771,7 +771,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-account-selection
Submit Account Selections
Submit account selections
This API submits account selections. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-account-selection)
@@ -816,7 +816,7 @@ with ApiClient(configuration) as api_client:
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
# Submit account selections
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