イベント・タイプのリスト
get
/system/api/v1/events/types
イベントのobjectTypeなどのプロパティでフィルタされたイベント型をリストします。 多数のイベント結果がページにリクエストされる可能性があるため、# Authorizationすべてのログイン・ユーザーが検索タイプを選択できます。# Filters次のプロパティはフィルタ可能であり、`q`パラメータで使用できます:
##ソート、次のプロパティは、`orderBy`問合せパラメータで使用できます:
デフォルトのソート順は昇順です。 「The Id」フィールドは昇順でソートされます。##拡張、次の関係を`expand`問合せパラメータで使用できます(値`all`は、これらの関係をすべて拡張します):
| プロパティ名 | サポートされる演算子 | |
| objectType | (eq)と等しい | |
| category | (eq)と等しい |
| プロパティ名 | 説明 | |
| id | イベントのId。 |
| プロパティ名 | 説明 | |
| categories | イベントのカテゴリ。 |
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- expand(optional): string
展開するフィールド名のカンマ区切りの文字列。 値`all`を使用して、すべての関係を展開します。
- orderBy(optional): string
カンマで区切ったフィールド名の文字列。それぞれに`:asc`または`:desc`が続き、レスポンスで返されるアイテムの順序が指定されます。
- q(optional): string
リソースのフィルタリング。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ : イベント
型:
objectイベントのリスト。
Show Source
- count(optional): integer(int64)
レスポンス内のリソースの合計数。例:
10 - hasMore(optional): boolean
コレクションには、リクエストに一致する多くの要素があります。 ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。例:
true - items(optional): array items
コレクションに含まれる特異なリソース。
- limit(optional): integer(int64)
実際のレスポンス・サイズ制限。 リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。例:
10 - links(optional): array links
このリソースの関連リソースおよびアクションへのリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
- offset(optional): integer(int64)
使用される実際のレスポンス・オフセット。 リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。例:
0 - totalResults(optional): integer(int64)
リクエストに一致するリソースの合計数。 指定した場合は、使用可能なアイテムの合計数です。 指定されない場合、合計が不明か、または戻り不可能です。 この値を計算するとき、ページング制限またはオフセットは無視されます。 `totalResults`パラメータがサポートされていて、クライアントによって`true`に設定されている場合にのみ返されます。例:
10
ネストされたスキーマ: links
型:
arrayこのリソースの関連リソースおよびアクションへのリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
Show Source
- Array of: object Link
RESTリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。
ネストされたスキーマ : イベント
型:
objectイベント情報。
Show Source
- categories(optional): array categories
このイベントのカテゴリ
- displayName(optional): string
イベントの表示キー。例:
Created - id(optional): integer(int32)
イベントのId例:
4032 - name(optional): string
イベントの名前例:
DIGITALASSET_CREATED - objectType(optional): string
イベントのオブジェクト・タイプ例:
Digital Asset
ネストされたスキーマ : カテゴリ
型:
objectカテゴリ情報。
Show Source
- displayName(optional): string
カテゴリの表示キー。例:
Asset Lifecycle - id(optional): integer(int32)
カテゴリのid。例:
123456789 - name(optional): string
カテゴリの名前。例:
ASSET_LIFECYCLE
ネストされたスキーマ : リンク
型:
objectRESTリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。
Show Source
- href(optional): string
ターゲット・リソースのURI URI *RFC3986*またはURIテンプレート*RFC6570*。 値がURIテンプレートに設定されている場合、`templated`プロパティを`true`に設定する必要があります。
- mediaType(optional): string
リンク・ターゲット。 メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
- method(optional): string
ターゲットHTTPメソッドをリンクします。 リンクのターゲットをリクエストするためのHTTPメソッド。* `none` - 有効なHTTPメソッド*'OPTIONS`がないことを示します - HTTP OPTIONS * `HEAD - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
- profile(optional): string
リンク・メタデータのロケーション。 ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
- rel(optional): string
リンク関係。 リンクの詳細を取得するために使用できるリンク・リレーションの名前。
- templated(optional): boolean
hrefテンプレートのリンク・フラグ。 `href`プロパティを指定するブール・フラグは、URIまたはURIテンプレートです。 プロパティが存在しない場合、このプロパティは`false`と想定できます。
304レスポンス
Not Modified
ルート・スキーマ : ExceptionDetail
型:
objectRESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
Show Source
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
- instance(optional): string
エラーの詳細を提供するURIをリンクに追加します。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
- o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
- title(optional): string
問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
- type(optional): string
問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。
ネストされたスキーマ: o:errorDetails
型:
array階層構造に複数のエラーがある場合もあります。
Show Source
- Array of: object ExceptionDetail
RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
400レスポンス
不正リクエスト
ルート・スキーマ : ExceptionDetail
型:
objectRESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
Show Source
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
- instance(optional): string
エラーの詳細を提供するURIをリンクに追加します。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
- o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
- title(optional): string
問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
- type(optional): string
問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。
ネストされたスキーマ: o:errorDetails
型:
array階層構造に複数のエラーがある場合もあります。
Show Source
- Array of: object ExceptionDetail
RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
404レスポンス
Not Found
ルート・スキーマ : ExceptionDetail
型:
objectRESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
Show Source
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
- instance(optional): string
エラーの詳細を提供するURIをリンクに追加します。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
- o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
- title(optional): string
問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
- type(optional): string
問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。
ネストされたスキーマ: o:errorDetails
型:
array階層構造に複数のエラーがある場合もあります。
Show Source
- Array of: object ExceptionDetail
RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
500レスポンス
内部サーバー・エラー
ルート・スキーマ : ExceptionDetail
型:
objectRESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
Show Source
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
- instance(optional): string
エラーの詳細を提供するURIをリンクに追加します。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
- o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
- title(optional): string
問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
- type(optional): string
問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。
ネストされたスキーマ: o:errorDetails
型:
array階層構造に複数のエラーがある場合もあります。
Show Source
- Array of: object ExceptionDetail
RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。