Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
POST channels/start
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Start monitoring a channel on the desired MCM device from MCS.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/command/monitoring/enable
Example Request
POST
Body
| Code Block | ||
|---|---|---|
| ||
[
{
"device": "f0fd7753-5843-43a3-acf7-eaf8065f8010",
"channel": "5b1adde6-a9b9-4211-9fe9-225d5f22dad1"
}
] |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "e05dc05a-9af6-4775-b66a-7ab69269feaa",
"created": 1631542309895,
"type": "Start Monitoring",
"state": "Running",
"progress": 0,
"attributes": {
"channel": "5b1adde6-a9b9-4211-9fe9-225d5f22dad1",
"device": "f0fd7753-5843-43a3-acf7-eaf8065f8010"
},
"result": null
}
],
"metadata": {}
} |
POST channels/stop
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Stop monitoring a channel on the desired MCM device from MCS.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/command/monitoring/disable
Example Request
POST
Body
| Code Block | ||
|---|---|---|
| ||
[
{
"channel": "5b1adde6-a9b9-4211-9fe9-225d5f22dad1"
}
] |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "7c993de5-7ae9-44fa-ac32-eebab87842ef",
"created": 1631542415849,
"type": "Stop Monitoring",
"state": "Running",
"progress": 0,
"attributes": {
"channel": "5b1adde6-a9b9-4211-9fe9-225d5f22dad1"
},
"result": null
}
],
"metadata": {}
} |