チェック結果の詳細照会
    • PDF

    チェック結果の詳細照会

    • PDF

    記事の要約

    概要

    • チェック結果に対する詳細インスタンス情報を提供します。
    • チェックリストの照会機能にて照会できる checkResultTypeフィールド値が TABLEの場合のみ、インスタンス情報を提供します。
    • チェックリストの照会機能にて照会できる tableHeaderInfoフィールド値を通じて詳細インスタンス情報からレスポンスするフィールドの情報をご確認いただけます。
    • 表示オプションパラメータによって包含/除外されたインスタンスのみ提供します。
      • 表示オプションパラメータのデフォルト値としては、包含インスタンスのみご提供します。
      • 各々のインスタンスを包含/除外する設定は、チェック結果の詳細設定 / チェック結果の詳細除外設定機能を通じて設定します。

    API

    • GET /categories/{categoryCode}/checkitems/{itemCode}/result-detail

    リクエスト

    Headers

    概要に明示された共通リクエストヘッダが必要です。

    Path Variables

    パラメータ名要否タイプ制約事項説明
    categoryCodeNString提供カテゴリおよびチェックリストをご参照ください。カテゴリコード
    itemCodeNString提供カテゴリおよびチェックリストをご参照ください。チェックリストコード

    Query Parameters

    パラメータ名要否タイプ制約事項説明
    displayNStringall, included, excluded (default: included)表示オプションによるインスタンスのみ表示(包含/除外リスト)。
    all: 全てのインスタンスにレスポンス
    included: 包含リストのみレスポンス
    excluded: 除外リストのみレスポンス
    pageYInteger#page >= 1ページ処理のためのレスポンスページの設定。
    1から開始。
    sizeYInteger#size >= 1ページ処理のためのページサイズの設定。
    1から開始。

    レスポンス

    Response Body

    {
      "result": "SUCCESS",
      "contents": {
        "itemCode": String,
        "meta": {
          "totalPage": Long,
          "currentPage": Long,
          "size": Long
        },
        "data": List<ResultTableRow>
      }
    }
    
    レスポンスフィールド名要否タイプ制約事項説明
    itemCodeYStringカテゴリコード
    metaYMetaページ処理のためのページメタデータ
    Meta.totalPageYLongページ処理のためのページメタデータ
    Meta.currentPageYLongページ処理のためのページメタデータ
    Meta.sizeYLongページ処理のためのページメタデータ
    dataYList<ResultTableRow>チェック結果のインスタンス情報
    ResultTableRowのフィールドは、チェック結果の詳細照会機能tableHeaderInfoフィールドに表示
    ResultTableRow.instanceKeyYStringチェック結果インスタンスの基本フィールド
    インスタンスを区別する unique key

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.