サービスに関する情報の取得（まだ実装されていません）

最終更新日： 2024年2月5日
  • トピック：

作成対象：

  • 開発者
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" },
]
}
前のページドキュメントまたはフォルダーの名前を変更（まだ実装されていません）
次のページドキュメントまたはフォルダーの名前の変更（まだ実装されていません）

Workfront