フォルダイベント履歴情報取得

フォルダイベント履歴情報を取得します。

(1) 必要な権限

GetFolderEventLog APIを使用するには以下の権限のいずれかが必要です。

  • 履歴の参照権限

  • 履歴の削除権限

 

管理対象種別による違いは以下のとおりです。

システム全体

任意のフォルダイベントの履歴情報を取得可能

グループ単位

以下のフォルダイベントの履歴情報のみ取得可能

  • 管理対象グループのユーザが実行したフォルダイベント

  • APIを使用するユーザ自身が実行したフォルダイベント

  • 管理対象グループのユーザ、およびAPIを使用するユーザ自身がアクセスできるオブジェクトに紐づく、load_type(転送種別)が“3”(スケジュールイベント)のフォルダイベント

= 備考 =

権限がなくても、APIを使用するユーザのフォルダイベント履歴情報は取得できます。

(2) リクエストURL

http(s)://Domain:xxxx/コンテキスト名/GetFolderEventLog

(3) リクエストインタフェース

表1.59 フォルダイベント履歴情報取得のリクエストインタフェースの項目

項目名

説明

文字

省略

省略値

operation_id

処理識別子(検索条件)

処理識別子を34バイトで指定します。

半角

ブランク

folder_event_id

フォルダイベントID(検索条件)

フォルダイベントIDを32バイト以内で指定します。

半角

ブランク

object_id

オブジェクトID(検索条件)

オブジェクトIDを16バイトで指定します。

半角

ブランク

status

ステータス(検索条件)

0

すべて

1

正常(完了コード=0)

2

異常(完了コード≠0)

半角

0

date_from

日付(自)(検索条件)

YYYYMMDDHHMMSS形式

半角

ブランク

date_to

日付(至)(検索条件)

YYYYMMDDHHMMSS形式

半角

ブランク

(4) レスポンスインタフェース

表1.60 フォルダイベント履歴情報取得のレスポンスインタフェースの項目

項目名

説明

備考

info_folderevent_log

フォルダイベント履歴情報

フォルダイベント履歴情報が単一または複数返却されます。

operation_id

処理識別子

object_id

オブジェクトID

group_id

グループID

user_id

ユーザID

start_date

開始日

start_time

開始時刻

end_date

終了日

end_time

終了時刻

return_code

完了コード

detail_code

詳細コード

folder_event_id

フォルダイベントID

object_path

オブジェクトパス

load_type

転送種別

event_filter

適用条件

event_trigger

発生条件

download_limit

ダウンロード回数

save_limit

保存期限

mail_execute_flag

メール連携可否

mail_return_code

メール連携完了コード

mail_detail_code

メール連携詳細コード

mail_to

宛先(TO)

mail_cc

宛先(CC)

mail_bcc

宛先(BCC)

mail_subject

タイトル

mail_message

本文

mail_precondition

メール連携前提イベント

hulft_execute_flag

HULFT連携可否

hulft_return_code

HULFT連携完了コード

hulft_detail_code

HULFT連携詳細コード

hulft_type

配信、集信種別

hulft_fileid

ファイルID

hulft_sync_flag

HULFT同期フラグ

hulft_wait

HULFT同期待ち時間

hulft_rcv_registration_type

HULFT集信連携ファイル登録種別

hulft_msg0

メッセージ0

hulft_msgl0

拡張メッセージ0

hulft_msgl1

拡張メッセージ1

hulft_transfer_id

HULFT転送識別子

hulft_precondition

HULFT連携前提イベント

command_execute_flag

アプリ連携可否

cmd1_return_code

コマンド1完了コード

cmd2_return_code

コマンド2完了コード

cmd3_return_code

コマンド3完了コード

cmd_file_upload_return_code

コマンドファイルアップロード完了コード

cmd1_detail_code

コマンド1詳細コード

cmd2_detail_code

コマンド2詳細コード

cmd3_detail_code

コマンド3詳細コード

cmd_file_upload_detail_code

コマンドファイルアップロード詳細コード

cmd1_command_string

コマンド1

cmd2_command_string

コマンド2

cmd3_command_string

コマンド3

cmd_file_upload_execute_flag

コマンドファイルアップロード実行区分

command_precondition

アプリ連携前提イベント

move_execute_flag

