57장. 보고서 서비스
57.1. 보고서 서비스
57.1.1. CancelReport
DELETE /v2/reports/jobs/{id}/cancel
지정된 보고서 ID에 대한 대기 중인 보고서 작업을 취소합니다.Cancels a queued report job for the given report id. 작업이 활성 상태가 아니면 noop입니다. 보고서가 이미 준비 중인 경우 취소되지 않습니다.
57.1.1.1. 설명
57.1.1.2. 매개 변수
57.1.1.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
57.1.1.3. 반환 유형
개체
57.1.1.4. 콘텐츠 유형
- application/json
57.1.1.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
57.1.1.6. Samples
57.1.2. CountReportConfigurations
GET /v2/reports/configuration-count
CountReportConfigurations는 보고서 구성 수를 반환합니다.
57.1.2.1. 설명
57.1.2.2. 매개 변수
57.1.2.2.1. 쿼리 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | 설정되지 않음 | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
57.1.2.3. 반환 유형
57.1.2.4. 콘텐츠 유형
- application/json
57.1.2.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
57.1.2.6. Samples
57.1.3. DeleteReport
DELETE /v2/reports/jobs/{id}/delete
지정된 보고서 ID에 대해 생성된 보고서 삭제
57.1.3.1. 설명
57.1.3.2. 매개 변수
57.1.3.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
57.1.3.3. 반환 유형
개체
57.1.3.4. 콘텐츠 유형
- application/json
57.1.3.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
57.1.3.6. Samples
57.1.4. DeleteReportConfiguration
DELETE /v2/reports/configurations/{id}
DeleteReportConfiguration은 지정된 ID로 보고서 구성을 제거합니다.
57.1.4.1. 설명
57.1.4.2. 매개 변수
57.1.4.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
57.1.4.3. 반환 유형
개체
57.1.4.4. 콘텐츠 유형
- application/json
57.1.4.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
57.1.4.6. Samples
57.1.5. GetMyReportHistory
GET /v2/reports/configurations/{id}/my-history
GetMyReportHistory는 지정된 ID가 있는 보고서 구성에 대한 요청자의 보고서 작업 기록을 반환합니다.GetMyReportHistory returns the requester's report job history for a report configuration with the specified ID.
57.1.5.1. 설명
57.1.5.2. 매개 변수
57.1.5.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
57.1.5.2.2. 쿼리 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| reportParamQuery.query | - | null | ||
| reportParamQuery.pagination.limit | - | null | ||
| reportParamQuery.pagination.offset | - | null | ||
| reportParamQuery.pagination.sortOption.field | - | null | ||
| reportParamQuery.pagination.sortOption.reversed | - | null | ||
| reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc | - | 설정되지 않음 | ||
| reportParamQuery.pagination.sortOption.aggregateBy.distinct | - | null |
57.1.5.3. 반환 유형
57.1.5.4. 콘텐츠 유형
- application/json
57.1.5.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
57.1.5.6. Samples
57.1.6. GetReportConfiguration
GET /v2/reports/configurations/{id}
GetReportConfiguration은 지정된 ID가 있는 보고서 구성을 반환합니다.
57.1.6.1. 설명
57.1.6.2. 매개 변수
57.1.6.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
57.1.6.3. 반환 유형
57.1.6.4. 콘텐츠 유형
- application/json
57.1.6.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
57.1.6.6. Samples
57.1.7. GetReportHistory
GET /v2/reports/configurations/{id}/history
GetReportHistory는 지정된 ID를 사용하여 보고서 구성에 대한 전체 보고서 작업 기록을 반환합니다.GetReportHistory returns the full report job history for a report configuration with the specified ID.
57.1.7.1. 설명
57.1.7.2. 매개 변수
57.1.7.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
57.1.7.2.2. 쿼리 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| reportParamQuery.query | - | null | ||
| reportParamQuery.pagination.limit | - | null | ||
| reportParamQuery.pagination.offset | - | null | ||
| reportParamQuery.pagination.sortOption.field | - | null | ||
| reportParamQuery.pagination.sortOption.reversed | - | null | ||
| reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc | - | 설정되지 않음 | ||
| reportParamQuery.pagination.sortOption.aggregateBy.distinct | - | null |
57.1.7.3. 반환 유형
57.1.7.4. 콘텐츠 유형
- application/json
57.1.7.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
57.1.7.6. Samples
57.1.8. GetReportStatus
GET /v2/reports/jobs/{id}/status
GetReportStatus는 지정된 보고서 ID에 대한 보고서 상태를 반환합니다.
57.1.8.1. 설명
57.1.8.2. 매개 변수
57.1.8.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
57.1.8.3. 반환 유형
57.1.8.4. 콘텐츠 유형
- application/json
57.1.8.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
57.1.8.6. Samples
57.1.9. ListReportConfigurations
GET /v2/reports/configurations
ListReportConfigurations는 지정된 쿼리와 일치하는 보고서 구성 반환
57.1.9.1. 설명
57.1.9.2. 매개 변수
57.1.9.2.1. 쿼리 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
57.1.9.3. 반환 유형
57.1.9.4. 콘텐츠 유형
- application/json
57.1.9.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
57.1.9.6. Samples
57.1.10. PostReportConfiguration
POST /v2/reports/configurations
PostReportConfiguration에서 보고서 구성을 생성
57.1.10.1. 설명
57.1.10.2. 매개 변수
57.1.10.2.1. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
57.1.10.3. 반환 유형
57.1.10.4. 콘텐츠 유형
- application/json
57.1.10.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
57.1.10.6. Samples
57.1.11. RunReport
POST /v2/reports/run
이 보고서를 요청하는 사용자에게 다른 대기 또는 동일한 보고서 구성에 대한 보고서를 준비하지 않은 경우 새 보고서 생성 요청을 제출합니다.
57.1.11.1. 설명
57.1.11.2. 매개 변수
57.1.11.2.1. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
57.1.11.3. 반환 유형
57.1.11.4. 콘텐츠 유형
- application/json
57.1.11.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
57.1.11.6. Samples
57.1.12. UpdateReportConfiguration
PUT /v2/reports/configurations/{id}
UpdateReportConfiguration은 보고서 구성 업데이트
57.1.12.1. 설명
57.1.12.2. 매개 변수
57.1.12.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
57.1.12.2.2. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
57.1.12.3. 반환 유형
개체
57.1.12.4. 콘텐츠 유형
- application/json
57.1.12.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}