取得服務的相關資訊(尚未實作)

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