api_patch() 方法
将 PATCH 请求发送到 HighBond API。
注意
HighBond API 方法与您组织的实时 Diligent One 数据进行交互。如果您拥有适当的权限，它们将授予您更改或删除可能很重要的数据的权限。在使用 HighBond API 时，请仔细考虑您的操作的后果。
说明
有些 Diligent One 资源支持 PATCH，有些支持 PUT，有些同时支持这两种请求类型。有关详细信息，请参阅 HighBond API 参考。
语法
hcl.api_patch("HighBond API 请求详情", data = request_payload)参数
| 名称 | 描述 |
|---|---|
| HighBond API 请求详细信息 | Diligent One 资源的请求详细信息。 hcl.api_patch 会在后台自动提供请求详细信息的标准部分。除非要覆盖默认值，否则不需要显式指定这些请求元素：
有关特定 Diligent One 资源的请求语法，请参阅 HighBond API 参考。 说明 如果显式指定主机信息，则必须使用 HTTPS 协议连接到 HighBond API。例如：https://apis-us.highbond.com |
| data = 请求负载 | 要发送到 Diligent One API 服务器的数据。 负载数据必须采用 JSON 格式。 |
返回
来自 HighBond API 服务器的响应对象。
备注
身份验证
所有 HighBond API 请求都需要身份验证。您必须至少是一个 Diligent One 实例中的 系统管理员 才能访问 API。
要进行身份验证，请使用 Diligent One 平台 为您的账户创建一个 HighBond API 令牌。该令牌是一个用于验证身份的字符串，允许您安全地访问 HighBond API。有关创建令牌的帮助，请参阅 管理访问令牌 。
将 HighBond API 令牌与 HighBond API 方法配合使用
要将 HighBond API 令牌与 HighBond API 方法配合使用，必须将该令牌分配给名为 v_hb_token 的 HCL 变量。分配令牌后，它将在后台自动用于身份验证，无需在 Diligent One 脚本中显式指定。有关将令牌分配给变量的信息，请参阅 。
系统用户令牌
购买了特定 Diligent One 工具包的客户还可以选择使用通用系统用户令牌而不是与特定用户账户关联的令牌进行身份验证。
仅指定资源 URL 的唯一部分
使用 HighBond API 方法时，只需指定 Diligent One 资源 URL 的唯一部分或端点。您不需要指定您在其中工作的 Diligent One 实例的公共部分（基本 URL）或 ID。此信息在后台自动提供。
例如，如果您在 ID 为 1000236 的 Diligent One 实例中工作，那么这两个 API 请求都返回相同的响应。二者均列出项目 19756 中的所有问题。
hcl.api_get("projects/19756/issues")hcl.api_get("https://apis.highbond.com/v1/orgs/1000236/projects/19756/issues")请参阅 HighBond API 参考手册
HighBond API API 参考中提供了每个 Diligent One 资源的请求语法。例如，下面是获取项目中问题列表的请求语法。
如果您正在使用 HCL 方法发出请求，那么可以从 projects/... 开始指定语法：
如果您是从 Diligent One 外部发出请求，则需要从协议开始指定整个资源 URL ( https://...)。
在资源 URL 中使用变量
与在资源 URL 中指定文本 ID 不同，您可能具有需要在该 URL 中使用变量的代码。资源 URL 被格式化为字符串，因此要在字符串中包含变量，您需要使用下面所示的 Python 技术之一。
您可以使用 Python f 字符串：
v_project_id = "19756"
hcl.api_get(f"projects/{v_project_id}/issues")
您可以使用 Python 字符串连接：
v_project_id = "19756"
hcl.api_get("projects/" + v_project_id + "/issues")
