获取有关服务(尚未实施)的信息

NOTE
此功能的发布日期尚未确定。

返回有关服务的信息,如特性和功能。 Adobe Workfront将使用此信息自定义Workfront中的用户界面。 例如,如果webhook实施包含一些自定义操作,则JSON应在JSON中列出这些操作。 随后,用户将能够从Workfront调用这些操作。

URL

GET /serviceInfo

查询参数

无。 此外,对此端点的调用不应需要身份验证。

响应

包含有关此服务的信息的JSON

名称
类型
描述
webhookVersion
字符串
由此服务实现的webhook版本。 这是此规范顶部列出的版本号。
版本
字符串
此服务的内部版本号。 此数字由webhook服务提供商确定,仅用于提供信息。
发布者
字符串
提供webhook实施的公司的名称。
availableendpoints
字符串
包含由此服务实现的API端点的列表。 这可用于确保Workfront中的用户界面反映webhook提供程序提供的功能。 列表中的每一项都必须包含端点的名称(如“search”)。
customactions
字符串
包含由此webhook实现的自定义操作的列表。 每个列表项包括名称和显示名称。 显示名称将显示在Workfront的“文档操作”下拉列表中。 单击下拉列表中的项目将通过调用/customAction端点在webhook中调用操作。

示例: https://www.acme.com/api/serviceInfo

返回

{
webhook version: "1.2", version: "1.0", publisher: "Acme, LLC", availableEndpoints: ["files", "metadata", "search", "download"
"thumbnail", "uploadInit", "upload" ], customActions [
{
name: "archive", displayName: "Archive"
},
{name: "doSomethingElse", displayName: "Do Something" },
]
}
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43