チェック結果の詳細除外設定
- 印刷する
- PDF
チェック結果の詳細除外設定
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
- 詳細インスタンス情報の提供時に除外するインスタンスを設定します。
- リクエストボティに存在しない instanceKeyが含まれている場合でもエラーが発生せず、リクエストボディに含まれた全ての instanceKeyのうち、存在する instanceKeyに対してのみ設定されます。
API
- POST /categories/{categoryCode}/checkitems/{itemCode}/result-detail/exclude
リクエスト
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/exclude
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に対してのみ設定されます。
この記事は役に立ちましたか?