We are trying to invoke a Refresh, Rewind VDB API (SOAP UI)

  • 0
  • 1
  • Question
  • Updated 2 years ago
  • Answered

We are trying to invoke a refresh VDB with the below API Request....We had few errors.
Can someone help to elaborate the parameters in the below request like type, timeflowPoint and semanticLocation.

How to know the Mandatory/Optional parameters (for eg:-currentTimeflow might be a mandatory parameter in below request)

{
       "type": "OracleRefreshParameters",
       "timeflowPoint": {
               "type": "OracleDatabaseContainer",
               "currentTimeflow": "ORACLE_TIMEFLOW-209",
               "semanticLocation": "LATEST_POINT"
       }
}


Also can you guys give idea how to frame a API request.....for eg., we do not have a similar kind of POST request for Rewind/Bookmark etc., We have many such scenarios which we need to invoke using API's.

It would be very helpful if you guys could share a sample API's for rewind/bookmark etc.,


Thanks

Photo of Vasan

Vasan

  • 130 Points 100 badge 2x thumb

Posted 2 years ago

  • 0
  • 1
Photo of Adam Bowen

Adam Bowen, Official Rep

  • 17,420 Points 10k badge 2x thumb
Photo of Adam Bowen

Adam Bowen, Official Rep

  • 17,420 Points 10k badge 2x thumb
Per http://<DelphixEngineIP>/api/#database the refresh action takes one object: RefreshParameters. Clicking that link, we see that there is a subtype specific for Oracle. Click that link. We can see from that page that there are only two required properties: type (which is the name of the object) and timeflowPointParameters. So far we know our object looks like this:
{
       "type": "OracleRefreshParameters",
       "timeflowPointParameters": 
}

So let's click on the timeflowPointParameters link. We can see there are five subclasses. Clicking on each one will give you a brief summary at the top. But for this case, let's choose TimeflowPointSemantic. This allows us to specify time using the semantic LATEST_SNAPSHOT or LATEST_POINT. Since you specified LATEST_POINT above, we'll use that. This Object has three required properties: type (required on every object), location (LATEST_POINT), and container (which is the reference of the object you are copying, in this case a database). Since I don't know the reference of your database, I will just makeup a value: ORACLE_DB_CONTAINER-1

So now we know our JSON body looks like this:
{
   "type": "OracleRefreshParameters",
    "timeflowPointParameters": {
        "type": "TimeflowPointSemantic",
        "container": "ORACLE_DB_CONTAINER-1",
        "location": "LATEST_POINT"
      }
}
Photo of Adam Bowen

Adam Bowen, Official Rep

  • 17,420 Points 10k badge 2x thumb
An example of refreshing a VDB via API can be found here:

https://docs.delphix.com/display/DOCS50/API+Cookbook%3A+Refresh+VDB
Photo of Vasan

Vasan

  • 130 Points 100 badge 2x thumb

Thanks Adam, Can you give an example for Rewind. I searched for some reference but I did not find any in Delphix Help option for the same.