1. OAA Admin API
  2. Tasks
  3. Snapshot

Applies a snapshot

post

/policy/risk/v1/snapshots/{snapshotId}

Snapshot that is available in the system can be applied using this API.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Snapshot apply.
Body ()
Root Schema : schema
Type: object

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 applying a snapshot.

cURL Command to Apply a Snapshot in JSON Format

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

Sample Response in JSON Format

{
    "serverResponseTime": 1637234358515,
    "clientContext": {
        "invocationContext": {
            "createTime": 1637234268558,
            "invocationId": "bdf85700-e991-4a37-b89c-fb410a0a9fe3",
            "traceDataXml": "<OARMInvocationContext><invocationId><![CDATA[bdf85700-e991-4a37-b89c-fb410a0a9fe3]]></invocationId><locale></locale><createTime>2021-11-18 11:17:48.558 +0000</createTime></OARMInvocationContext>"
        },
        "sessionContext": {
            "sessionId": "",
            "clientId": "",
            "clientVersion": "",
            "userPrincipal": "",
            "ipAddress": "",
            "userAgent": "",
            "createTime": 1637234268558,
            "appName": "UASPolicyApi",
            "accessControlledRole": false,
            "orgAccessList": [],
            "roles": [],
            "traceDataXml": "<OARMSessionContextOARMSessionContext><clientId></clientId><userAgentString></userAgentString><userPrincipal></userPrincipal><roles><![CDATA[[]]]></roles><ip></ip><clientVersion></clientVersion><createTime>2021-11-18 11:17:48.558 +0000</createTime></OARMSessionContextOARMSessionContext>"
        },
        "taskContext": {
            "taskId": "bdf85700-e991-4a37-b89c-fb410a0a9fe3",
            "createTime": 1637234268558,
            "traceDataXml": "<OARMTaskContext><taskId><![CDATA[bdf85700-e991-4a37-b89c-fb410a0a9fe3]]></taskId><createTime>2021-11-18 11:17:48.558 +0000</createTime></OARMTaskContext>"
        },
        "traceDataXml": "<clientContext><OARMSessionContextOARMSessionContext><clientId></clientId><userAgentString></userAgentString><userPrincipal></userPrincipal><roles><![CDATA[[]]]></roles><ip></ip><clientVersion></clientVersion><createTime>2021-11-18 11:17:48.558 +0000</createTime></OARMSessionContextOARMSessionContext><OARMTaskContext><taskId><![CDATA[bdf85700-e991-4a37-b89c-fb410a0a9fe3]]></taskId><createTime>2021-11-18 11:17:48.558 +0000</createTime></OARMTaskContext><OARMInvocationContext><invocationId><![CDATA[bdf85700-e991-4a37-b89c-fb410a0a9fe3]]></invocationId><locale></locale><createTime>2021-11-18 11:17:48.558 +0000</createTime></OARMInvocationContext></clientContext>"
    },
    "traceDataXml": "<OARMResponse><serverId><![CDATA[idmpe0053/100.102.50.168]]></serverId><status><![CDATA[SUCCESS]]></status><serverResponseTime>2021-11-18 11:19:18.515 +0000</serverResponseTime><serverVersion><![CDATA[11.1.1.2.0]]></serverVersion><messageList></messageList></OARMResponse>",
    "oarmmessages": [],
    "success": true,
    "warning": false,
    "serverVersion": "11.1.1.2.0",
    "systemError": false,
    "serverId": "idmpe0053/100.102.50.168",
    "object": true,
    "error": false
}

cURL Command to Apply a Snapshot in XML Format

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

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <SnapshotResponse>
     <serverResponseTime>1637234358515</serverResponseTime>
     <clientContext>
         <invocationContext>
             <createTime>1637234268558</createTime>
             <invocationId>bdf85700-e991-4a37-b89c-fb410a0a9fe3</invocationId>
             <traceDataXml>
                 <OARMInvocationContext>
                     <invocationId>
                         <![CDATA[bdf85700-e991-4a37-b89c-fb410a0a9fe3]]>
                     </invocationId>
                     <locale></locale>
                     <createTime>2021-11-18 11:17:48.558 +0000</createTime>
                 </OARMInvocationContext>
             </traceDataXml>
         </invocationContext>
         <sessionContext>
             <sessionId></sessionId>
             <clientId></clientId>
             <clientVersion></clientVersion>
             <userPrincipal></userPrincipal>
             <ipAddress></ipAddress>
             <userAgent></userAgent>
             <createTime>1637234268558</createTime>
             <appName>UASPolicyApi</appName>
             <accessControlledRole>false</accessControlledRole>
             <traceDataXml>
                 <OARMSessionContextOARMSessionContext>
                     <clientId></clientId>
                     <userAgentString></userAgentString>
                     <userPrincipal></userPrincipal>
                     <roles>
                         <![CDATA[[]]]>
                     </roles>
                     <ip></ip>
                     <clientVersion></clientVersion>
                     <createTime>2021-11-18 11:17:48.558 +0000</createTime>
                 </OARMSessionContextOARMSessionContext>
             </traceDataXml>
         </sessionContext>
         <taskContext>
             <taskId>bdf85700-e991-4a37-b89c-fb410a0a9fe3</taskId>
             <createTime>1637234268558</createTime>
             <traceDataXml>
                 <OARMTaskContext>
                     <taskId>
                         <![CDATA[bdf85700-e991-4a37-b89c-fb410a0a9fe3]]>
                     </taskId>
                     <createTime>2021-11-18 11:17:48.558 +0000</createTime>
                 </OARMTaskContext>
             </traceDataXml>
         </taskContext>
         <traceDataXml>
             <clientContext>
                 <OARMSessionContextOARMSessionContext>
                     <clientId></clientId>
                     <userAgentString></userAgentString>
                     <userPrincipal></userPrincipal>
                     <roles>
                         <![CDATA[[]]]>
                     </roles>
                     <ip></ip>
                     <clientVersion></clientVersion>
                     <createTime>2021-11-18 11:17:48.558 +0000</createTime>
                 </OARMSessionContextOARMSessionContext>
                 <OARMTaskContext>
                     <taskId>
                         <![CDATA[bdf85700-e991-4a37-b89c-fb410a0a9fe3]]>
                     </taskId>
                     <createTime>2021-11-18 11:17:48.558 +0000</createTime>
                 </OARMTaskContext>
                 <OARMInvocationContext>
                     <invocationId>
                         <![CDATA[bdf85700-e991-4a37-b89c-fb410a0a9fe3]]>
                     </invocationId>
                     <locale></locale>
                     <createTime>2021-11-18 11:17:48.558 +0000</createTime>
                 </OARMInvocationContext>
             </clientContext>
         </traceDataXml>
     </clientContext>
     <traceDataXml>
         <OARMResponse>
             <serverId>
                 <![CDATA[idmpe0053/100.102.50.168]]>
             </serverId>
             <status>
                 <![CDATA[SUCCESS]]>
             </status>
             <serverResponseTime>2021-11-18 11:19:18.515 +0000</serverResponseTime>
             <serverVersion>
                 <![CDATA[11.1.1.2.0]]>
             </serverVersion>
             <messageList></messageList>
         </OARMResponse>
     </traceDataXml>
     <success>true</success>
     <warning>false</warning>
     <serverVersion>11.1.1.2.0</serverVersion>
     <systemError>false</systemError>
     <serverId>idmpe0053/100.102.50.168</serverId>
     <object>true</object>
     <error>false</error>
 </SnapshotResponse>
Back to Top