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

Update to powershell SDK docs: 13790800396

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-11 14:40:01 +00:00
parent 662c0ec138
commit 40070d0b19
6 changed files with 31 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -143,6 +143,7 @@ This API completes a work item. Either an admin, or the owning/current user must
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the work item Path | Id | **String** | True | The ID of the work item
Body | Body | **String** | (optional) | Body is the request payload to create form definition request
### Return type ### Return type
[**WorkItems**](../models/work-items) [**WorkItems**](../models/work-items)
@@ -152,16 +153,20 @@ Code | Description | Data Type
------------- | ------------- | ------------- ------------- | ------------- | -------------
200 | A WorkItems object | WorkItems 200 | A WorkItems object | WorkItems
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 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. | ListAccessModelMetadataAttribute401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | 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 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. | ListAccessModelMetadataAttribute429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### Example ### Example
```powershell ```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item # Complete a Work Item
@@ -169,7 +174,7 @@ try {
Complete-BetaWorkItem -Id $Id Complete-BetaWorkItem -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Complete-BetaWorkItem -Id $Id # Complete-BetaWorkItem -Id $Id -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -376,15 +381,18 @@ Path | Id | **String** | True | ID of the work item.
Query | OwnerId | **String** | (optional) | ID of the work item owner. Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type ### Return type
[**WorkItems[]**](../models/work-items) [**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses ### Responses
Code | Description | Data Type Code | Description | Data Type
------------- | ------------- | ------------- ------------- | ------------- | -------------
200 | The work item with the given ID. | WorkItems[] 200 | The work item with the given ID. | SystemCollectionsHashtable
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 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. | ListAccessModelMetadataAttribute401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | 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 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. | ListAccessModelMetadataAttribute429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -392,8 +400,8 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "MyId" # String | ID of the work item. $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) $OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional)
# Get a Work Item # Get a Work Item

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

@@ -149,6 +149,7 @@ This API completes a work item. Either an admin, or the owning/current user must
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the work item Path | Id | **String** | True | The ID of the work item
Body | Body | **String** | (optional) | Body is the request payload to create form definition request
### Return type ### Return type
[**WorkItems**](../models/work-items) [**WorkItems**](../models/work-items)
@@ -165,12 +166,13 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### Example ### Example
```powershell ```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item # Complete a Work Item
@@ -178,7 +180,7 @@ try {
Complete-V2024WorkItem -Id $Id Complete-V2024WorkItem -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Complete-V2024WorkItem -Id $Id # Complete-V2024WorkItem -Id $Id -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md
View File

@@ -149,6 +149,7 @@ This API completes a work item. Either an admin, or the owning/current user must
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the work item Path | Id | **String** | True | The ID of the work item
Body | Body | **String** | (optional) | Body is the request payload to create form definition request
### Return type ### Return type
[**WorkItems**](../models/work-items) [**WorkItems**](../models/work-items)
@@ -165,12 +166,13 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### Example ### Example
```powershell ```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item # Complete a Work Item
@@ -178,7 +180,7 @@ try {
Complete-WorkItem -Id $Id Complete-WorkItem -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Complete-WorkItem -Id $Id # Complete-WorkItem -Id $Id -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -344,6 +346,7 @@ Path | Id | **String** | True | ID of the work item.
Code | Description | Data Type Code | Description | Data Type
------------- | ------------- | ------------- ------------- | ------------- | -------------
200 | The work item with the given ID. | WorkItems 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 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 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 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto

7
static/code-examples/beta/powershell_code_examples_overlay.yaml
View File

@@ -13770,6 +13770,7 @@
label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item
source: | source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item # Complete a Work Item
@@ -13777,7 +13778,7 @@
Complete-BetaWorkItem -Id $Id Complete-BetaWorkItem -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Complete-BetaWorkItem -Id $Id # Complete-BetaWorkItem -Id $Id -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -13875,8 +13876,8 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item
source: | source: |
$Id = "MyId" # String | ID of the work item. $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) $OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional)
# Get a Work Item # Get a Work Item

3
static/code-examples/v2024/powershell_code_examples_overlay.yaml
View File

@@ -16701,6 +16701,7 @@
label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item
source: | source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item # Complete a Work Item
@@ -16708,7 +16709,7 @@
Complete-V2024WorkItem -Id $Id Complete-V2024WorkItem -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Complete-V2024WorkItem -Id $Id # Complete-V2024WorkItem -Id $Id -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

3
static/code-examples/v3/powershell_code_examples_overlay.yaml
View File

@@ -9449,6 +9449,7 @@
label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item
source: | source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item # Complete a Work Item
@@ -9456,7 +9457,7 @@
Complete-WorkItem -Id $Id Complete-WorkItem -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Complete-WorkItem -Id $Id # Complete-WorkItem -Id $Id -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails