How to Operate Devices

Requirements

A Valid API Key:Provisioned and provided by your platform administrator for North API.

Method

POST

API Endpoint

/north/v80/operation/jobs

Remote & massive operations can be performed by following sending a POST request to the above defined URI, including a correctly formatted JSON document in the POST body to set operation configurable parameters.

Find all options in the North API Operations section

Find the device side in How to remote operate devices through South API

JSON example for DMM device operation

Unresolved directive in opengate-api-quick-reference-howto-operate-dmm-devices-north-api.adoc - include::json/dmmExamples/opengate-north-dmm-operation-example.json[]

Using curl to perform the request:

curl --request POST \
     --data-binary @opengate-north-dmm-operation-example.json \
     --header "X-ApiKey: YOUR_API_KEY_HERE" \
     --verbose \
     -H "Content-type: application/json" \
     http://[your_opengate_address]/north/v80/operation/jobs

In the response we should see a status code of 201.

HTTP/1.1 201 Created
Location: http://[your_opengate_address]/north/v80/operation/jobs/ffc4ae39-8126-4ab7-8e79-cbfa3dc45b1c