8.2. Red Hat Developer Hub 中支持的 ServiceNow 自定义操作


ServiceNow 自定义操作允许您管理 Red Hat Developer Hub 中的记录。自定义操作支持以下 API 请求的 HTTP 方法:

  • GET :从指定的资源端点检索指定信息
  • POST :创建或更新资源
  • PUT :修改资源
  • PATCH: 更新资源
  • DELETE :删除资源

8.2.1. ServiceNow 自定义操作

[GET] servicenow:now:table:retrieveRecord

从 Developer Hub 中的表检索指定记录的信息。

表 8.1. 输入参数
Name类型要求描述

tableName

string

必填

从中检索记录的表的名称

sysId

string

必填

要检索的记录的唯一标识符

sysparmDisplayValue

enum("true", "false", "all")

选填

返回字段显示值,如 true,实际值为 false,或两者。默认值为 false

sysparmExcludeReferenceLink

布尔值

选填

设置为 true 以排除参考字段的 Table API 链接。默认值为 false

sysparmFields

string[]

选填

要在响应中返回的字段数组

sysparmView

string

选填

根据指定的 UI 视图呈现响应。您可以使用 sysparm_fields 覆盖此参数。

sysparmQueryNoDomain

布尔值

选填

将 设置为 true,以在域间访问数据(如果授权)。默认值为 false

表 8.2. 输出参数
Name类型描述

result

record<PropertyKey, unknown>

请求的响应正文

[GET] servicenow:now:table:retrieveRecords

从 Developer Hub 中的表检索有关多个记录的信息。

表 8.3. 输入参数
Name类型要求描述

tableName

string

必填

从中检索记录的表的名称

sysparamQuery

string

选填

用于过滤结果的编码查询字符串

sysparmDisplayValue

enum("true", "false", "all")

选填

返回字段显示值,如 true,实际值为 false,或两者。默认值为 false

sysparmExcludeReferenceLink

布尔值

选填

设置为 true 以排除参考字段的 Table API 链接。默认值为 false

sysparmSuppressPaginationHeader

布尔值

选填

设置为 true 以阻止分页标头。默认值为 false

sysparmFields

string[]

选填

要在响应中返回的字段数组

sysparmLimit

int

选填

每个页面返回的最大结果数。默认值为 10,000

sysparmView

string

选填

根据指定的 UI 视图呈现响应。您可以使用 sysparm_fields 覆盖此参数。

sysparmQueryCategory

string

选填

用于查询的查询类别的名称

sysparmQueryNoDomain

布尔值

选填

将 设置为 true,以在域间访问数据(如果授权)。默认值为 false

sysparmNoCount

布尔值

选填

不要在表中执行所选 countrolebinding。默认值为 false

表 8.4. 输出参数
Name类型描述

result

record<PropertyKey, unknown>

请求的响应正文

[POST] servicenow:now:table:createRecord

在 Developer Hub 的表中创建记录。

表 8.5. 输入参数
Name类型要求描述

tableName

string

必填

保存记录的表的名称

requestBody

record<PropertyKey, unknown>

选填

在指定记录中定义的每个参数的字段名称和关联值

sysparmDisplayValue

enum("true", "false", "all")

选填

返回字段显示值,如 true,实际值为 false,或两者。默认值为 false

sysparmExcludeReferenceLink

布尔值

选填

设置为 true 以排除参考字段的 Table API 链接。默认值为 false

sysparmFields

string[]

选填

要在响应中返回的字段数组

sysparmInputDisplayValue

布尔值

选填

使用其显示值(如 true 或实际值)设置字段值,如 false。默认值为 false

sysparmSuppressAutoSysField

布尔值

选填

设置为 true 以禁止自动生成系统字段。默认值为 false

sysparmView

string

选填

根据指定的 UI 视图呈现响应。您可以使用 sysparm_fields 覆盖此参数。

表 8.6. 输出参数
Name类型描述

result

record<PropertyKey, unknown>

请求的响应正文

[PUT] servicenow:now:table:modifyRecord

修改 Developer Hub 中的表中的记录。

表 8.7. 输入参数
Name类型要求描述

tableName

string

必填

修改记录的表的名称

sysId

string

必填

要修改的记录的唯一标识符

requestBody

record<PropertyKey, unknown>

选填

在指定记录中定义的每个参数的字段名称和关联值

sysparmDisplayValue

enum("true", "false", "all")

选填

返回字段显示值,如 true,实际值为 false,或两者。默认值为 false

sysparmExcludeReferenceLink

布尔值

选填

设置为 true 以排除参考字段的 Table API 链接。默认值为 false

sysparmFields

string[]

选填

要在响应中返回的字段数组

sysparmInputDisplayValue

布尔值

选填

使用其显示值(如 true 或实际值)设置字段值,如 false。默认值为 false

sysparmSuppressAutoSysField

布尔值

选填

设置为 true 以禁止自动生成系统字段。默认值为 false

sysparmView

string

选填

根据指定的 UI 视图呈现响应。您可以使用 sysparm_fields 覆盖此参数。

sysparmQueryNoDomain

布尔值

选填

将 设置为 true,以在域间访问数据(如果授权)。默认值为 false

表 8.8. 输出参数
Name类型描述

result

record<PropertyKey, unknown>

请求的响应正文

[PATCH] servicenow:now:table:updateRecord

更新 Developer Hub 中的表中的记录。

表 8.9. 输入参数
Name类型要求描述

tableName

string

必填

更新记录的表的名称

sysId

string

必填

要更新记录的唯一标识符

requestBody

record<PropertyKey, unknown>

选填

在指定记录中定义的每个参数的字段名称和关联值

sysparmDisplayValue

enum("true", "false", "all")

选填

返回字段显示值,如 true,实际值为 false,或两者。默认值为 false

sysparmExcludeReferenceLink

布尔值

选填

设置为 true 以排除参考字段的 Table API 链接。默认值为 false

sysparmFields

string[]

选填

要在响应中返回的字段数组

sysparmInputDisplayValue

布尔值

选填

使用其显示值(如 true 或实际值)设置字段值,如 false。默认值为 false

sysparmSuppressAutoSysField

布尔值

选填

设置为 true 以禁止自动生成系统字段。默认值为 false

sysparmView

string

选填

根据指定的 UI 视图呈现响应。您可以使用 sysparm_fields 覆盖此参数。

sysparmQueryNoDomain

布尔值

选填

将 设置为 true,以在域间访问数据(如果授权)。默认值为 false

表 8.10. 输出参数
Name类型描述

result

record<PropertyKey, unknown>

请求的响应正文

[DELETE] servicenow:now:table:deleteRecord

从 Developer Hub 中的表中删除记录。

表 8.11. 输入参数
Name类型要求描述

tableName

string

必填

从中删除记录的表的名称

sysId

string

必填

要删除记录的唯一标识符

sysparmQueryNoDomain

布尔值

选填

将 设置为 true,以在域间访问数据(如果授权)。默认值为 false

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.