Orchestrator API ガイド

デリバリー:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

最終更新日時 2024年11月20日

キューの保持ポリシーの要求

指定したキューの保持ポリシーを削除する

/odata/QueueRetention({key}) エンドポイントに次の DELETE 要求を使用すると、指定したキューの既存の保持ポリシーを既定の組み込みポリシーにリセットできます。

注: 既定の移行ポリシー (つまり 120 日 + 削除) が設定されているキューに対して DELETE エンドポイントを呼び出すと、組み込みの保持ポリシー (30 日 + 削除) に置き換えられます。

API エンドポイント

DELETE https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueRetention({key})

要求ヘッダー

--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}' \

パスパラメーター

パラメーター	データ型	説明
`key` (必須)	Int64	保持ポリシーを既定にリセットするキューの ID です。

応答

204 Success

指定したキューポリシーを、既定のポリシー (30 日間の保持 + 削除) にリセットします。

要求の例

API 呼び出しの構築に必要な情報をすべて収集したとします。

{key} は 6789 です。これは、特定の保持ポリシーを既定にリセットするキューの ID です。

X-UIPATH-OrganizationUnitId 要求のヘッダー値は 202020 です。これは、カスタムの保持ポリシーを既定にリセットするキューを含むフォルダーの ID です。フォルダー ID の識別方法については、こちらをご覧ください。

curl --location --request DELETE 'https://govcloud.uipath.us/{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://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueRetention(6789)' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId: 202020'

呼び出しが成功すると (応答コード 204)、カスタムポリシーは既定のポリシーにリセットされます。

Orchestrator の UI では、この変更は対応するキューの 機能の更新アクションの監査の詳細情報にも表示されます。