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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-work-items
title: WorkItems
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/work-items
tags: ['SDK', 'Software Development Kit', 'WorkItems', 'BetaWorkItems']
---
# WorkItems
Use this API to implement work item functionality.
With this functionality in place, users can manage their work items (tasks).
@@ -46,9 +46,7 @@ Method | HTTP request | Description
[**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**Submit-BetaAccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
## approve-approval-item
This API approves an Approval Item. Either an admin, or the owning/current user must make this request.
### Parameters
@@ -58,7 +56,6 @@ Path | Id | **String** | True | The ID of the work item
Path | ApprovalItemId | **String** | True | The ID of the approval item.
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -70,7 +67,6 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -78,7 +74,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
# Approve an Approval Item
try {
Approve-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId
@@ -89,11 +87,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## approve-approval-items-in-bulk
This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.
### Parameters
@@ -102,7 +97,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the work item
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -114,14 +108,15 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
try {
Approve-BetaApprovalItemsInBulk-BetaId $Id
@@ -132,11 +127,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## complete-work-item
This API completes a work item. Either an admin, or the owning/current user must make this request.
### Parameters
@@ -145,7 +137,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the work item
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -157,14 +148,15 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Complete a Work Item
try {
Complete-BetaWorkItem-BetaId $Id
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## forward-work-item
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.
### Parameters
@@ -189,7 +178,6 @@ Path | Id | **String** | True | The ID of the work item
Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True |
### Return type
(empty response body)
### Responses
@@ -203,7 +191,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -215,7 +202,9 @@ $WorkItemForward = @"{
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}"@
# Forward a Work Item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Invoke-BetaForwardWorkItem-BetaId $Id -BetaWorkItemForward $Result
@@ -227,11 +216,8 @@ try {
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.
### Parameters
@@ -243,7 +229,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**WorkItems[]**](../models/work-items)
### Responses
@@ -255,7 +240,6 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -265,7 +249,9 @@ $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list bein
$Limit = 250 # Int32 | 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 # Int32 | 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)
$Count = $true # Boolean | 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)
# Completed Work Items
try {
Get-BetaCompletedWorkItems
@@ -276,11 +262,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-count-completed-work-items
This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
### Parameters
@@ -289,7 +272,6 @@ Param Type | Name | Data Type | Required | Description
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItemsCount[]**](../models/work-items-count)
### Responses
@@ -301,14 +283,15 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Completed Work Items
try {
Get-BetaCountCompletedWorkItems
@@ -319,11 +302,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-count-work-items
This gets a count of work items belonging to either the specified user(admin required), or the current user.
### Parameters
@@ -332,7 +312,6 @@ Param Type | Name | Data Type | Required | Description
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItemsCount**](../models/work-items-count)
### Responses
@@ -344,14 +323,15 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Work Items
try {
Get-BetaCountWorkItems
@@ -362,11 +342,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-work-item
This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.
### Parameters
@@ -376,7 +353,6 @@ Path | Id | **String** | True | ID of the work item.
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItems[]**](../models/work-items)
### Responses
@@ -388,7 +364,6 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -396,7 +371,9 @@ Code | Description | Data Type
```powershell
$Id = "MyId" # String | ID of the work item.
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Get a Work Item
try {
Get-BetaWorkItem-BetaId $Id
@@ -407,11 +384,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-work-items-summary
This gets a summary of work items belonging to either the specified user(admin required), or the current user.
### Parameters
@@ -420,7 +394,6 @@ Param Type | Name | Data Type | Required | Description
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItemsSummary**](../models/work-items-summary)
### Responses
@@ -432,14 +405,15 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Work Items Summary
try {
Get-BetaWorkItemsSummary
@@ -450,11 +424,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-work-items
This gets a collection of work items belonging to either the specified user(admin required), or the current user.
### Parameters
@@ -466,7 +437,6 @@ Param Type | Name | Data Type | Required | Description
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItems[]**](../models/work-items)
### Responses
@@ -478,7 +448,6 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -488,7 +457,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | 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)
$Count = $true # Boolean | 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)
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# List Work Items
try {
Get-BetaWorkItems
@@ -499,11 +470,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reject-approval-item
This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.
### Parameters
@@ -513,7 +481,6 @@ Path | Id | **String** | True | The ID of the work item
Path | ApprovalItemId | **String** | True | The ID of the approval item.
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -525,7 +492,6 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -533,7 +499,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
# Reject an Approval Item
try {
Deny-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId
@@ -544,11 +512,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reject-approval-items-in-bulk
This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.
### Parameters
@@ -557,7 +522,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the work item
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -569,14 +533,15 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
try {
Deny-BetaApprovalItemsInBulk-BetaId $Id
@@ -587,11 +552,8 @@ try {
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.
### Parameters
@@ -601,7 +563,6 @@ Path | Id | **String** | True | The ID of the work item
Body | RequestBody | [**map[string]AnyType**](https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4) | True | Account Selection Data map, keyed on fieldName
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -613,7 +574,6 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -621,7 +581,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName
# Submit Account Selections
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Submit-BetaAccountSelection-BetaId $Id -BetaRequestBody $Result
@@ -633,7 +595,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)