Blue Prism API 用户权限

下表列出了成功将请求传递到不同的 Blue Prism API 端点所需的 Blue Prism 用户权限。Hub 中的 Control Room 插件利用 API，因此具有相同的权限集。该表提供了可用端点、请求和所需权限的概述，以及 Blue Prism 参考中可用的完整详细信息。要访问 API 参考，请参阅 Blue Prism API。

有关如何设置用户权限的信息，请参阅 Blue Prism 用户角色。

权限

请求按以下类别分组：

仪表盘

请求

端点

所需用户权限

响应

GET

/api/v7/dashboards
/workQueueCompositions

此端点不受用户权限的限制。

返回工作队列组成详细信息的列表。

GET

/api/v7/dashboards
/resourceUtilization

此端点不受用户权限的限制。

返回利用率详细信息的列表。

GET

/api/v7/dashboards/
resourcesSummaryUtilization

此端点不受用户权限的限制。

返回指定日期范围内的资源利用率详细信息的列表。

加密方案

请求

端点

所需用户权限

响应

GET

/api/v7/encryptionschemes

此端点不受用户权限的限制。

返回加密方案的列表。

资源

请求

端点

所需用户权限

响应

GET

/api/v7/resources

至少需要以下资源权限之一：

  • 查看资源
  • 查看资源屏幕截图
  • 配置资源
  • 控制资源
  • 管理资源访问权限
  • 查看资源详细信息

返回环境中资源的列表。

PUT

/api/v7/resources/{resourceId}

需要以下资源权限：

返回指定的资源。

计划

请求

端点

所需用户权限

响应

GET

/api/v7/schedules

至少需要以下调度程序权限之一：

  • 查看计划
  • 编辑计划
  • 删除计划
  • 创建计划
  • 停用计划
  • 系统—调度程序

返回环境中计划的列表。

GET

/api/v7/schedules/logs

至少需要以下调度程序权限之一：

  • 查看计划
  • 编辑计划
  • 删除计划
  • 创建计划
  • 停用计划
  • 系统—调度程序

返回所有计划日志。

PUT

/api/v7/schedules/{scheduleId}

停用计划需要以下所有调度程序权限：

  • 编辑计划
  • 停用计划

取消停用计划需要以下所有调度程序权限：

  • 编辑计划
  • 停用计划
  • 创建计划

更新指定的计划。

GET

/api/v7/schedules/
{scheduleId}/logs

至少需要以下调度程序权限之一：

  • 查看计划
  • 编辑计划
  • 删除计划
  • 创建计划
  • 停用计划
  • 系统—调度程序

返回指定计划的所有日志。

GET

/api/v7/schedules
/{scheduleId}/tasks

至少需要以下调度程序权限之一：

  • 查看计划
  • 编辑计划
  • 删除计划
  • 创建计划
  • 停用计划
  • 系统—调度程序

返回指定计划中任务的列表。

GET

/api/v7/schedules/tasks/
{taskId}/sessions

至少需要以下调度程序权限之一：

  • 查看计划
  • 编辑计划
  • 删除计划
  • 创建计划
  • 停用计划
  • 系统—调度程序

返回指定任务的计划会话的列表。

安排会话

请求

端点

所需用户权限

响应

POST

/api/v7/schedules/{scheduleId}
/sessions

需要以下调度程序权限：

  • 编辑计划

将计划设置为在特定日期和时间运行。

会话日志

请求

端点

所需用户权限

响应

GET

/api/v7/sessions
/{sessionId}/logs

至少需要以下 Process Studio 权限之一：

  • 创建流程
  • 删除流程
  • 编辑流程
  • 编辑流程组
  • 导出流程
  • 执行流程
  • 执行作为 Web 服务的流程
  • 查看流程定义
  • 管理流程访问权限

以及至少以下资源权限之一：

  • 查看资源
  • 查看资源屏幕截图
  • 配置资源
  • 控制资源
  • 管理资源访问权限
  • 查看资源详细信息

