감사 데이터 파일 다운로드

    감사 데이터 파일을 다운로드한다.

    API 종류

    서버 API

    Request URL

    https://audit.worksmobile.com/r/{API ID}/audit/v2/{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, developer, template, deleted-mail, task, call, mobile-capture

    Query String Parameters

    파라미터 타입 필수 설명
    apiId
    String
    		 Y API를 구분 짓는 ID.
    예) downCsvLog(각 API의 고정값)
    serviceId
    String
    		 Y 서비스 ID.
    예) audit(감사는 audit로 고정)
    startDate String Y YYYYMMDD 형식의 감사 데이터 조회 시작일.
    시작일에서 종료일까지 조회 기간은 최대 31일로 설정할 수 있다.
    endDate String Y YYYYMMDD 형식의 감사 데이터 조회 종료일.
    시작일에서 종료일까지 조회 기간은 최대 31일로 설정할 수 있다.
    tenantId String Y 테넌트 ID
    domainId String Y 도메인 ID
    rangeName String Y 검색 범위.
    그룹사 전체(tenant) 또는 단일 도메인(domain)을 검색 범위로 지정할 수 있다.
    language String N 다운로드되는 엑셀 파일의 표시 언어.
    ko-KR, zh-CN, zh-TW, en-US(기본값), ja-JP
    botLinkMsg String N 봇 메시지의 포함 여부를 결정한다.
    • I: 포함(기본값)
    • E: 제외
    • O: 봇메시지만
    timezone String N 타임존 코드.
    Asia/Seoul(기본값)

    Request Example

    https://audit.worksmobile.com/r/kr1jJQFeYUdDn/audit/v2/log/message/logs.csv?rangeName=domain&startDate=20201028&endDate=20201028&tenantId=7&domainId=7&serviceId=audit&apiId=downCsvLog

    API 호출 실패

    화면 정보를 처리하는 서버에서 API 정보를 같이 처리하므로 URI path가 /works/로 시작하지 않는 경우에는 다르게 동작할 수 있다.

    HTTP status 400

    • 파라미터 형식이 어긋날 경우
    • 잘못된 rangeName이 들어갈 경우
    • 조회하려는 기간이 31일이 넘을 경우

    HTTP status 401

    • 헤더 정보의 tenantId와 파라미터의 _tenantId 정보가 다를 경우
    • 공통 request 설정 오류(API GW에서 검증하는 헤더 정보 오류인 경우, 해당 코드와 메시지를 그대로 중계함)

    HTTP status 404

    • 없는 URI를 호출한 경우

    HTTP status 500

    • 기타 서버 오류

    다운로드 중 오류 발생

    • 파일 마지막에 "downloadLogs error" 이후 오류 메시지가 출력됨