LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7194b934e86633cf09409d73337d62d52faea0ad
developer.sailpoint.com/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkItemsApi.md
darrell-thobe-sp bddfeda20e adding method and model docs
2025-01-23 10:09:40 -05:00

26 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
work-items WorkItems WorkItems WorkItems powershellsdk
powershell
PowerShell
sdk
WorkItems
/tools/sdk/powershell/beta/methods/work-items
SDK
Software Development Kit
WorkItems

WorkItems

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method HTTP request Description
Approve-BetaApprovalItem POST /work-items/{id}/approve/{approvalItemId} Approve an Approval Item
Approve-BetaApprovalItemsInBulk POST /work-items/bulk-approve/{id} Bulk approve Approval Items
Complete-BetaWorkItem POST /work-items/{id} Complete a Work Item
Invoke-BetaForwardWorkItem POST /work-items/{id}/forward Forward a Work Item
Get-BetaCompletedWorkItems GET /work-items/completed Completed Work Items
Get-BetaCountCompletedWorkItems GET /work-items/completed/count Count Completed Work Items
Get-BetaCountWorkItems GET /work-items/count Count Work Items
Get-BetaWorkItem GET /work-items/{id} Get a Work Item
Get-BetaWorkItemsSummary GET /work-items/summary Work Items Summary
Get-BetaWorkItems GET /work-items List Work Items
Deny-BetaApprovalItem POST /work-items/{id}/reject/{approvalItemId} Reject an Approval Item
Deny-BetaApprovalItemsInBulk POST /work-items/bulk-reject/{id} Bulk reject Approval Items
Submit-BetaAccountSelection 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

Param Type Name Data Type Required Description
Path Id String True The ID of the work item
Path ApprovalItemId String True The ID of the approval item.

Return type

WorkItems

Responses

Code Description Data Type
200 A work items details object. WorkItems
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$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 
    
    # Below is a request that includes all optional parameters
    # Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem"
    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

Param Type Name Data Type Required Description
Path Id String True The ID of the work item

Return type

WorkItems

Responses

Code Description Data Type
200 A work items details object. WorkItems
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
try {
    Approve-BetaApprovalItemsInBulk-BetaId $Id 
    
    # Below is a request that includes all optional parameters
    # Approve-BetaApprovalItemsInBulk -BetaId $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk"
    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

Param Type Name Data Type Required Description
Path Id String True The ID of the work item

Return type

WorkItems

Responses

Code Description Data Type
200 A WorkItems object WorkItems
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Complete a Work Item
try {
    Complete-BetaWorkItem-BetaId $Id 
    
    # Below is a request that includes all optional parameters
    # Complete-BetaWorkItem -BetaId $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem"
    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

Param Type Name Data Type Required Description
Path Id String True The ID of the work item
Body WorkItemForward WorkItemForward 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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$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
    Invoke-BetaForwardWorkItem-BetaId $Id -BetaWorkItemForward $Result
    
    # Below is a request that includes all optional parameters
    # Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $WorkItemForward  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem"
    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

Param Type Name Data Type Required Description
Query OwnerId String (optional) The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.
Query Limit Int32 (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query Offset Int32 (optional) (default to 0) Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
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 for more information.

Return type

WorkItems[]

Responses

Code Description Data Type
200 List of completed work items. WorkItems[]
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$OwnerId = "MyOwnerId" # String | 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 # 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
    
    # Below is a request that includes all optional parameters
    # Get-BetaCompletedWorkItems -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems"
    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

Param Type Name Data Type Required Description
Query OwnerId String (optional) ID of the work item owner.

Return type

WorkItemsCount[]

Responses

Code Description Data Type
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Completed Work Items
try {
    Get-BetaCountCompletedWorkItems
    
    # Below is a request that includes all optional parameters
    # Get-BetaCountCompletedWorkItems -BetaOwnerId $OwnerId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems"
    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

Param Type Name Data Type Required Description
Query OwnerId String (optional) ID of the work item owner.

Return type

WorkItemsCount

Responses

Code Description Data Type
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Work Items
try {
    Get-BetaCountWorkItems
    
    # Below is a request that includes all optional parameters
    # Get-BetaCountWorkItems -BetaOwnerId $OwnerId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems"
    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

Param Type Name Data Type Required Description
Path Id String True ID of the work item.
Query OwnerId String (optional) ID of the work item owner.

Return type

WorkItems[]

Responses

Code Description Data Type
200 The work item with the given ID. WorkItems[]
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$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 
    
    # Below is a request that includes all optional parameters
    # Get-BetaWorkItem -BetaId $Id -BetaOwnerId $OwnerId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem"
    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

Param Type Name Data Type Required Description
Query OwnerId String (optional) ID of the work item owner.

Return type

WorkItemsSummary

Responses

Code Description Data Type
200 List of work items WorkItemsSummary
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Work Items Summary
try {
    Get-BetaWorkItemsSummary
    
    # Below is a request that includes all optional parameters
    # Get-BetaWorkItemsSummary -BetaOwnerId $OwnerId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary"
    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

Param Type Name Data Type Required Description
Query Limit Int32 (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query Offset Int32 (optional) (default to 0) Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
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 for more information.
Query OwnerId String (optional) ID of the work item owner.

Return type

WorkItems[]

Responses

Code Description Data Type
200 List of work items WorkItems[]
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$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)
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# List Work Items
try {
    Get-BetaWorkItems
    
    # Below is a request that includes all optional parameters
    # Get-BetaWorkItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaOwnerId $OwnerId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems"
    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

Param Type Name Data Type Required Description
Path Id String True The ID of the work item
Path ApprovalItemId String True The ID of the approval item.

Return type

WorkItems

Responses

Code Description Data Type
200 A work items details object. WorkItems
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$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 
    
    # Below is a request that includes all optional parameters
    # Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem"
    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

Param Type Name Data Type Required Description
Path Id String True The ID of the work item

Return type

WorkItems

Responses

Code Description Data Type
200 A work items details object. WorkItems
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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
try {
    Deny-BetaApprovalItemsInBulk-BetaId $Id 
    
    # Below is a request that includes all optional parameters
    # Deny-BetaApprovalItemsInBulk -BetaId $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk"
    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

Param Type Name Data Type Required Description
Path Id String True The ID of the work item
Body RequestBody map[string]AnyType True Account Selection Data map, keyed on fieldName

Return type

WorkItems

Responses

Code Description Data Type
200 A work items details object. WorkItems
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

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$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
    
    # Below is a request that includes all optional parameters
    # Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $RequestBody  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection"
    Write-Host $_.ErrorDetails
}

[Back to top]