Orchestrator
2023.4
false
Banner background image
Orchestrator API Guide
Last updated Nov 10, 2023

Queue Retention Policy Requests

Delete the Retention Policy of the Specified Queue

The following DELETE request to the /odata/QueueRetention({key}) endpoint allows you to reset the existing retention policy of the specified queue to the default built-in policy.
Note: By calling the DELETE endpoint for queues that have the default migration policy in place (that is, 120 days + deletion), it replaces it with the built-in retention policy of 30 days +deletion.

API Endpoint

DELETE https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/QueueRetention({key})

Request Headers

--header 'Authorization: Bearer {access_token}'\)\)
--header 'Content-Type: application/json' \)\)
--header 'X-UIPATH-OrganizationUnitId: {the_ID_of_the_folder_that_contains_the_queue}' \)--header 'Authorization: Bearer {access_token}'\)\)
--header 'Content-Type: application/json' \)\)
--header 'X-UIPATH-OrganizationUnitId: {the_ID_of_the_folder_that_contains_the_queue}' \)

Path Parameters

Param

Data type

Description

key

(required)

Int64

The ID of the queue for which you want to reset the retention policy to default.

Responses

204 Success

Resets the indicated queue policy to the default one of 30-day retention + deletion.

Example Request

Let's say you gathered all the information needed to build the API call.

  • The {key} is: 6789. This is the ID of the queue for which you want to reset the specific retention policy to default.
  • The X-UIPATH-OrganizationUnitId request header value is 202020. This is the ID of the folder that contains the queue for which you want to reset the custom retention policy to default. Learn how to identify the folder ID.
    curl --location --request DELETE '{OrchestratorURL}/odata/QueueRetention(6789)' \
    --header 'Authorization: Bearer 1234' \
    --header 'Content-Type: application/json' \
    --header 'X-UIPATH-OrganizationUnitId: 202020'curl --location --request DELETE '{OrchestratorURL}/odata/QueueRetention(6789)' \
    --header 'Authorization: Bearer 1234' \
    --header 'Content-Type: application/json' \
    --header 'X-UIPATH-OrganizationUnitId: 202020'

    A successful call (response code 204) resets the custom policy to the default one.

In the Orchestrator UI, the change is also visible in the Audit details of the corresponding queue Update feature action.



  • Delete the Retention Policy of the Specified Queue
  • API Endpoint
  • Request Headers
  • Path Parameters
  • Responses
  • 204 Success
  • Example Request

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.