SubC Inspector API Commands

The following API commands are sent to the DVR+O SCI / RCS applications from SubC API Inspector application.

Last updated: 2025-11-17 16:34:09
Path To	Name	Description/Function
/api/inspector	/apply	Controller for applying settings to recording VMs.
/api/inspector	/startall	Start recording on each channel.
/api/inspector	/stopall	Stop recording on each channel.

/apply

Function	Controller for applying settings to recording VMs.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/apply
Response	A Task representing the asynchronous operation.
Response Type	string
Response Example	CODE `No example data available.`

/startall

Function	Start recording on each channel.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/startall
Response	A Task representing the asynchronous operation.
Response Type	string
Response Example	CODE `No example data available.`

/stopall

Function	Stop recording on each channel.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/stopall
Response	A Task representing the asynchronous operation.
Response Type	string
Response Example	CODE `No example data available.`

Last updated: 2025-11-17 16:34:09
Path To	Name	Description/Function
/api/inspector	/addevent/{eventName}	Responsible for controlling the inspector capabilities over rest.
/api/inspector	/createevent/{eventName}	Responsible for controlling the inspector capabilities over rest.
/api/inspector	/addevent/{eventName}/{fieldNames}	Adds an event with specific field names.
/api/inspector	/createevent/{eventName}/{fieldNames}	Adds an event with specific field names.
/api/inspector	/configureinspection	Set the inspection options.
/api/inspector	/countinputs	Returns the number of initialized channels.
/api/inspector	/createaddresses	Tells the DVR to prepare an SRT streaming address for each initialized channel.
/api/inspector	/createdirectory	Creates a directory.
/api/inspector	/getdirectories	Get all the directories in the given directory.
/api/inspector	/getdrives	Get all the drives on the DVR PC.
/api/inspector	/getdatafields	Gets the list of defined data fields.
/api/inspector	/getdataforeventcsv/{eventName}	Get the data for the given event.
/api/inspector	/getdirectoriesrecursive	Recursively get all the directories inside the given directory.
/api/inspector	/inspection	Get the inspection directory.
/api/inspector	/getdirectorycontentscount	Get the total number of files and directories of the specified directory.
/api/inspector	/getdatainfo/{eventName}	Get the timestamp and data for the given event.
/api/inspector	/beginevent/{eventName}	Get the timestamp and data for the given event.
/api/inspector	/getevents	Get all the events.
/api/inspector	/getinspectionconfiguration	Get the inspection options.
/api/inspector	/previousinspections	Get a list of previous inspections.
/api/inspector	/getrecordingstate	Gets a value indicating whether the DVR is recording.
/api/inspector	/getrecordingstates	Gets a list of recording states for each channel.
/api/inspector	/getstartedchannelnames	Get the names of the channels that are started.
/api/inspector	/timestamp	Get the timestamp of the DVR.
/api/inspector	/isaudioconnected	Gets a value indicating whether the audio is connected.
/api/inspector	/isaudiorecording	Gets a value indicating whether the audio is recording.
/api/inspector	/iscliprecording	Gets a value indicating whether a clip is recording.
/api/inspector	/isrecording	Gets a value indicating whether any channel is recording.
/api/inspector	/logevent/{eventName}	Take an event.
/api/inspector	/takeevent/{eventName}	Take an event.
/api/inspector	/openaudio	Open an audio stream.
/api/inspector	/reevaluatetags/{value}	Set reevaluate tags on split.
/api/inspector	/removeinspection	removes an inspection from the list of previous inspections.
/api/inspector	/inspectiondirectory	Set the inspection directory on all channels.
/api/inspector	/recordingdirectory	Set the inspection directory on all channels.
/api/inspector	/splittime/{splitTime}	Sets the split time in minutes.
/api/inspector	/startclip	Start recording a clip.
/api/inspector	/startinspection	Start an inspection.
/api/inspector	/startrecording	Start recording.
/api/inspector	/startstreaming	Start streaming all the initialized inputs.
/api/inspector	/stopclip	Stop recording a clip.
/api/inspector	/stoprecording	Stop recording.
/api/inspector	/stopstreaming	Stop streaming all the initialized inputs.
/api/inspector	/takeframegrab	Take a framegrab.

