점검 결과 상세 조회
- 인쇄
- PDF
점검 결과 상세 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
- 점검 결과에 대한 상세 인스턴스 정보를 제공합니다.
- 점검 항목 조회 기능에서 조회되는 checkResultType 필드의 값이 TABLE인 경우만 인스턴스 정보가 제공됩니다.
- 점검 항목 조회 기능에서 조회되는 tableHeaderInfo 필드의 값을 통해 상세 인스턴스 정보에서 응답 될 필드들의 정보를 알 수 있습니다.
- 표시 옵션 파라미터에 따른 포함/제외된 인스턴스들만 제공합니다.
- 표시 옵션 파라미터의 기본 값으로는 포함 인스턴스들만 제공합니다.
- 각 인스턴스를 포함/제외하는 설정은 점검 결과 상세 포함 설정 / 점검 결과 상세 제외 설정 기능을 통해 설정할 수 있습니다.
API
- GET /categories/{categoryCode}/checkitems/{itemCode}/result-detail
요청
Headers
개요에 명시된 공통 요청 헤더가 필요합니다.
Path Variables
파라미터명 | 필수 여부 | 타입 | 제약사항 | 설명 |
---|---|---|---|---|
categoryCode | N | String | 제공 카테고리 및 점검 항목 참고해 주시기 바랍니다. | 카테고리 코드 |
itemCode | N | String | 제공 카테고리 및 점검 항목 참고해 주시기 바랍니다. | 점검 항목 코드 |
Query Parameters
파라미터명 | 필수 여부 | 타입 | 제약사항 | 설명 |
---|---|---|---|---|
display | N | String | all, included, excluded (default: included) | 표시 옵션에 따른 인스턴스만 표시(포함/제외 항목). all: 모든 인스턴스 응답 included: 포함 항목만 응답 excluded: 제외 항목만 응답 |
page | Y | Integer | #page >= 1 | 페이지 처리를 위한 응답 페이지 설정. 1부터 시작. |
size | Y | Integer | #size >= 1 | 페이지 처리를 위한 페이지 사이즈 설정. 1부터 시작. |
응답
Response Body
{
"result": "SUCCESS",
"contents": {
"itemCode": String,
"meta": {
"totalPage": Long,
"currentPage": Long,
"size": Long
},
"data": List<ResultTableRow>
}
}
응답 필드명 | 필수 여부 | 타입 | 제약사항 | 설명 |
---|---|---|---|---|
itemCode | Y | String | 카테고리 코드 | |
meta | Y | Meta | 페이지 처리를 위한 페이지 메타 데이터 | |
Meta.totalPage | Y | Long | 페이지 처리를 위한 페이지 메타 데이터 | |
Meta.currentPage | Y | Long | 페이지 처리를 위한 페이지 메타 데이터 | |
Meta.size | Y | Long | 페이지 처리를 위한 페이지 메타 데이터 | |
data | Y | List<ResultTableRow> | 점검 결과의 인스턴스 정보 ResultTableRow 의 필드는 점검 결과 상세 조회 기능의 tableHeaderInfo 필드에서 표시됨 | |
ResultTableRow.instanceKey | Y | String | 점검 결과 인스턴스의 기본 필드 인스턴스를 구분하는 unique key |
이 문서가 도움이 되었습니까?