Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisRemoveVolume

int ctMemphisRemoveVolume( pRCESJson request, ppRCESJson result )

Description:

Remove a Volume from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisRemoveVolume/

HTTP Verb: POST

Constraints:

  • If the given Volume is in use by any Publication, an error message with the list of Publication names will be returned.
  • If the given Volume is in use by any Subscription, an error message with the list of Subscription names will be returned.
  • If the given Volume is in use by any DBEngine's Working Volume or Local Volume, an error message with the list of DBEngine names will be returned.

Parameters:

  • request [IN] - Remove Volume request in JSON format. For example:

{

"recursive": 1, // optional, if TRUE, all the related "Files" records

will be also removed (see constraints above)

"volume": { // required

"id": 2

}

}

  • result [OUT] - Result in JSON format. For example:

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code

TOCIndex