概要

チェック結果に対する詳細インスタンス情報を提供します。
チェックリストの照会機能にて照会できる 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

この記事は役に立ちましたか?

概要
API
リクエスト
レスポンス
- Response Body

タグ

Cloud Advisor