移動先

• リクエスト
• レスポンス

サブスクライブされているターゲットのパッチ・コンプライアンスのレポート

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/targetsPatchComplianceReport

すべてのサブスクライブされたターゲットのパッチ・コンプライアンス・レポート

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ソースの表示

• excludeList: array excludeList
  レスポンスで指定した詳細を除外
• limit: number
  現在のフェッチの制限(アイテムの合計数のみをフェッチするには、limit=0を設定する必要があります)

  例: 10
• page: string
  Base 64でエンコードされたページ

  例: b2Zmc2V0OjA
• sort: string
  オプションのソート方向に従ってフィールドをソートします。ソートでサポートされる属性は、'targetName'、'targetType'、'hostName'、'release'、'platform'、'imageName'、'imageVersionName'、'imageVersionDescription'、'targetStatus'、'clusterName'、'additionalPatchCount'、'currentVersionName'、'dbMachineName'です。有効なソート方向には、昇順と降順があります。ソート方向を指定しない場合、デフォルトでascが使用されます。

  例: name:asc

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsPatchComplianceReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName','targetType', 'hostName', 'release', 'platform','imageName','imageVersionName','imageVersionDescription','targetStatus', 'clusterName', 'additionalPatchCount', 'currentVersionName', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"name:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":"10"
        },
        "excludeList":{
            "description":"exclude the given details in response",
            "type":"array",
            "items":{
                "enum":[
                    "total"
                ]
            }
        }
    }
}

すべてに一致

ソースの表示

• object TargetsPatchComplianceReportFilter
  サブスクライブされているターゲット・コンプライアンス・レポートのフィルタ

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsPatchComplianceReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName','targetType', 'hostName', 'release', 'platform','imageName','imageVersionName','imageVersionDescription','targetStatus', 'clusterName', 'additionalPatchCount', 'currentVersionName', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"name:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":"10"
        },
        "excludeList":{
            "description":"exclude the given details in response",
            "type":"array",
            "items":{
                "enum":[
                    "total"
                ]
            }
        }
    }
}

ネストされたスキーマ: excludeList

型: array

レスポンスで指定した詳細を除外

ソースの表示

• 配列:
  指定可能な値: [ "total" ]

{
    "description":"exclude the given details in response",
    "type":"array",
    "items":{
        "enum":[
            "total"
        ]
    }
}

ネストされたスキーマ: TargetsPatchComplianceReportFilter

型: object

サブスクライブされているターゲット・コンプライアンス・レポートのフィルタ

ソースの表示

• imageId: string
  イメージのID

  例: E77FC170F57D4B64E0531D0E4B64DA85
• imageNameMatches: string
  イメージ名のワイルドカード検索

  例: %img%
• isOnCurrentImage: boolean
  ターゲットのパッチレベル(trueターゲットは現在のイメージにパッチが適用され、falseターゲットは現在以外のイメージにパッチが適用されます)
• platform: string
  ターゲットのプラットフォーム

  例: linux_x64_86
• releaseMatches: string
  ターゲットのリリースでのワイルドカード検索

  例: 19.14%
• targetNameMatches: string
  ターゲット名のワイルドカード検索

  例: %orcl%
• targetProperties: object targetProperties
  ターゲットのプロパティ
• targetTypeList: array targetTypeList
  ターゲット・タイプのリスト

{
    "description":"Filters for the subscribed targets compliance report",
    "type":"object",
    "properties":{
        "targetTypeList":{
            "description":"List of target types",
            "type":"array",
            "items":{
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "cluster",
                    "has"
                ]
            }
        },
        "targetProperties":{
            "description":"Propeties of target",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TargetPropertyFilter"
                }
            ],
            "type":"object"
        },
        "targetNameMatches":{
            "description":"Wildcard search on the target name",
            "type":"string",
            "example":"%orcl%"
        },
        "imageId":{
            "description":"ID of the image",
            "type":"string",
            "example":"E77FC170F57D4B64E0531D0E4B64DA85"
        },
        "imageNameMatches":{
            "description":"Wildcard search on the image name",
            "type":"string",
            "example":"%img%"
        },
        "releaseMatches":{
            "description":"Wildcard search on the release of the target",
            "type":"string",
            "example":"19.14%"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"linux_x64_86"
        },
        "isOnCurrentImage":{
            "description":"Patchlevel of the target (true-target is patched to the current image, false-target is patched to non-current image)",
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: targetProperties

型: object

ターゲットのプロパティ

すべてに一致

ソースの表示

• object TargetPropertyFilter
  ターゲット・プロパティのフィルタ

{
    "description":"Propeties of target",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPropertyFilter"
        }
    ],
    "type":"object"
}

ネストされたスキーマ: targetTypeList

