점검 결과 상세 포함 설정
- 인쇄
- PDF
점검 결과 상세 포함 설정
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
- 상세 인스턴스 정보 제공 시 포함할 인스턴스를 설정합니다.
- 요청 바디에서 존재하지 않는 instanceKey 가 포함되어 있더라도 오류를 발생시키지 않으며, 요청 바디에 포함된 모든 instanceKey 중 존재하는 instanceKey에 대해서만 설정됩니다.
API
- POST /categories/{categoryCode}/checkitems/{itemCode}/result-detail/include
요청
Headers
개요에 명시된 공통 요청 헤더가 필요합니다.
Path Variables
| 파라미터명 | 필수 여부 | 타입 | 제약사항 | 설명 |
|---|---|---|---|---|
| categoryCode | N | String | 제공 카테고리 및 점검 항목 참고해 주시기 바랍니다. | 카테고리 코드 |
| itemCode | N | String | 제공 카테고리 및 점검 항목 참고해 주시기 바랍니다. | 점검 항목 코드 |
Request Body
| 필드명 | 필수 여부 | 타입 | 제약사항 | 설명 |
|---|---|---|---|---|
| {root} | Y | List<String> | 점검 결과 상세 조회 기능에서 조회 가능한 각 결과 인스턴스의 instanceKey | instanceKey 를 문자열 리스트로 전달 대소문자를 구분함 |
요청 예시
POST /categories/SECURITY/checkitems/SUB_ACCOUNT_ACCESSKEY/result-detail/include
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}
x-ncp-dmn_cd: PUB
x-ncp-region_code: {your region code}
Payload:
["instanceKey-A", "instanceKey-B", "instanceKey-C"]
응답
Response Body
{
"result": "SUCCESS",
"contents": "done"
}
- API 가 수행된 후 요청 완료를 알리는 문자열만을 응답합니다.
- 요청 바디에서 존재하지 않는 instanceKey 가 포함되어 있더라도 오류를 발생시키지 않으며, 요청 바디에 포함된 모든 instanceKey 중 존재하는 instanceKey에 대해서만 설정됩니다.
이 문서가 도움이 되었습니까?