ジャンプ先

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

使用可能なすべてのスナップショットを取得する

get

/policy/risk/v1/snapshots

リクエスト

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

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/xml
• application/json

200レスポンス

スナップショット情報。

本文()

ルート・スキーマ: AllSnapshotsResponse

型: object

ソースの表示

• message: string
  送信されたリクエストのステータスに関連するメッセージ。
• snapshots: array snapshots
  使用可能なすべてのスナップショット。
• status: string
  リクエストのステータス

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request. sent."
        },
        "snapshots":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SnapshotData"
            },
            "description":"All snapshots that are available."
        }
    }
}

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

型: array

使用可能なすべてのスナップショット。

ソースの表示

• 配列: object SnapshotData
  スナップショット・データ

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SnapshotData"
    },
    "description":"All snapshots that are available."
}

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

型: object

スナップショット・データ

ソースの表示

• createTime: string
  スナップショットの作成時間
• description: integer
  スナップショットの説明
• name: string
  スナップショットの名前
• snapshotId: string
  スナップショットの一意の識別子

{
    "type":"object",
    "description":"Snapshot data",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the snapshot"
        },
        "description":{
            "type":"integer",
            "description":"Description of the snapshot"
        },
        "snapshotId":{
            "type":"string",
            "description":"Unique identifier of snapshot"
        },
        "createTime":{
            "type":"string",
            "description":"Create Time of snapshot"
        }
    }
}

401レスポンス

未認可

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、すべてのスナップショットを取得するサンプルのリクエストとレスポンスを示します。

JSON形式ですべてのスナップショットを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

JSON形式のサンプル・レスポンス

{
    "status": "200",
    "message": "Snapshots information.",
    "snapshots": [
        {
            "name": "A sample SS",
            "description": "This is a test sample SS",
            "snapshotId": "20101",
            "createTime": "11-17-2021 11:10:38"
        },
        {
            "name": "OAAM Base Snapshot",
            "description": "Snapshot that contains out of box content that is required to run basic risk analysis policies, all conditions, rules, groups, English(US) questions, validations, question categories, basic entities, patterns etc.",
            "snapshotId": "1",
            "createTime": "07-02-2021 22:28:22"
        }
    ]
}

XML形式ですべてのスナップショットを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <AllSnapshotsResponse>
     <status>200</status>
     <message>Snapshots information.</message>
     <snapshots>
         <name>A sample SS</name>
         <description>This is a test sample SS</description>
         <snapshotId>20101</snapshotId>
         <createTime>11-17-2021 11:10:38</createTime>
     </snapshots>
     <snapshots>
         <name>OAAM Base Snapshot</name>
         <description>Snapshot that contains out of box content that is required to run basic risk analysis policies, all conditions, rules, groups, English(US) questions, validations, question categories, basic entities, patterns etc.</description>
         <snapshotId>1</snapshotId>
         <createTime>07-02-2021 22:28:22</createTime>
     </snapshots>
 </AllSnapshotsResponse>

先頭に戻る