型: array

ターゲット・タイプのリスト

ソースの表示

• 配列:
  指定可能な値: [ "oracle_database", "rac_database", "cluster", "has" ]

{
    "description":"List of target types",
    "type":"array",
    "items":{
        "enum":[
            "oracle_database",
            "rac_database",
            "cluster",
            "has"
        ]
    }
}

ネストされたスキーマ: TargetPropertyFilter

型: object

ターゲット・プロパティのフィルタ

ソースの表示

• contactList: array contactList
  連絡先のリスト
• costCenterList: array costCenterList
  コスト・センターのリスト
• departmentList: array departmentList
  部門のリスト
• downtimeContactList: array downtimeContactList
  停止時の連絡先のリスト
• lifecycleStatusList: array lifecycleStatusList
  ライフサイクルステータスのリスト
• lineOfBusinessList: array lineOfBusinessList
  ライン・オブ・ビジネスのリスト
• locationList: array locationList
  場所のリスト
• siteList: array siteList
  サイトのリスト

{
    "description":"Target property filters",
    "type":"object",
    "properties":{
        "contactList":{
            "description":"List of contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "downtimeContactList":{
            "description":"List of downtime contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costCenterList":{
            "description":"List of cost centers",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "departmentList":{
            "description":"List of departments",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lineOfBusinessList":{
            "description":"List of line of business",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "locationList":{
            "description":"List of locations",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "siteList":{
            "description":"List of sites",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lifecycleStatusList":{
            "description":"List of lifecyclestatus",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: contactList

型: array

連絡先のリスト

ソースの表示

• 配列: string

{
    "description":"List of contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: costCenterList

型: array

コスト・センターのリスト

ソースの表示

• 配列: string

{
    "description":"List of cost centers",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: departmentList

型: array

部門のリスト

ソースの表示

• 配列: string

{
    "description":"List of departments",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: downtimeContactList

型: array

停止時の連絡先のリスト

ソースの表示

• 配列: string

{
    "description":"List of downtime contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: lifecycleStatusList

型: array

ライフサイクルステータスのリスト

ソースの表示

• 配列: string

{
    "description":"List of lifecyclestatus",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: lineOfBusinessList

型: array

ライン・オブ・ビジネスのリスト

ソースの表示

• 配列: string

{
    "description":"List of line of business",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: locationList

型: array

場所のリスト

ソースの表示

• 配列: string

{
    "description":"List of locations",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: siteList

型: array

サイトのリスト

ソースの表示

• 配列: string

{
    "description":"List of sites",
    "type":"array",
    "items":{
        "type":"string"
    }
}

例

例の選択 ターゲット・プロパティでのフィルタ

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK。ターゲット詳細が取得されました。

本文()

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

• object GoldImageSubscribedTargetsPatchComplianceReport
  ターゲットの詳細

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageSubscribedTargetsPatchComplianceReport"
        }
    ]
}

ネストされたスキーマ: GoldImageSubscribedTargetsPatchComplianceReport

型: object

ターゲットの詳細

ソースの表示

• count: number
  現在のフェッチ内のサブスクライブされたターゲットの数

  例: 10
• currentPage: string
  Base 64でエンコードされた現在のページ

  例: b2Zmc2V0OjA
• items: array items
  ターゲットのリスト
• nextPage: string
  Base 64でエンコードされた次のページ

  例: b2Zmc2V0OjA
• previousPage: string
  Base 64でエンコードされた前のページ

  例: b2Zmc2V0OjA
• total: number
  イメージにサブスクライブしているターゲットの合計数

  例: 100

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "currentPage":{
            "description":"Base 64 encoded current page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "previousPage":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "total":{
            "description":"Total count of targets subscribed to images",
            "type":"number",
            "example":"100"
        },
        "count":{
            "description":"count of subscribed targets in the current fetch",
            "type":"number",
            "example":"10"
        },
        "items":{
            "description":"list of targets",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetPatchComplianceDetails"
                    }
                ],
                "properties":{
                    "imageId":{
                        "description":"Id of the image",
                        "type":"string",
                        "example":"E77FC170F57D4B64E0531D0E4B64DA85"
                    },
                    "imageName":{
                        "description":"name of the image",
                        "type":"string",
                        "example":"Tier1 SI 19.14"
                    },
                    "isImageUptodate":{
                        "description":"Flag to indicate if the image is uptodate",
                        "type":"boolean"
                    },
                    "imageVersionName":{
                        "description":"name of the image version",
                        "type":"string",
                        "example":"Version-1"
                    },
                    "imageVersionDescription":{
                        "description":"description of the image version",
                        "type":"string",
                        "example":""
                    },
                    "isCurrentImage":{
                        "description":"Flag indicates if the image is current version",
                        "type":"boolean"
                    },
                    "isNonCurrentVersionUptodate":{
                        "description":"Flag indicates if there is a uptodate image version",
                        "type":"boolean"
                    },
                    "patchCompliance":{
                        "description":"Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or <Version Name> - on which the target is patched",
                        "type":"string",
                        "example":"DRIFTED"
                    },
                    "currentVersionName":{
                        "description":"Name of the 'CURRENT' image version",
                        "type":"string",
                        "example":"19DBRU15"
                    },
                    "additionalPatchCount":{
                        "description":"Count of additional patches in target not present in image and are not not recommended patches",
                        "type":"integer",
                        "example":"2"
                    }
                }
            }
        }
    }
}

ネストされたスキーマ: items

型: array

ターゲットのリスト

ソースの表示

• 配列: object items

{
    "description":"list of targets",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetPatchComplianceDetails"
            }
        ],
        "properties":{
            "imageId":{
                "description":"Id of the image",
                "type":"string",
                "example":"E77FC170F57D4B64E0531D0E4B64DA85"
            },
            "imageName":{
                "description":"name of the image",
                "type":"string",
                "example":"Tier1 SI 19.14"
            },
            "isImageUptodate":{
                "description":"Flag to indicate if the image is uptodate",
                "type":"boolean"
            },
            "imageVersionName":{
                "description":"name of the image version",
                "type":"string",
                "example":"Version-1"
            },
            "imageVersionDescription":{
                "description":"description of the image version",
                "type":"string",
                "example":""
            },
            "isCurrentImage":{
                "description":"Flag indicates if the image is current version",
                "type":"boolean"
            },
            "isNonCurrentVersionUptodate":{
                "description":"Flag indicates if there is a uptodate image version",
                "type":"boolean"
            },
            "patchCompliance":{
                "description":"Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or <Version Name> - on which the target is patched",
                "type":"string",
                "example":"DRIFTED"
            },
            "currentVersionName":{
                "description":"Name of the 'CURRENT' image version",
                "type":"string",
                "example":"19DBRU15"
            },
            "additionalPatchCount":{
                "description":"Count of additional patches in target not present in image and are not not recommended patches",
                "type":"integer",
                "example":"2"
            }
        }
    }
}

ネストされたスキーマ: items

型: object

ソースの表示

• additionalPatchCount: integer
  ターゲット内の追加パッチの数がイメージに存在せず、推奨パッチではありません

  例: 2
• currentVersionName: string
  'CURRENT'イメージ・バージョンの名前

  例: 19DBRU15
• imageId: string
  イメージのID

  例: E77FC170F57D4B64E0531D0E4B64DA85
• imageName: string
  イメージの名前

  例: Tier1 SI 19.14
• imageVersionDescription: string
  イメージ・バージョンの説明

  例:
• imageVersionName: string
  イメージ・バージョンの名前

  例: Version-1
• isCurrentImage: boolean
  フラグはイメージが現在のバージョンかどうかを示します
• isImageUptodate: boolean
  イメージが最新かどうかを示すフラグ
• isNonCurrentVersionUptodate: boolean
  フラグは最新のイメージ・バージョンがあるかどうかを示します
• patchCompliance: string
  ターゲットのパッチ・コンプライアンスは、'DRIFTED' (ターゲットにイメージ内の追加のパッチがあり、それが推奨パッチではない場合)か、ターゲットにパッチが適用されているもののいずれかです

  例: DRIFTED

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPatchComplianceDetails"
        }
    ],
    "properties":{
        "imageId":{
            "description":"Id of the image",
            "type":"string",
            "example":"E77FC170F57D4B64E0531D0E4B64DA85"
        },
        "imageName":{
            "description":"name of the image",
            "type":"string",
            "example":"Tier1 SI 19.14"
        },
        "isImageUptodate":{
            "description":"Flag to indicate if the image is uptodate",
            "type":"boolean"
        },
        "imageVersionName":{
            "description":"name of the image version",
            "type":"string",
            "example":"Version-1"
        },
        "imageVersionDescription":{
            "description":"description of the image version",
            "type":"string",
            "example":""
        },
        "isCurrentImage":{
            "description":"Flag indicates if the image is current version",
            "type":"boolean"
        },
        "isNonCurrentVersionUptodate":{
            "description":"Flag indicates if there is a uptodate image version",
            "type":"boolean"
        },
        "patchCompliance":{
            "description":"Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or <Version Name> - on which the target is patched",
            "type":"string",
            "example":"DRIFTED"
        },
        "currentVersionName":{
            "description":"Name of the 'CURRENT' image version",
            "type":"string",
            "example":"19DBRU15"
        },
        "additionalPatchCount":{
            "description":"Count of additional patches in target not present in image and are not not recommended patches",
            "type":"integer",
            "example":"2"
        }
    }
}

