Home / Repstance User Guide / 7. COMMANDS TO BE USED / 7.6 Show Capture Process / 7.6.1 Show Capture Process for MS SQL Server Database

7.6.1 Show Capture Process for MS SQL Server Database

REST API:

  • Endpointhttps://repstance_url/configure/process
  • MethodPOST
  • Header:
    • Content-Type: application/json
    • X-Token: token
  • Body:
    {
      "command": "show",
      "parameters": [
        ["process","capture"],
        ["id","captureID"]
      ]
    }

Server response:

  • HTTP Status – status of the command, possible codes are:
    • 200 – if no error occurs
    • 422 – if error occurs
  • Body:
    {
      "Status":"{Failed|Completed}",
      "Message":"The command execution details",
      "parameters":[
        ["dbtype","mssql"],
        ["name","captureName"],
        ["server","databaseHost"],
        ["port","databasePort"],
        ["user","username"],
        ["password","password"],
        ["dbname","databaseName"],
        ["autostart","{0|1}"],
        ["debuglevel","{0-15}"],
        ["ddlinclude","objectsMask"],
        ["ddlexclude","objectsMask"],
        ["loadinclude","objectsMask"],
        ["loadexclude","objectsMask"],
        ["dmlinclude","objectsMask"],
        ["dmlexclude","objectsMask"],
        ["map=mapID","mappingClause"],
        ["skipapply","skipapplyMask"]
      ]
    }

CLI Syntax:

repcli show process=capture id=captureID 

The input parameters are:

  • process– The only possible value is capture
  • id–The Capture Process identifier

Note – Only if the command completes successfully will the response contain all the “parameter” values and at the same time this information will be displayed in Plain Text in the “Message” display.