/addevent/{eventName}

Function	Responsible for controlling the inspector capabilities over rest.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/addevent/eventName
Response	None
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/createevent/{eventName}

Function	Responsible for controlling the inspector capabilities over rest.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/createevent/eventName
Response	None
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/addevent/{eventName}/{fieldNames}

Function	Adds an event with specific field names.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/addevent/eventName/fieldNames
Response	None
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/createevent/{eventName}/{fieldNames}

Function	Adds an event with specific field names.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/createevent/eventName/fieldNames
Response	None
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/configureinspection

Function	Set the inspection options.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/configureinspection
Response	A Task representing the asynchronous operation.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/countinputs

Function	Returns the number of initialized channels.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/countinputs
Response	Addresses of all the inputs that are streaming.
Response Type	number
Response Example	CODE `1`

/createaddresses

Function	Tells the DVR to prepare an SRT streaming address for each initialized channel.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/createaddresses
Response	Addresses of all the inputs that are streaming.
Response Type	object
Response Example	CODE `{ "0": "srt://192.168.2.100:47338?mode=listener" }`

/createdirectory

Function	Creates a directory.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/createdirectory
Response	A Task representing the asynchronous operation.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/getdirectories

Function	Get all the directories in the given directory.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/getdirectories
Response	All the directories in a given directory.
Response Type	string
Response Example	CODE `No example data available.`

/getdrives

Function	Get all the drives on the DVR PC.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getdrives
Response	All the directories in the inspection folder.
Response Type	object
Response Example	CODE `{ "": [ "C:\\", "D:\\" ] }`

/getdatafields

Function	Gets the list of defined data fields.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getdatafields
Response	An IEnumerable.
Response Type	object
Response Example	CODE `Empty array object detected from the REST call, <a href="http://192.168.2.186:13000/api/inspector/getdatafields" target="_blank">http://192.168.2.186:13000/api/inspector/getdatafields</a>`

/getdataforeventcsv/{eventName}

Function	Get the data for the given event.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getdataforeventcsv/eventName
Response	Data for the given event.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/getdirectoriesrecursive

Function	Recursively get all the directories inside the given directory.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/getdirectoriesrecursive
Response	All the directories in a given directory.
Response Type	object
Response Example	CODE { "C:\\path_to\\inspection_dir\\DATA_20251114162917660": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251114162917949": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251114163151061": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251114163151320": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116181612248": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116181612442": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116182533748": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116182533974": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116182552680": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116182552903": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116183752847": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116183753060": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116230234132": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116230234337": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116230921862": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116230922096": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116230959861": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231000104": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231501526": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231501737": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231528398": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231528600": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231556046": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231556245": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231738648": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231738852": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231900502": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116231900747": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116232017853": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116232018049": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116232426236": "C:\\path_to\\inspection_dir", "C:\\path_to\\inspection_dir\\DATA_20251116232426435": "C:\\path_to\\inspection_dir" }

/inspection

Function	Get the inspection directory.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/inspection
Response	The project directory.
Response Type	object
Response Example	CODE `{ "Directory": "C:\\path_to\\inspection_dir" }`

/getdirectorycontentscount

Function	Get the total number of files and directories of the specified directory.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/getdirectorycontentscount
Response	A dictionary containing the path of the directory and the number of files or directories inside it.

/getdatainfo/{eventName}

Function	Get the timestamp and data for the given event.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getdatainfo/eventName
Response	Timestamp and data for the given event.
Response Type	object
Response Example	CODE `{ "Timestamp": "2025-11-16 232543.378", "Data": "" }`

/beginevent/{eventName}

Function	Get the timestamp and data for the given event.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/beginevent/eventName
Response	Timestamp and data for the given event.
Response Type	object
Response Example	CODE `{ "Timestamp": "2025-11-16 232543.424", "Data": "" }`

/getevents

Function	Get all the events.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getevents
Response	All the events.
Response Type	object
Response Example	CODE [ "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue", "testValue" ]

/getinspectionconfiguration

