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 to powershell SDK docs: 13687248839

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-05 23:01:41 +00:00
parent 0416b2638d
commit cc16c76228
57 changed files with 463 additions and 1664 deletions
Download Patch File Download Diff File Expand all files Collapse all files

130
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md
View File

@@ -34,6 +34,7 @@ Method | HTTP request | Description
[**Approve-V2024ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
[**Approve-V2024ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
[**Complete-V2024WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
[**Invoke-V2024ForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Get-V2024CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items
[**Get-V2024CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items
[**Get-V2024CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items
@@ -42,7 +43,6 @@ Method | HTTP request | Description
[**Get-V2024WorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items
[**Deny-V2024ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item
[**Deny-V2024ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**Send-V2024WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Submit-V2024AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
@@ -186,6 +186,63 @@ try {
```
[[Back to top]](#)
## forward-work-item
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the work item
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True |
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Success, but no data is returned. |
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
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$WorkItemForward = @"{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}"@
# Forward a Work Item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardWorkItem"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-completed-work-items
This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
@@ -238,6 +295,9 @@ try {
[[Back to top]](#)
## get-count-completed-work-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
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/v2024/get-count-completed-work-items)
@@ -245,20 +305,19 @@ This gets a count of completed work items belonging to either the specified user
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItemsCount**](../models/work-items-count)
[**WorkItemsCount[]**](../models/work-items-count)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of work items | WorkItemsCount
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
200 | List of work items | WorkItemsCount[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
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
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
@@ -266,15 +325,16 @@ Code | Description | Data Type
### Example
```powershell
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Completed Work Items
try {
Get-V2024CountCompletedWorkItems
Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024CountCompletedWorkItems -OwnerId $OwnerId
# Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems"
Write-Host $_.ErrorDetails
@@ -562,58 +622,6 @@ try {
```
[[Back to top]](#)
## send-work-item-forward
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/v2024/send-work-item-forward)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the work item
Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True |
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Success, but no data is returned. |
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
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$WorkItemForward = @"{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}"@
# Forward a Work Item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Send-V2024WorkItemForward -Id $Id -WorkItemForward $Result
# Below is a request that includes all optional parameters
# Send-V2024WorkItemForward -Id $Id -WorkItemForward $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-account-selection
This API submits account selections. Either an admin, or the owning/current user must make this request.