보고서 생성

보고서 서식을 이용하여 보고서를 생성합니다. 생성 작업의 상태는 보고서 생성 작업 조회 API로 확인하고, 진행 중인 작업은 보고서 생성 작업 취소 API로 취소할 수 있습니다.

필요 권한

사용자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d from="2024-08-12 00:00:00+0900" \
     -d to="2024-08-13 00:00:00+0900" \
     -X POST \
     https://HOSTNAME/api/sonar/report-templates/e2fad16d-8076-4c91-9d69-9419c5e6d300/build

요청 매개변수

경로 매개변수

요청 본문 매개변수

정상 응답

{
  "job": {
    "guid": "64e5d758-03a6-4616-a215-4cf44edf1e94",
    "from": "2024-08-12 00:00:00+0900",
    "to": "2024-08-13 00:00:00+0900",
    "submit_time": "2024-08-13 15:30:46+0900",
    "finish_time": "2024-08-13 15:30:50+0900",
    "error": null
  }
}

• job (맵): 보고서 생성 작업
  • guid (문자열): 보고서 생성 작업 GUID
  • from (문자열): 보고 대상 기간의 시작 일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • to (문자열): 보고 대상 기간의 끝 일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • submit_time (문자열): 제출 일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • finish_time (문자열): 완료 일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • error (문자열): 오류 메시지. 오류가 없으면 null

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "template_guid should be not null"
}

template_guid가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "template_guid should be guid type."
}

from 또는 to의 날짜 형식이 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'from' parameter should be date format (yyyy-MM-dd HH:mm:ss+0000)"
}

보고서 서식이 존재하지 않는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "report template not found",
  "error_msg": null
}

권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}