以及以下系统管理器权限：

  • 审计—流程日志

将计划设置为在特定日期和时间运行。

GET

/api/v7/sessions/
{sessionId}/logs/
{logId}/parameters

至少需要以下 Process Studio 权限之一：

  • 创建流程
  • 删除流程
  • 编辑流程
  • 编辑流程组
  • 导出流程
  • 执行流程
  • 执行作为 Web 服务的流程
  • 查看流程定义
  • 管理流程访问权限

以及至少以下资源权限之一：

  • 查看资源
  • 查看资源屏幕截图
  • 配置资源
  • 控制资源
  • 管理资源访问权限
  • 查看资源详细信息

以及以下系统管理器权限：

  • 审计—流程日志

返回指定会话日志的所有参数。

会话

请求

端点

所需用户权限

响应

GET

/api/v7/sessions

至少需要以下资源权限之一：

  • 查看资源
  • 查看资源屏幕截图
  • 配置资源
  • 控制资源
  • 管理资源访问权限

以及至少以下 Process Studio 权限之一：

  • 创建流程
  • 删除流程
  • 编辑流程
  • 编辑流程组
  • 导出流程
  • 执行流程
  • 执行作为 Web 服务的流程
  • 查看流程定义
  • 管理流程访问权限

返回环境中会话的列表。

GET

/api/v7/sessions/{sessionId}

至少需要以下资源权限之一：

  • 查看资源
  • 查看资源屏幕截图
  • 配置资源
  • 控制资源
  • 管理资源访问权限

以及至少以下 Process Studio 权限之一：

  • 创建流程
  • 删除流程
  • 编辑流程
  • 编辑流程组
  • 导出流程
  • 执行流程
  • 执行作为 Web 服务的流程
  • 查看流程定义
  • 管理流程访问权限

返回指定会话的详细信息。

工作队列

请求

端点

所需用户权限

响应

GET

/api/v7/workqueues

至少需要以下 Control Room 权限之一：

  • 队列管理读取访问权限
  • 队列管理完整访问权限

返回环境中工作队列的列表。

POST

/api/v7/workqueues

需要以下系统管理器权限：

  • 工作流程—工作队列配置

创建新的工作队列。

GET

/api/v7/workqueues/
{workQueueId}

至少需要以下 Control Room 权限之一：

  • 队列管理读取访问权限
  • 队列管理完整访问权限

返回指定工作队列的详细信息。

DELETE

/api/v7/workqueues/
{workQueueId}

需要以下系统管理器权限：

  • 工作流程—工作队列配置

删除指定的工作队列。

PATCH

/api/v7/workqueues/
{workQueueId}

至少需要以下 Control Room 权限之一：

  • 队列管理读取访问权限
  • 队列管理完整访问权限

以及以下系统管理器权限：

  • 工作流程—工作队列配置

按修补程序文档中所述修改指定的工作队列。

GET

/api/v7/workqueues/
{workQueueId}/items

至少需要以下 Control Room 权限之一：

  • 队列管理读取访问权限
  • 队列管理完整访问权限

返回指定工作队列中的项。

POST

/api/v7/workqueues/
{workQueueId}/items

至少需要以下 Control Room 权限之一：

  • 队列管理读取访问权限
  • 队列管理完整访问权限

如果要访问活动队列项，则至少还需要以下 Process Studio 权限之一：

  • 创建流程
  • 编辑流程
  • 执行流程

将项添加至工作队列。

GET

/api/v7/workqueues/items/
{workQueueItemId}

至少需要以下 Control Room 权限之一：

  • 队列管理读取访问权限
  • 队列管理完整访问权限

如果要访问活动队列项，则至少还需要以下 Process Studio 权限之一：

  • 创建流程
  • 编辑流程
  • 执行流程

返回工作队列中指定项的详细信息。