機械翻訳について
  1. アクティビティ・ログ用のREST API
  2. タスク
  3. 監査ログ

アクティビティの検索

get

/system/api/v1/auditlog/activities

objectCategory、objectID、variationSetIDなどのフィルタを使用してアクティビティを検索します。ページでは多数のアクティビティ結果がリクエストされる可能性があるため、# Authorizationすべてのログイン・ユーザーがアクティビティを検索できます。# Filter次のプロパティはフィルタ可能で、`q`パラメータで使用できます:
プロパティ名サポートされる演算子
objectType(eq)と等しい
eventCategory(eq)と等しい
eventName(eq)と等しい
variationSetId(eq)と等しい
objectId(eq)と等しい
registeredAt(ge)以上、(le)以下
activityDetails.{path-to-element}(eq)と等しい
デフォルトでは、objectTypeまたはeventCategoryまたはeventNameのフィルタが必要です。 リクエストでobjectType、eventCategoryまたはeventNameが設定されていない場合、リクエストはrejected.The objectType、eventNameおよびobjectIdフィルタで、'and'がoperator.Forの例である1つ以上の値のみを受け入れ、オブジェクト・タイプが"デジタル・アセット"または"コンテンツ・アイテム"であるすべてのアクティビティをリストする場合、使用するフィルタ基準は : /system/api/v1/auditlog/activities?q=objectType eq Digital AssetおよびobjectType eq Content Item。 データ範囲フィルタの場合、registeredAtフィルタにはFrom(ge)およびTo(le)の範囲が必要です。##ソート次のプロパティを`orderBy`問合せパラメータで使用できます:
プロパティ名説明
registeredAtアクティビティが登録された日時。
デフォルトのソート順は降順です。 registeredAtフィールドは降順でソートされます。##拡張、次の関係を`expand`問合せパラメータで使用できます(値`all`は、これらの関係すべてを拡張します):
プロパティ名説明
activityDetailsオブジェクトに対して処理されるアクティビティ詳細。
activityByアクティビティを実行したユーザー。
##リンク成功レスポンスには、次の1つ以上のリンクが含まれます:
リンク関係説明
selfリソースの現在の戻り表現を示します。
prev前のページが存在する場合、結果の前のページを説明します。
next次のページが存在する場合、結果の次のページについて説明します。

リクエスト

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

レスポンス

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

200レスポンス

OK
本文()
ルート・スキーマ : アクティビティ
型: object
アクティビティのリスト。
Show Source
  • レスポンス内のリソースの合計数。
    例: 10
  • コレクションには、リクエストに一致する多くの要素があります。 ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。
    例: true
  • items
    コレクションに含まれる特異なリソース。
  • 実際のレスポンス・サイズ制限。 リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。
    例: 10
  • links
  • 使用される実際のレスポンス・オフセット。 リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。
    例: 0
  • リクエストに一致するリソースの合計数。 指定した場合は、使用可能なアイテムの合計数です。 指定されない場合、合計が不明か、または戻り不可能です。 この値を計算するとき、ページング制限またはオフセットは無視されます。 `totalResults`パラメータがサポートされていて、クライアントによって`true`に設定されている場合にのみ返されます。
    例: 10
ネストされたスキーマ: items
型: array
コレクションに含まれる特異なリソース。
Show Source
ネストされたスキーマ : アクティビティ
型: object
アクティビティ情報。
Show Source
ネストされたスキーマ : activityDetails
型: object
使用可能なその他のプロパティ
Show Source
アクティビティについて処理済の詳細を保持します。
ネストされたスキーマ : entity
型: object
使用可能なその他のプロパティ
Show Source
このアクティビティをトリガーしたイベントのプライマリ・オブジェクト
例:
{"asset": {"id": "FC7F4C73571ACD99DECA99D9T0000ASEDVFV123456789","name": "My Asset Name","variationSetId": "FC7F4C73571ACD99DECA99D9T000012121","version": "v0.1","language": "en-US","type": "simpleType1"}}
ネストされたスキーマ : アクティビティ・イベント
型: object
アクティビティ・イベント情報。
Show Source
ネストされたスキーマ: User
型: object
ユーザーMetadataモデル。
Show Source
ネストされたスキーマ : additionalProperties
型: object
ネストされたスキーマ : IdName
型: object
Show Source
ネストされたスキーマ : categories
型: 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エラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。
トップに戻る

例

objectType、eventNameおよびobjectIdフィルタは、演算子として'and'を含む1つ以上の値のみを受け入れます。 たとえば、オブジェクト・タイプが「デジタル・アセット」または「コンテンツ・アイテム」であるすべてのアクティビティをリストするには、使用するフィルタ基準は次のとおりです: /system/api/v1/auditlog/activities?q=objectType eq Digital Asset and objectType eq Content Item 。

次の例は、objectType、objectId、eventNameなどのフィルタの検索アクティビティを示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/system/api/v1/auditlog/activities'

例1:

オブジェクト・タイプがデジタル・アセットであるすべてのアクティビティがリストされます。

/system/api/v1/auditlog/activities?q=objectType eq Digital Asset

レスポンス本文

