Data Service 用户指南

适用平台：

上次更新日期 2025年5月26日

API 访问权限

使用 Data Service 开放 API，您可以从所选外部应用程序管理 UiPath^TM Data Service 资源，并且可以通过 Oauth 2.0 授权框架在不共享任何凭据的情况下授权外部应用程序。

要使用 Data Service OpenAPI，您必须向外部应用程序授予 API 权限。这些 API 权限称为作用域，Data Service 有以下三种类型的作用域：

DataService.Schema.Read - 此用户作用域允许您的外部应用程序读取租户的 Data Service 架构，此作用域取决于用户的权限。
DataService.Schema.Read - 此用户作用域允许您的外部应用程序读取租户的 Data Service 架构，此作用域取决于用户的权限。
DataService.Data.Write - 此用户作用域允许您的外部应用程序通过删除、更新或新建数据来编辑租户的 Data Service 数据，此作用域取决于用户的权限。

详细了解 Data Service 中的用户角色和权限。

为外部应用程序和用户设置权限后，下载租户 Data Service 数据的 OpenAPI 规范：

此操作会以 JSON 格式下载租户 Data Service 实体的 OpenAPI 3.0 规范。

单击“复制 OpenAPI 链接”可复制生成租户 Data Service OpenAPI 规范的 API 端点。

要访问 Data Service 的用户范围资源，请使用以下方法之一授权您的外部应用程序：

OAuth2.0 授权框架可帮助您生成访问令牌，该令牌允许您的外部应用程序在有限的时间（一小时）内向 Data Service 端点发出 REST API 调用。

Data Service API 端点具有以下语法：

HTTP 方法 + BaseURL + 资源类别 + Data Service 实体 + 操作 + 路径变量和查询参数

Data Service 实体示例

为了描述每个 API 请求正文/响应正文，我们使用在 Data Service 中创建的“奥运会”实体字段。当我们记录通用端点（例如 Get Entity Records）时，端点将包含实体的确切名称（例如 Get Olympics Records）。响应正文和请求正文包含实体的所有字段，以复制实体的结构。

此外，让我们使用 Data Service API 指南深入了解每个端点，并了解如何充分利用它们。

外部应用程序使用自己的客户端凭据来访问 Data Service 资源，而不是模拟用户。

当外部应用程序要在实体中执行操作时，Data Service 会检查应用程序是否具有访问相应资源所需的权限。由于没有用户参与身份验证，请求任何资源都会生成一个访问令牌，用于验证应用程序在租户级别和实体级别的分配情况。仅在验证成功后，外部应用程序才能访问已获得权限的资源。

作为管理员，请按照以下步骤创建外部应用程序并配置其以访问 Data Service 资源：

在您的组织中，导航至“管理员” > “外部应用程序” 。系统将显示“外部应用程序”页面。
单击“添加应用程序” ：
1. 为您的外部应用命名。
2. 选择外部应用程序的类型。
3. 单击“添加” 。您的外部应用程序将显示在“外部应用程序”列表中。

了解 dataService.default 作用域对于已分配自定义 Data Service 角色的机密应用程序，您需要请求DataService.Default作用域。此作用域使用访问令牌来检查应用程序在租户级别和实体级别的分配。仅在验证成功后，外部应用程序才能访问其有权访问的资源。

作为 Data Service 管理员，请按照以下步骤向外部应用程序授予对所选租户中所有实体的访问权限：

在 Data Service 实例中，导航到“管理访问权限”页面。
在“管理访问权限” 页面上，单击“分配角色”按钮。
在“分配角色”面板中：
1. 在“添加名称”字段中，键入外部应用程序的名称，然后从列表中选择该外部应用程序。
2. 从“选择角色”列表中，选择先前创建的自定义角色和“数据读取者”角色。您可以选择要分配给外部应用程序的其他角色，但必须选择数据读取者。
3. 单击“保存” 。您的外部应用程序将显示在“分配角色”选项卡的列表中。

作为 Data Service 管理员，请按照以下步骤来管理外部应用程序对特定实体的访问：

在 Data Service 实例中，导航到“管理访问权限”页面。
在“管理访问权限”页面上，单击“创建角色”按钮。
在“创建角色”面板中：
1. 提供自定义角色的名称。
2. Assign the desired administrative permissions.
3. 在“数据访问权限”部分下，单击“添加实体” ，选择所需的实体，然后选择外部应用程序在该实体中可以拥有的权限。
4. 单击“保存” 。外部应用程序的自定义角色显示在“角色”选项卡的列表中。