7.6 Show Capture Process

The “show” Capture command is used to show a Capture Process configuration. This command will show the latest ”Set” of configured processes, regardless of whether or not the Capture Process has been “stopped and re-applied”, this will not necessarily be the configuration of the currently running Capture Process.

Note – If the configuration has been changed when the Capture Process is running, the “show” command will still display the currently configured process, not the “running” one.

7.6.1 Show Capture Process for MS SQL Server Database

REST API:

• Endpoint: https://repstance_url/configure/process
• Method: POST
• 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:

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.

7.6.2 Show Capture Process for Oracle Database

Note – If the configuration has been changed when the Capture Process is running, the “show” command will still display the currently configured process, not the “running” one.

REST API:

• Endpoint: https://repstance_url/configure/process
• Method: POST
• 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":[
      ["id","captureID"],
      ["dbtype","oracle"],
      ["name","captureName"],
      ["connectiontype","tns|ezconnect"],
      ["tnsname","tns_alias"],
      ["server","host_name"],
      ["port","port_number"],
      ["servicename","service_or_SID"],
      ["dbname","databaseName"],
      ["autostart","{0|1}"],
      ["debuglevel","{0-15}"],
      ["ddlinclude","objectsMask"],
      ["ddlexclude","objectsMask"],
      ["dmlinclude","objectsMask"],
      ["dmlexclude","objectsMask"],
      ["loadinclude","objectsMask"],
      ["loadexclude","objectsMask"],
      ["map=mapID","mappingClause"],
      ["skipapply","skipapplyMask"],
      ["loadconsistent","{0|1}"],
      ["directlogmode","0|1|2"],
      ["asmuser","asm_user"],
      ["asmpassword","asm_password"],
      ["asmservicename","asm_service_or_SID"],
      ["minearchonly","0|1"],
      ["locallogdir","path_to_log_folder"],
      ["poolingdelay","pooling_delay_in_sec"],
      ["preview","0|1"]
    ]
  }

CLI Syntax:

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.