監査データのダウンロード

    監査ログを CSV 形式でダウンロードします。

    API の種類

    サーバー API

    Request URL

    https://jp1-audit.worksmobile.com/works/audit/{feature}/{service}/logs.csv

    HTTP Method

    GET

    Path Parameters

    パラメーター タイプ 必須 説明
    feature String Y "log" 固定
    service String Y 監査ログの種別
    admin, auth, home, drive, calendar, contact, form, share, note, received-mail, message, sent-mail

    Query String Parameters

    パラメーター タイプ 必須 説明
    apiId String Y API の区分 ID
    値 (例): downCsvLog (各APIの固定値)
    serviceId String Y サービス ID
    値 (例): audit (監査は audit で固定)
    version String N バージョン。指定がない場合、既定は v1
    _startDate String Y YYYYMMDD 形式のデータ照会開始日。
    トークログのみ unix timestamp 形式で時間単位の指定が可能です。
    _endDate String Y YYYYMMDD 形式のデータ照会終了日。
    開始日から終了日までの照会は最長31日まで設定可。
    トークログのみ unix timestamp 形式で時間単位の指定が可能です。(最長 1 日まで)
    _tenantId String Y テナント ID
    _domainId String Y ドメイン ID
    rangeName String Y 検索範囲。
    グループ会社全体 (tenant) または単一ドメイン (domain) を検索範囲として指定できます。
    language String N ダウンロードする CSV ファイルの言語。
    ja-JP, ko-KR, zh-CN, zh-TW, en-US
    includeBotLinkMsg String N Botのメッセージを含めるかどうかを決定する。
    Y、N(既定値、トーク検索でのみ使用)
    timezone String N タイムゾーンコード 値.
    Asia/Tokyo(既定値)

    Request Example

    https://jp1-audit.worksmobile.com/works/audit/log/message/logs.csv?apiId=downCsvLog&serviceId=audit&rangeName=domain&_startDate=20180221&_endDate=20180226&_tenantId=123456&_domainId=123456&includeBotLinkMsg=N
    

    API 呼び出し失敗

    path が /works/ で始まっていないなど URI に誤りがある場合は、下記と異なる動作をすることがあります。

    HTTP status 400

    • 不正なパラメータ
    • 不正な rangeName
    • 取得期間が31日を超えている

    HTTP status 401

    • ヘッダー情報の tenantId とパラメーターの _tenantId が異なる
    • 共通 request 設定エラー(API Gateway で検証時にヘッダー情報に誤りがある場合、当該コードとメッセージを返す)

    HTTP status 404

    • 存在しない URI

    HTTP status 500

    • その他のサーバーエラー

    ダウンロード中のエラー発生

    • ファイルの最後尾に "downloadLogs error" とエラーメッセージを出力