監査エンドポイント

Current version: 4.0

監査インデックスのクエリに使用できるエンドポイントのリストは、/api/audit にあります。

URL テンプレートの展開パラメーターに注目してください。 *を使用すると、URL は、値のリストを持つキーではなく、キーと値のペアのリストに展開されます。 例:

RequestResponse
Uri.expand("{?userIds*}", { userIds: [1, 2] })

?userIds=1,2 ではなく ?userIds=1&userIds=2 に展開されます。

クエリ

クエリ エンドポイントでは、次の形式の URL を使用します。

RequestResponse
GET /api/audit/<index name>/query{/entityId}{?from,to,fullText,skip,take,sort,order}

クエリ エンドポイントでは、次のパラメーターがサポートされています。

名前サンプル値説明
entityIdlong9962監査対象エンティティの ID (任意)
fromDateTime2018-07-01T08:00Z開始日時
toDateTime2018-07-02T08:00Z終了日時
fullTextstringasset全文検索のフレーズ
skipint0ページング - 指定したアイテム インデックスを起点とします
takeint10ページング - 指定した数のアイテムを表示します
sortstringtimeStamp並べ替えの基準とする Elasticsearch 検索フィールド
order文字列desc並べ替え順序 -「asc」または「desc」

応答:

RequestResponse
{
  "items": [
      ... documents  ...
  ],
  "total_items": 15,
  "returned_items": 10,
  "next": {
      "href": "<link to next page>",
      "title": ...
  },
  "previous": {
      "href": "<link to previous page>",
      "title": ...
  },
  "self": {
      "href": "<link to current page>",
      "title": ...
  }
}

一部のエンドポイントには、追加のパラメーター セットが用意されています。 違いについては、対応する各セクションで示します。

スクロール

ES (Elasticsearch) クエリで許容される数よりも多くのアイテムをフェッチする必要がある場合は、スクロール API を使用する必要があります。 ページングは一方向にのみ可能で、エンティティのスクロール エンドポイントと同様に機能します。

エンドポイントのベース アドレス テンプレートは次のとおりです。

RequestResponse
GET /api/audit/<index name>/scroll{/entityId}{?scroll_time,scroll_id,from,to,fullText,skip,take,sort,order}

各スクロール エンドポイントは、対応するクエリ エンドポイントと同じパラメーター セットを受け入れます。

スクロール固有のパラメーターは、次の 2 つです。

名前サンプル値説明
scroll_id文字列DXF1..U1QQ==ES によって割り当てられたスクロール ID。このパラメーターは、応答ペイロードの next リンクに自動的に追加されます。
scrol_timeTimeSpanraw作成されたスクロールを ES で存続させる期間を決定します。指定されていない場合、値は一元化された設定の reporting セクションから取得されます (既定は 5000 ミリ秒)。

生成

生成エンドポイントは、ログ全体またはそのサブセットのダウンロードを指示するために使用されます。 エンドポイントでは、次の形式の URL を使用します。

RequestResponse
POST /api/audit/<index name>/generate

生成エンドポイントでは、次のパラメーターがサポートされています。

名前サンプル値説明
audit_type文字列rawraw、business、scripting、action、trigger のいずれかの値
formatstringcsvcsv、json のいずれかの値
fromDateTime2018-07-01T08:00Z開始日時
toDateTime2018-07-02T08:00Z終了日時
filterdict{ "user_id": ["6"] }選択した監査インデックスに適用される一連のフィルター

応答ヘッダー:

RequestResponse
Location: <url to download order>

未処理のクエリ

未処理のクエリは、プロパティやリレーションの変更など、エンティティを含む未処理の監査インデックスをクエリします。

エンドポイント:

RequestResponse
GET /api/audit/raw/query{/entityId}{?eventTypes*,definitionNames*,userIds*,properties*,relations*,culture,from,to,fullText,skip,take,sort,order}

追加のパラメーター:

名前サンプル値説明
eventTypes文字列EntityUpdated監査対象のイベントのタイプ
definitionNamesstringM.Assetエンティティの定義名
userIdslong1211ユーザー ID
propertiesstringTitle指定したプロパティに対して行われた変更を基準としたフィルタリング
relationsstringAssetToAssetMedia指定したリレーションに対して行われた変更を基準としたフィルタリング
culturestringen-US応答データのカルチャ

ビジネス クエリ

ビジネス クエリは、ビジネス監査インデックスをクエリします。

エンドポイント:

RequestResponse
GET /api/audit/business/query{/entityId}{?logType*,raw,from,to,fullText,skip,take,sort,order}

追加のパラメーター:

名前サンプル値説明
logType文字列useraudit指定したタイプを基準としたフィルタリング
raw文字列(非推奨) 未処理の Elasticsearch 検索クエリ - 互換性のために残されたパラメーター

ビジネス生成

