- 基本情報
- Swagger の定義
- Orchestrator API
ジョブとキュー アイテムのダウンロード URL を取得し、実行ビデオ記録を削除するための API 要求です。
ビデオ録画が有効化されている場合、無人実行でビデオ録画が生成され、システムのストレージ バケットに保存されることができます。これらの要求を使用すると、ジョブまたはキュー アイテムの記録の期間限定のダウンロード URL を取得して削除できます。
これらのエンドポイントでは、テナントとストレージ バケットを構成するために ビデオ録画を有効化 する必要があります。ビデオ録画が有効化されていない場合、要求はエラーを返します。
read要求によって返されるダウンロード URL は、各記録ファイルを直接指す、期間限定の SAS (Shared Access Signature) URL です。ファイル名を知る必要はありません。応答には、記録ごとにすぐに使用できる URL が 1 つ含まれます。返された各 Uriに GET 要求を発行して、記録をダウンロードします。
必要なアクセス許可
| 要求 | 権限 |
|---|---|
| ジョブの記録を取得 ダウンロード URL | Jobs.View ] と [ ExecutionMedia.View |
| ジョブの記録を削除する | Jobs.Delete ] と [ ExecutionMedia.Delete |
| キュー アイテムの記録を取得 ダウンロード URL | Jobs.View、Queues.View、ExecutionMedia.View |
| キュー アイテムの記録を削除する | Queues.Delete ] と [ ExecutionMedia.Delete |
ジョブの記録のダウンロード URL を取得する
この GET 要求は、ジョブに関連付けられたすべての記録のダウンロード URL を返します。ジョブは {jobKey}で識別されます。このは、ジョブの GUID Key フィールドです (数値の Idではありません)。たとえば、ジョブの要求からジョブのKeyを取得できます。たとえば、 は Keyを返すGET /odata/Jobs?$filter=Id eq 125161。
API エンドポイント
GET
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/jobs/{jobKey}/read
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | ベアラー {access_token} |
| X-UIPATH-OrganizationUnitId | {folder_Id} |
応答コード
200 OK
応答本文
[
{
"Uri": "https://{storage-account}.blob.core.windows.net/orchestrator/.../recording_1.mp4?sv=2023-01-03&se=2026-06-24T12%3A30%3A00Z&sr=b&sp=r&sig=...",
"Verb": "GET",
"RequiresAuth": false,
"Headers": null
}
]
[
{
"Uri": "https://{storage-account}.blob.core.windows.net/orchestrator/.../recording_1.mp4?sv=2023-01-03&se=2026-06-24T12%3A30%3A00Z&sr=b&sp=r&sig=...",
"Verb": "GET",
"RequiresAuth": false,
"Headers": null
}
]
ジョブには最大 10 個の記録ファイルを含めることができます。各 Uri は期間限定で有効です。URL の有効期限が切れた場合は、再度リクエストしてください。Orchestrator の組み込みの SAS メカニズムを通じて提供される記録の場合、ファイル拡張子は &type= クエリ パラメーターとして URL に追加されるため、ファイルの種類を判別できます。
ジョブの記録を削除する
この DELETE 要求は、ジョブに関連付けられた GUID {jobKey}で識別されるすべての記録ファイルを削除します。
API エンドポイント
DELETE
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/jobs/{jobKey}
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | ベアラー {access_token} |
| X-UIPATH-OrganizationUnitId | {folder_Id} |
応答コード
204 No Content
キュー アイテムの記録のダウンロード URL を取得する
この GET 要求は、キュー アイテムに関連付けられたすべての記録のダウンロード URL を、その数値 {queueItemId}で識別して返します。
API エンドポイント
GET
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/QueueItems/{queueItemId}/Read
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | ベアラー {access_token} |
| X-UIPATH-OrganizationUnitId | {folder_Id} |
応答コード
200 OK
応答本文
[
{
"Uri": "https://{storage-account}.blob.core.windows.net/orchestrator/.../recording_1.mp4?sv=2023-01-03&se=2026-06-24T12%3A30%3A00Z&sr=b&sp=r&sig=...",
"Verb": "GET",
"RequiresAuth": false,
"Headers": null
}
]
[
{
"Uri": "https://{storage-account}.blob.core.windows.net/orchestrator/.../recording_1.mp4?sv=2023-01-03&se=2026-06-24T12%3A30%3A00Z&sr=b&sp=r&sig=...",
"Verb": "GET",
"RequiresAuth": false,
"Headers": null
}
]
キュー アイテムの記録を削除する
この DELETE 要求は、キュー アイテムに関連付けられた、数値 {queueItemId}で識別されるすべての記録ファイルを削除します。
API エンドポイント
DELETE
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/QueueItems/{queueItemId}
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | ベアラー {access_token} |
| X-UIPATH-OrganizationUnitId | {folder_Id} |
応答コード
204 No Content