サービスに関する情報の取得(まだ実装されていません)
NOTE
この機能のリリース日は、まだ決定されていません。
特長や機能など、サービスに関する情報を返します。Adobe Workfront では、この情報を使用して Workfront のユーザーインターフェイスをカスタマイズします。例えば、web フックの実装にいくつかのカスタムアクションが含まれている場合、それらの操作は JSON でリストする必要があります。それにより、ユーザーは、これらのアクションを Workfront から呼び出すことができるようになります。
URL
GET /serviceInfo
クエリパラメーター
なし。さらに、このエンドポイントへの呼び出しには、認証も必要ありません。
応答
このサービスに関する情報を含んだ JSON
名前
タイプ
説明
webhookVersion
文字列
このサービスで実装されている web フックのバージョン。この仕様の一番上にリストされているバージョン番号です。
version
文字列
このサービスの内部バージョン番号。この番号は web フックサービスプロバイダーが定め、情報提供の目的でのみ使用されます。
publisher
文字列
Web フックの実装を提供する会社の名前。
availableEndpoints
文字列
このサービスで実装される API エンドポイントを含んだリスト。これは、Workfront のユーザーインターフェイスに、web フックプロバイダーから提供される機能が確実に反映されるようにするために使用されることがあります。リスト内の各項目には、エンドポイントの名前(「search」など)を含める必要があります。
customActions
文字列
この web フックで実装されているカスタム操作を含んだリストです。各リスト項目には、名前と表示名が含まれます。表示名は、Workfront の「ドキュメント アクション」ドロップダウンに表示されます。ドロップダウン内の項目をクリックすると、/customAction エンドポイントを呼び出すことで、web フック内のアクションが呼び出されます。
例: 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