Function	Get the inspection options.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getinspectionconfiguration
Response	Inspection options.
Response Type	object
Response Example	CODE `{}`

/previousinspections

Function	Get a list of previous inspections.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/previousinspections
Response	The project directory.
Response Type	object
Response Example	CODE `[ "C:\\path_to\\inspection_dir" ]`

/getrecordingstate

Function	Gets a value indicating whether the DVR is recording.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getrecordingstate
Response	True if the DVR is recording.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/getrecordingstates

Function	Gets a list of recording states for each channel.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getrecordingstates
Response	A list of recording states for each channel.
Response Type	object
Response Example	CODE `{ "0": 0 }`

/getstartedchannelnames

Function	Get the names of the channels that are started.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/getstartedchannelnames
Response	All the names of started channels.
Response Type	object
Response Example	CODE `{ "1": "Channel1" }`

/timestamp

Function	Get the timestamp of the DVR.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/timestamp
Response	The current timestamp.
Response Type	string
Response Example	CODE `2025-11-16 232543.740`

/isaudioconnected

Function	Gets a value indicating whether the audio is connected.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/isaudioconnected
Response	True if audio is connected.
Response Type	boolean
Response Example	CODE `false`

/isaudiorecording

Function	Gets a value indicating whether the audio is recording.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/isaudiorecording
Response	True if audio is recording.
Response Type	boolean
Response Example	CODE `false`

/iscliprecording

Function	Gets a value indicating whether a clip is recording.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/iscliprecording
Response	True if the clip is recording.
Response Type	string
Response Example	CODE `No example data available.`

/isrecording

Function	Gets a value indicating whether any channel is recording.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/isrecording
Response	True if DRV+O is recording.
Response Type	boolean
Response Example	CODE `false`

/logevent/{eventName}

Function	Take an event.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/logevent/eventName
Response	A Task representing the asynchronous operation.
Response Type	string
Response Example	CODE `testValue`

/takeevent/{eventName}

Function	Take an event.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/takeevent/eventName
Response	A Task representing the asynchronous operation.
Response Type	string
Response Example	CODE `testValue`

/openaudio

Function	Open an audio stream.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/openaudio
Response	A Task representing the asynchronous operation.
Response Type	string
Response Example	CODE `No example data available.`

/reevaluatetags/{value}

Function	Set reevaluate tags on split.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/reevaluatetags/value
Response	None
Response Type	string
Response Example	CODE `No example data available.`

/removeinspection

Function	removes an inspection from the list of previous inspections.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/removeinspection
Response	Addresses of all the inputs that are streaming.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/inspectiondirectory

Function	Set the inspection directory on all channels.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/inspectiondirectory
Response	A Task representing the asynchronous operation.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/recordingdirectory

Function	Set the inspection directory on all channels.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/recordingdirectory
Response	A Task representing the asynchronous operation.

/splittime/{splitTime}

Function	Sets the split time in minutes.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/splittime/splitTime
Response	None
Response Type	string
Response Example	CODE `No example data available.`

/startclip

Function	Start recording a clip.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/startclip
Response	None
Response Type	string
Response Example	CODE `No example data available.`

/startinspection

Function	Start an inspection.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/startinspection
Response	A Task representing the asynchronous operation.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/startrecording

Function	Start recording.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/startrecording
Response	A Task representing the asynchronous operation.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/startstreaming

Function	Start streaming all the initialized inputs.
Method	POST
Example	http://192.168.2.186:13000/api/inspector/startstreaming
Response	Addresses of all the inputs that are streaming.

/stopclip

Function	Stop recording a clip.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/stopclip
Response	None
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/stoprecording

Function	Stop recording.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/stoprecording
Response	A Task representing the asynchronous operation.
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/stopstreaming

Function	Stop streaming all the initialized inputs.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/stopstreaming
Response	None
Response Type	none
Response Example	CODE `No reply detected from the REST call.`

/takeframegrab

Function	Take a framegrab.
Method	GET
Example	http://192.168.2.186:13000/api/inspector/takeframegrab
Response	True when taking a framegrab.
Response Type	boolean
Response Example	CODE `true`