Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisRemovePublication

int ctMemphisRemovePublication( pRCESJson request, ppRCESJson result )

Description:

Remove a Publication from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisRemovePublication/

HTTP Verb: POST

Constraints:

  • "publication/id" must be an existing Publication ID.
  • If the given Publication is in use by any Subscription, an error message with the list of Subscription names will be returned.
  • It will automatically remove all the folder and database rules related to the publication.

Parameters:

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

{

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

and "PublicationFileGroup" records will be also removed

"publication": { // required

"id": 1

}

}

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

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code

TOCIndex