{
  "hasMore": true,
  "offset": 0,
  "count": 1,
  "limit": 100,
  "totalResults": 1,
  "items": [
    {
      "id": "1588",
      "event": {
        "name": "DIGITALASSET_REFERENCED",
        "categories": [
          {
            "id": 3002,
            "name": "ASSET_LIFECYCLE"
          }
        ]
      },
      "entity": {
        "digitalasset": {
          "variationSetId": null,
          "version": null,
          "language": null,
          "type": null,
          "id": "CONT291BD3BCBB2A4CC5AF05BE6209B924BD",
          "name": "DAM_ocicecsuser1005.jpg"
        }
      },
      "message": {
        "key": "cec.event.digitalasset.referenced.name",
        "parameters": [
          "DAM_ocicecsuser1005.jpg"
        ],
        "text": "Digital Asset Item DAM_ocicecsuser1005.jpg was referenced by item {1}."
      },
      "registeredAt": "2021-09-06T05:02:48.196Z"
    }
  ]
}

例2:

/system/api/v1/auditlog/activities?q=objectType eq Digital Asset and activityDetails.objectId
      eq CONT6A620DAAD7CD4F62938451CC0489C329

オブジェクト・タイプがデジタル・アセットで、objectIdがCONT6A620DAAD7CD4F62938451CC0489C329のすべてのアクティビティがリストされます。

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 1,
  "limit": 100,
  "totalResults": 1,
  "items": [
    {
      "id": "1206",
      "event": {
        "name": "DIGITALASSET_UPDATED",
        "categories": [
          {
            "id": 3002,
            "name": "ASSET_LIFECYCLE"
          }
        ]
      },
      "entity": {
        "digitalasset": {
          "variationSetId": "F64C015A288D34D2E053020011ACE84E",
          "version": "0.2",
          "language": "en-GB",
          "type": "File",
          "id": "CONT6A620DAAD7CD4F62938451CC0489C329",
          "name": "asset.pdf"
        }
      },
      "message": {
        "key": "cec.event.digitalasset.updated.name",
        "parameters": null,
        "text": null
      },
      "registeredAt": "2023-03-10T02:25:59.161Z"
    }
  ]
}

例3:

/system/api/v1/auditlog/activities?q=objectType eq Digital Asset and registeredAt ge
      2022-01-02T07:14:34.888Z and registeredAt le 2023-02-05T07:14:34.888Z4

オブジェクト・タイプがデジタル・アセットであるすべてのアクティビティと、アクティビティが登録された日時がリストされます。

レスポンス本文

{
  "hasMore": true,
  "offset": 0,
  "count": 1,
  "limit": 100,
  "totalResults": 1,
  "items": [
    {
      "id": "2524",
      "event": {
        "name": "DIGITALASSET_REFERENCED",
        "categories": [
          {
            "id": 3002,
            "name": "ASSET_LIFECYCLE"
          }
        ]
      },
      "entity": {
        "digitalasset": {
          "variationSetId": null,
          "version": null,
          "language": null,
          "type": null,
          "id": "CONT8B3C157F1B5E4990BD8867B5BBCC1DCB",
          "name": "DAM_ocicecsuser1005_Jul1_18.jpg"
        }
      },
      "message": {
        "key": "cec.event.digitalasset.referenced.name",
        "parameters": [
          "DAM_ocicecsuser1005_Jul1_18.jpg"
        ],
        "text": "Digital Asset Item DAM_ocicecsuser1005_Jul1_18.jpg was referenced by item {1}."
      },
      "registeredAt": "2019-09-06T05:21:34.552Z"
    }
  ]
}

例4:

/system/api/v1/auditlog/activities?q=eventName eq DIGITALASSET_CREATED and eventName eq
      DIGITALASSET_UPDATED

これにより、イベント名がDIGITALASSET_CREATEDおよびDIGITALASSET_UPDATEDのすべてのアクティビティがリストされます。

レスポンス本文

{
  "hasMore": false,
  "offset": 0,
  "count": 2,
  "limit": 100,
  "totalResults": 2,
  "items": [
    {
      "id": "1207",
      "event": {
        "name": "DIGITALASSET_UPDATED",
        "categories": [
          {
            "id": 3002,
            "name": "ASSET_LIFECYCLE"
          }
        ]
      },
      "entity": {
        "digitalasset": {
          "variationSetId": "F64C015A288D34D2E053020011ACE84E",
          "version": "0.3",
          "language": "en-GB",
          "type": "File",
          "id": "CONT6A620DAAD7CD4F62938451CC0489C329",
          "name": "asset.pdf"
        }
      },
      "message": {
        "key": "cec.event.digitalasset.updated.name",
        "parameters": null,
        "text": null
      },
      "registeredAt": "2023-03-10T02:26:17.730Z"
    },
    {
      "id": "1202",
      "event": {
        "name": "DIGITALASSET_CREATED",
        "categories": [
          {
            "id": 3002,
            "name": "ASSET_LIFECYCLE"
          }
        ]
      },
      "entity": {
        "digitalasset": {
          "variationSetId": "F64C015A288D34D2E053020011ACE84E",
          "version": "0.1",
          "language": "en-GB",
          "type": "File",
          "id": "CONT6A620DAAD7CD4F62938451CC0489C329",
          "name": "asset1.pdf"
        }
      },
      "message": {
        "key": "cec.event.digitalasset.created.name",
        "parameters": null,
        "text": null
      },
      "registeredAt": "2023-03-07T08:14:49.207Z"
    }
  ]
}
トップに戻る