追加のパラメーター:

名前サンプル値説明
log_type文字列userauditフィルター プロパティを上書きして、指定したログ タイプをフィルターとして設定します

スクリプト クエリ

スクリプト監査インデックスをクエリします。

エンドポイント:

RequestResponse
GET /api/audit/scripting/query{/entityId}{?scriptType,scriptName,scriptContentId,scriptContentIdentifier,errorMessage,executionSource,id,eventType,severity,targetId,targetIdentifier,userId,from,to,fullText,skip,take,sort,order}

追加のパラメーター:

名前サンプル値説明
scriptType文字列UserPreRegistrationスクリプトのタイプ。 可能な値: UserPreRegistration、UserPostRegistration、UserSignIn、MetadataProcessing、ActionScript
scriptNamestringfooScriptスクリプト名
scriptContentIdlong1234スクリプト コンテンツ エンティティの ID
scriptContentIdentifierstringzfSGGTUNhkKVdY9U-z49iQスクリプト コンテンツ エンティティの ID
errorMessagestringfailedエラー メッセージのフラグメント
executionSourcestringAutomaticスクリプトの実行ソース。 可能な値: Automatic、Trigger、WebApi、Command、ExternalAction、MassEdit
idguid0ccd58cf-c83f-42ba-907f-44d8950a20fd監査メッセージの ID
eventTypestringCreatedイベント タイプ。 可能な値: Created、Updated、Deleted、Enabled、Disabled、Executed
severitystringWarning監査エントリの重大度。 可能な値: Debug、Warning、Info、Error、Fatal
targetIdlong1234監査対象エンティティの ID
targetIdentifierstringzfSGGTUNhkKVdY9U-z49iQ監査対象エンティティの ID
userIdlong1234監査エントリの作成をトリガーしたユーザーの ID

アクション クエリ

アクション監査インデックスをクエリします。

エンドポイント:

RequestResponse
GET /api/audit/action/query{/entityId}{?actionType,actionPhase,executionType,executionSource,executionTime,messageId,retryCount,success,id,eventType,severity,targetId,targetIdentifier,userId,from,to,fullText,skip,take,sort,order}

追加のパラメーター:

名前サンプル値説明
actionType文字列ApiCallアクションのタイプ。 可能な値: ApiCall、ActionScript、AzureEventHub、ReportingChannel、PrintEntityGeneration、StartBpmAutomation、StartSmAutomation、AzureServiceBus、MAzureServiceBus
actionPhasestringPreアクションが実行されるフェーズ。可能な値: Post、Pre、Security、Validation、Audit
executionTypestringInProcess実行のタイプ。 可能な値: OutOfProcess、InProcess
executionSourcestringTrigger実行ソース。 可能な値: Unknown、Trigger、ExternalAction、Command、WebApi、MassEdit、BPM
executionTimelong234ミリ秒単位の経過実行時間
messageIdlong1234メッセージ ID
retryCountint3再試行回数
successbooltrueアクションが正常に実行されたかどうか
idguid0ccd58cf-c83f-42ba-907f-44d8950a20fd監査メッセージの ID
eventTypestringCreatedイベント タイプ。 可能な値: Created、Updated、Deleted、Enabled、Disabled、Executed
severitystringWarning監査エントリの重大度。 可能な値: Debug、Warning、Info、Error、Fatal
targetIdlong1234監査対象エンティティの ID
targetIdentifierstringzfSGGTUNhkKVdY9U-z49iQ監査対象エンティティの ID
userIdlong1234監査エントリの作成をトリガーしたユーザーの ID

トリガー クエリ

トリガー監査インデックスをクエリします。

エンドポイント:

RequestResponse
GET /api/audit/trigger/query{/entityId}{?executionType,objective,id,eventType,severity,targetId,targetIdentifier,userId,from,to,fullText,skip,take,sort,order}

追加のパラメーター:

名前サンプル値説明
executionType文字列InProcess実行のタイプ。 可能な値: OutOfProcess、InProcess
objectivestringEntityDeletionイベントを分類する目的。 可能な値: EntityDefinitionCreation、EntityDefinitionModification、EntityDefinitionDeletion、EntityCreation、EntityModification、EntityDeletion
idguid0ccd58cf-c83f-42ba-907f-44d8950a20fd監査メッセージの ID
eventTypestringCreatedイベント タイプ。 可能な値: Created、Updated、Deleted、Enabled、Disabled、Executed
severitystringWarning監査エントリの重大度。 可能な値: Debug、Warning、Info、Error、Fatal
targetIdlong1234監査対象エンティティの ID
targetIdentifierstringzfSGGTUNhkKVdY9U-z49iQ監査対象エンティティの ID
userIdlong1234監査エントリの作成をトリガーしたユーザーの ID

Do you have some feedback for us?

If you have suggestions for improving this article,