すべてに一致

ソースの表示

• object allOf TargetPatchComplianceDetails
  ターゲットの詳細

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPatchComplianceDetails"
        }
    ],
    "properties":{
        "imageId":{
            "description":"Id of the image",
            "type":"string",
            "example":"E77FC170F57D4B64E0531D0E4B64DA85"
        },
        "imageName":{
            "description":"name of the image",
            "type":"string",
            "example":"Tier1 SI 19.14"
        },
        "isImageUptodate":{
            "description":"Flag to indicate if the image is uptodate",
            "type":"boolean"
        },
        "imageVersionName":{
            "description":"name of the image version",
            "type":"string",
            "example":"Version-1"
        },
        "imageVersionDescription":{
            "description":"description of the image version",
            "type":"string",
            "example":""
        },
        "isCurrentImage":{
            "description":"Flag indicates if the image is current version",
            "type":"boolean"
        },
        "isNonCurrentVersionUptodate":{
            "description":"Flag indicates if there is a uptodate image version",
            "type":"boolean"
        },
        "patchCompliance":{
            "description":"Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or <Version Name> - on which the target is patched",
            "type":"string",
            "example":"DRIFTED"
        },
        "currentVersionName":{
            "description":"Name of the 'CURRENT' image version",
            "type":"string",
            "example":"19DBRU15"
        },
        "additionalPatchCount":{
            "description":"Count of additional patches in target not present in image and are not not recommended patches",
            "type":"integer",
            "example":"2"
        }
    }
}

