Jump to

• Request
• Response
• Examples

Gets all the snapshots available

get

/policy/risk/v1/snapshots

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Snapshots information.

Body ()

Root Schema : AllSnapshotsResponse

Type: object

Show Source

• message: string
  Message related to the status of the request. sent.
• snapshots: array snapshots
  All snapshots that are available.
• status: string
  Status of the request

{
    "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."
        }
    }
}

Nested Schema : snapshots

Type: array

All snapshots that are available.

Show Source

• Array of: object SnapshotData
  Snapshot data

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

Nested Schema : SnapshotData

Type: object

Snapshot data

Show Source

• createTime: string
  Create Time of snapshot
• description: integer
  Description of the snapshot
• name: string
  Name of the snapshot
• snapshotId: string
  Unique identifier of snapshot

{
    "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 Response

Unauthorized

500 Response

Internal server error

503 Response

Service Unavailable

Back to Top

Examples

The following example shows a sample request and response for retrieving all the snapshots.

cURL Command to Retrieve all the Snapshots in JSON Format

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

Sample Response in JSON Format

{
    "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"
        }
    ]
}

cURL Command to Retrieve all the Snapshots in XML Format

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

Sample Response in XML Format

<?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>

Back to Top