- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Process Data Retention Policy Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
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.
API Endpoint
DELETE https://cloud.uipath.com/{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 |
---|---|---|
(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 is202020
. 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 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/QueueRetention(6789)' \ --header 'Authorization: Bearer 1234' \ --header 'Content-Type: application/json' \ --header 'X-UIPATH-OrganizationUnitId: 202020'
curl --location --request DELETE 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/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.