フォルダ移動実行可否

move_return_code

移動連携完了コード

move_destination_path

移動先パス

move_registration_type

移動連携ファイル登録種別

move_precondition

フォルダ移動前提イベント

comment

コメント

*1

*1

:

XMLフォーマットで返されます。形式は以下のとおりです。

<info_ folderevent_log>
  <operation_id>処理識別子</operation_id>
  <object_id>オブジェクトID</object_id>
  <group_id>グループID</group_id>
  <user_id>ユーザID</user_id>
  <start_date>開始日</start_date>
  <start_time>開始時刻</start_time>
  <end_date>終了日</end_date>
  <end_time>終了時刻</end_time>
  <return_code>完了コード</return_code>
  <detail_code>詳細コード</detail_code>
  <folder_event_id>フォルダイベントID</folder_event_id>
  <object_path>オブジェクトパス</object_path>
  <load_type>転送種別</load_type>
  <event_filter>適用条件</event_filter>
  <event_trigger>発生条件</event_trigger>
  <download_limit>ダウンロード回数</download_limit>
  <save_limit>保存期限</save_limit>
  <mail_execute_flag>メール連携可否</mail_execute_flag>
  <mail_return_code>メール連携完了コード</mail_return_code>
  <mail_detail_code>メール連携詳細コード</mail_detail_code>
  <mail_to>宛先(TO)</mail_to>
  <mail_cc>宛先(CC)</mail_cc>
  <mail_bcc>宛先(BCC)</mail_bcc>
  <mail_subject>タイトル</mail_subject>
  <mail_message>本文</mail_message>
  <mail_precondition>メール連携前提イベント</mail_precondition>
  <hulft_execute_flag>HULFT連携可否</hulft_execute_flag>
  <hulft_return_code>HULFT連携完了コード</hulft_return_code>
  <hulft_detail_code>HULFT連携詳細コード</hulft_detail_code>
  <hulft_type>配信、集信種別</hulft_type>
  <hulft_fileid>ファイルID</hulft_fileid>
  <hulft_sync_flag>HULFT同期フラグ</hulft_sync_flag>
  <hulft_wait>HULFT同期待ち時間</hulft_wait>
  <hulft_rcv_registration_type>HULFT集信連携ファイル登録種別</hulft_rcv_registration_type>
  <hulft_msg0>メッセージ0</hulft_msg0>
  <hulft_msgl0>拡張メッセージ0</hulft_msgl0>
  <hulft_msgl1>拡張メッセージ1</hulft_msgl1>
  <hulft_transfer_id>HULFT転送識別子</hulft_transfer_id>
  <hulft_precondition>HULFT連携前提イベント</hulft_precondition>
  <command_execute_flag>アプリ連携可否</command_execute_flag>
  <cmd1_return_code>コマンド1完了コード</cmd1_return_code>
  <cmd2_return_code>コマンド2完了コード</cmd2_return_code>
  <cmd3_return_code>コマンド3完了コード</cmd3_return_code>
  <cmd_file_upload_return_code>コマンドファイルアップロード完了コード</cmd_file_upload_return_code>
  <cmd1_detail_code>コマンド1詳細コード</cmd1_detail_code>
  <cmd2_detail_code>コマンド2詳細コード</cmd2_detail_code>
  <cmd3_detail_code>コマンド3詳細コード</cmd3_detail_code>
  <cmd_file_upload_detail_code>コマンドファイルアップロード詳細コード</cmd_file_upload_detail_code>
  <cmd1_command_string>コマンド1</cmd1_command_string>
  <cmd2_command_string>コマンド2</cmd2_command_string>
  <cmd3_command_string>コマンド3</cmd3_command_string>
  <cmd_file_upload_execute_flag>コマンドファイルアップロード実行区分</cmd_file_upload_execute_flag>
  <command_precondition>アプリ連携前提イベント</command_precondition>
  <move_execute_flag>フォルダ移動実行可否</move_execute_flag>
  <move_return_code>移動連携完了コード</move_return_code>
  <move_destination_path>移動先パス</move_destination_path>
  <move_registration_type>移動連携ファイル登録種別</move_registration_type>
  <move_precondition>フォルダ移動前提イベント</move_precondition>
  <comment>コメント</comment>
</info_ folderevent_log>