ネストされたスキーマ: TargetPatchComplianceDetails

型: object

ターゲットの詳細

ソースの表示

• dbMachineName: string
  DBマシン名

  例: myDbMachine.oracle.com

{
    "description":"Target details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetDetails"
        }
    ],
    "properties":{
        "dbMachineName":{
            "description":"DB Machine name",
            "type":"string",
            "example":"myDbMachine.oracle.com"
        }
    }
}

すべてに一致

ソースの表示

• object TargetDetails
  ターゲットの詳細

{
    "description":"Target details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetDetails"
        }
    ],
    "properties":{
        "dbMachineName":{
            "description":"DB Machine name",
            "type":"string",
            "example":"myDbMachine.oracle.com"
        }
    }
}

ネストされたスキーマ: TargetDetails

型: object

ターゲットの詳細

ソースの表示

• clusterName: string
  クラスタの名前

  例: phxem0405c
• dataguardRole: string
  Data Guardロールの列挙
• displayName: string
  ターゲットの表示名

  例: sdb2ra00
• hostname: string
  ホスト名

  例: myHostName.mycompany.com
• isCdb: string
  DBがCDBかどうかを示すフラグ

  例: true
• platform: string
  ターゲットのプラットフォーム

  例: Linux_AMD64
• release: string
  データベース・リリース

  例: 19.14.0.0.0
• targetId: string
  ターゲットのID

  例: 09216A9333889316155C3B7DFF9820C7
• targetName: string
  ターゲットの名前

  例: sdb2ra00
• targetStatus: number
  ターゲットのステータス

  例: 1
• targetType: string
  指定可能な値: [ "rac_database", "oracle_database", "cluster", "has" ]

  ターゲットのタイプ

{
    "description":"details of target",
    "type":"object",
    "properties":{
        "targetId":{
            "description":"Id of the target",
            "type":"string",
            "example":"09216A9333889316155C3B7DFF9820C7"
        },
        "targetName":{
            "description":"name of the target",
            "type":"string",
            "example":"sdb2ra00"
        },
        "targetType":{
            "description":"type of the target",
            "type":"string",
            "enum":[
                "rac_database",
                "oracle_database",
                "cluster",
                "has"
            ]
        },
        "targetStatus":{
            "description":"status of the target",
            "type":"number",
            "example":"1"
        },
        "displayName":{
            "description":"display name of the target",
            "type":"string",
            "example":"sdb2ra00"
        },
        "dataguardRole":{
            "$ref":"#/components/schemas/DataguardRoleEnum"
        },
        "isCdb":{
            "description":"Flag to indicate if the DB is CDB",
            "type":"string",
            "example":"true"
        },
        "hostname":{
            "description":"name of the host",
            "type":"string",
            "example":"myHostName.mycompany.com"
        },
        "clusterName":{
            "description":"name of the cluster",
            "type":"string",
            "example":"phxem0405c"
        },
        "release":{
            "description":"database release",
            "type":"string",
            "example":"19.14.0.0.0"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"Linux_AMD64"
        }
    }
}

例

例の選択 ターゲット・プロパティでのフィルタ

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る