Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

POST channels/start

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Start monitoring a channel on the desired MCM device from MCS.

** From MCM version 6.2 and MCS version 1.1 onwards, multiple-channel monitoring is supported.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/channels/command/monitoring/enable

Example Request

POST

  1. https://192.168.0.22/api/5.0/channels/command/monitoring/enable

Body

[
    {
    "channel": "5b1adde6-a9b9-4211-9fe9-225d5f22dad1"
    }
]

Body for more than one channel

[
    {
        "channel": "03dbfe8e-e693-4670-9315-172387bc6db6",
    },
    {
        "channel": "5ba86880-8339-4fa6-8924-8d10af5637bc",
    }
]

Response

{
    "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?

Yes

Response Formats

json

HTTP Methods

POST

Stop monitoring a channel on the desired MCM device from MCS.

** From MCM version 6.2 and MCS version 1.1 onwards, multiple-channels monitoring is supported.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/channels/command/monitoring/disable

Example Request

POST

  1. https://192.168.0.22/api/5.0/channels/command/monitoring/disable

Body

[
    {
    "channel": "5b1adde6-a9b9-4211-9fe9-225d5f22dad1"
  }
]

Body for more than one channel

[
    {
        "channel": "03dbfe8e-e693-4670-9315-172387bc6db6",
    },
    {
        "channel": "5ba86880-8339-4fa6-8924-8d10af5637bc",
    }
]

Response

{
    "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": {}
}
  • No labels