機械翻訳について
  1. Webフック管理用のREST API
  2. タスク
  3. Webフック

Webフックのリスト

get

/system/api/v1/webhooks

ユーザーがアクセス権を持つすべてのWebフックをリストします。 Listは問合せパラメータ、## Filtersを使用してフィルタできます次のプロパティはフィルタ可能であり、`q`パラメータで使用できます:
プロパティ名サポートされる演算子
category(eq)と等しい

「例」 q=category eq "ASSET_LIFECYCLE "## sort orderByパラメータを使用して、問い合せたアイテムの順序(昇順/降順)を制御します。 このパラメータは問合せではオプションであり、既定では結果の順序はありません。 このパラメータでは、ユーザーが結果のソートに使用するフィールド名をコロン(:)で区切って指定できます。
プロパティ名説明
namewebフックの名前。
categorywebフックのカテゴリ。
enabled有効フラグまたはwebフック。

「フォーマット」 orderBy={PropertyName}:{asc:desc}
「例」 orderBy=name:desc

リクエスト

問合せパラメータ
  • 正の整数値は、レスポンスで返されるアイテムの最大数を指定します。
    デフォルト値: 100
  • 返される最初のアイテムのインデックスを指定する負でない整数値。 オフセット索引は`0`から始まります。 デフォルトのオフセットは`0`で、コレクション内の最初のアイテムから始まるすべてのアイテムが返されます。
    デフォルト値: 0
  • カンマで区切ったフィールド名の文字列。それぞれに`:asc`または`:desc`が続き、レスポンスで返されるアイテムの順序が指定されます。
  • リソースのフィルタリング。
トップに戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

OK
本文()
ルート・スキーマ : Webフック・コレクション
型: object
Webフック・コレクション
Show Source
  • レスポンス内のリソースの合計数。
    例: 10
  • コレクションには、リクエストに一致する多くの要素があります。 ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。
    例: true
  • items
    コレクションに含まれる特異なリソース。
  • 実際のレスポンス・サイズ制限。 リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。
    例: 10
  • links
  • 使用される実際のレスポンス・オフセット。 リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。
    例: 0
  • リクエストに一致するリソースの合計数。 指定した場合は、使用可能なアイテムの合計数です。 指定されない場合、合計が不明か、または戻り不可能です。 この値を計算するとき、ページング制限またはオフセットは無視されます。 `totalResults`パラメータがサポートされていて、クライアントによって`true`に設定されている場合にのみ返されます。
    例: 10
ネストされたスキーマ: items
型: array
コレクションに含まれる特異なリソース。
Show Source
ネストされたスキーマ : Webhook
型: object
Webフック構成データ
Show Source
ネストされたスキーマ: User
型: object
ユーザーMetadataモデル。
Show Source
ネストされたスキーマ : eventDetails
型: array
Webフックがサブスクライブしているイベントの詳細。 これは必須プロパティです。 少なくとも1つのイベントが必要です
Show Source
ネストされたスキーマ : ペイロード
型: object
Webフックのペイロード構成。 サポートされているペイロード名は:
empty
brief
detailed
Show Source
  • ペイロードの名前。 簡易は、webフックのデフォルト値であるペイロードが設定されていません
    例: brief
ネストされたスキーマ : ターゲット
型: object
Webフックのターゲット・エンド・ポイントの詳細。
Show Source
ネストされたスキーマ : Webフック・イベント
型: object
Webフックのイベント詳細。
Show Source
ネストされたスキーマ : eventNames
型: array
イベントのリスト。 イベント名は/events/types?expand=allエンド・ポイントから取得できます
Show Source
例:
contentitem_created,contentitem_published,digitalasset_created
ネストされたスキーマ: Filter
型: object
Show Source
ネストされたスキーマ : objectIds
型: array
objectTypeのidのリスト。
Show Source
例:
{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}
ネストされたスキーマ : セキュリティ
型: object
Webフック・ターゲット・エンドポイントのセキュリティ構成。
Show Source
ネストされたスキーマ : BasicAuth
型: object
基本認証の構成の詳細。 詳細は認可ヘッダーで送信されます
Show Source
ネストされたスキーマ : ヘッダー
型: object
ヘッダー・ベースの認可構成の詳細。
Show Source
ネストされたスキーマ : SignatureSecurity
型: object
シグネチャ・ベースのセキュリティ構成詳細。
Show Source
ネストされたスキーマ: headers
型: array
ヘッダーのリスト。
Show Source
ネストされたスキーマ : リクエスト・ヘッダー
型: object
リクエスト・ヘッダー
Show Source

304レスポンス

Not Modified
本文()
ルート・スキーマ : ExceptionDetail
型: object
RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
Show Source
  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
  • エラーの詳細を提供するURIをリンクに追加します。
  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
  • o:errorDetails
    階層構造に複数のエラーがある場合もあります。
  • エラーが発生した場所を示すXPathまたはJSONパス。
  • HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
  • 問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。
ネストされたスキーマ: o:errorDetails
型: array
階層構造に複数のエラーがある場合もあります。
Show Source
  • ExceptionDetail
    RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

400レスポンス

不正リクエスト
本文()
ルート・スキーマ : ExceptionDetail
型: object
RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
Show Source
  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
  • エラーの詳細を提供するURIをリンクに追加します。
  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
  • o:errorDetails
    階層構造に複数のエラーがある場合もあります。
  • エラーが発生した場所を示すXPathまたはJSONパス。
  • HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
  • 問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。
ネストされたスキーマ: o:errorDetails
型: array
階層構造に複数のエラーがある場合もあります。
Show Source
  • ExceptionDetail
    RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

404レスポンス

Not Found
本文()
ルート・スキーマ : ExceptionDetail
型: object
RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
Show Source
  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
  • エラーの詳細を提供するURIをリンクに追加します。
  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
  • o:errorDetails
    階層構造に複数のエラーがある場合もあります。
  • エラーが発生した場所を示すXPathまたはJSONパス。
  • HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
  • 問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。
ネストされたスキーマ: o:errorDetails
型: array
階層構造に複数のエラーがある場合もあります。
Show Source
  • ExceptionDetail
    RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

500レスポンス

内部サーバー・エラー
本文()
ルート・スキーマ : ExceptionDetail
型: object
RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
Show Source
  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
  • エラーの詳細を提供するURIをリンクに追加します。
  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
  • o:errorDetails
    階層構造に複数のエラーがある場合もあります。
  • エラーが発生した場所を示すXPathまたはJSONパス。
  • HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
  • 問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。
ネストされたスキーマ: o:errorDetails
型: array
階層構造に複数のエラーがある場合もあります。
Show Source
  • ExceptionDetail
    RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
トップに戻る