FairCom Replication JSON RPC API

ctMemphisRemoveAgent

int ctMemphisRemoveAgent( pRCESJson request, ppRCESJson result )

Description:

Remove an Agent from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisRemoveAgent/

HTTP Verb: POST

Constraints:

• If the given Agent has been used by any action, an error message will be returned that the Agent could not be removed. If you want to remove this action dependency, use the recursive parameter.

Parameters:

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

{

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

"Action" records will be cleaned up

"agent": { // required

"id": 2

}

}

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

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code