UiPath Documentation
orchestrator
latest
false
Orchestrator API 指南
  • 入门指南
  • Swagger 定义
  • Orchestrator API
重要 :
新发布内容的本地化可能需要 1-2 周的时间才能完成。

视频录制请求

用于检索作业和队列项目的下载 URL 以及删除作业和队列项目的执行视频录制的 API 请求。

启用视频录制后,Unattended 执行可以生成存储在系统存储桶中的视频录制。这些请求可用于检索作业或队列项目录制的限时下载 URL,并将其删除。

重要提示:

这些端点要求为租户启用视频录制,并配置存储桶。如果未启用视频录制,请求将返回错误。

read请求返回的下载 URL 是有时间限制的 SAS(共享访问签名)URL,直接指向每个录制文件。您无需知道文件名,每个记录的响应中都会包含一个即用型 URL。通过向每个返回的Uri发出 GET 请求,下载记录。

所需权限

请求权限
获取作业录制文件下载 URLJobs.View ExecutionMedia.View
删除作业记录Jobs.Delete ExecutionMedia.Delete
获取队列项目录制下载 URLJobs.ViewQueues.ViewExecutionMedia.View
删除队列项目录制Queues.Delete ExecutionMedia.Delete

获取作业录制的下载 URL

此 GET 请求将返回与作业关联的所有记录的下载 URL。作业由其{jobKey}标识,这是作业的 GUID Key字段(而不是数字Id )。您可以从“作业请求”中检索作业的Key ,例如, GET /odata/Jobs?$filter=Id eq 125161会返回Key

API 端点

获取

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/jobs/{jobKey}/read

请求标头

密钥
授权持有者 {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 过期,请重新请求 URL。对于通过 Orchestrator 的内置 SAS 机制提供的录制文件,文件扩展名作为&type=查询参数附加到 URL,以便确定文件类型。

删除作业的记录

此 DELETE 请求将删除与作业关联的所有录制文件(由其 GUID 标识) {jobKey}

API 端点

删除

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/jobs/{jobKey}

请求标头

密钥
授权持有者 {access_token}
X-UIPATH-OrganizationUnitId{folder_Id}

响应代码

204 无内容

正在获取队列项目录制的下载 URL

此 GET 请求返回与队列项目(由其数字{queueItemId}标识)关联的所有录制文件的下载 URL。

API 端点

获取

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/QueueItems/{queueItemId}/Read

请求标头

密钥
授权持有者 {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 端点

删除

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/api/VideoRecording/QueueItems/{queueItemId}

请求标头

密钥
授权持有者 {access_token}
X-UIPATH-OrganizationUnitId{folder_Id}

响应代码

204 无内容

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新