Skip to content

Cognitive Systems App Core API

The Core APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. It offers interfaces for accessing topologies, events, motion data, and more.

Download OpenAPI description
core.json
core.yaml
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/core/

Network Settings

Operations

Motion History

Operations

Live Motion

Operations

Events

Operations

Insights v2

Operations

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Find

Operations

Application Settings

Operations

Config

Operations

Node

Operations

Management

Operations

Create a batch

Request

A batch is a group of related management commands that can be monitored using a single WebSocket.

Security
ApiKey
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/core/manage/batch \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
batch_idinteger

Newly created batch_id

Response
application/json
{
  "batch_id": 0
}

Queue management command

Request

If executeNow is true, default state will be either 002 (waiting for online) or 011 (sent command one time).

If trigger_id is null, default state will be 000 (pending)

If trigger_id is not null, default state will be 001 (waiting for trigger)

Security
ApiKey
Query
createBatchboolean

If true, a new batch will be created for this action.

Default false
Bodyapplication/jsonrequired
network_idinteger

Target node's network_id

created_atnumber

Timestamp the action was created at

updated_atnumber

Timestamp the action was last updated

trigger_idinteger or nullrequired

If not null, the execution of this action will be delayed until this trigger action has completed successfully (status=2xx).

If the trigger action fails (status=4xx), this action will fail with the same status.

payloadobjectrequired
payload.​property name*stringadditional property
stateinteger

000 - Pending start

001 - Waiting for action with trigger_id

002 - Waiting for device to come online

01x - Command was attempted "x" times

100 - Device acknowledged, action started

1xx - command_id specific progress codes

200 - Completed (Success)

4xx - Completed (Failed)

node_idintegerrequired

Target node ID

batch_idinteger or null

Optional batch group identifier for this action. If null then websocket-based monitoring of this action will not be possible.

responseobject
idinteger

Auto-generated action ID

command_idintegerrequired

0 - system_exec

1 - factory_reset

2 - firmware_update

3 - reboot

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/manage/create?createBatch=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 0,
    "created_at": 0,
    "updated_at": 0,
    "trigger_id": 0,
    "payload": {
      "property1": "string",
      "property2": "string"
    },
    "state": 0,
    "node_id": 0,
    "batch_id": 0,
    "response": {
      "message": [
        "string"
      ]
    },
    "id": 0,
    "command_id": 0
  }'

Responses

OK.

Bodyapplication/json
network_idinteger

Target node's network_id

created_atnumber

Timestamp the action was created at

updated_atnumber

Timestamp the action was last updated

trigger_idinteger or nullrequired

If not null, the execution of this action will be delayed until this trigger action has completed successfully (status=2xx).

If the trigger action fails (status=4xx), this action will fail with the same status.

payloadobjectrequired
payload.​property name*stringadditional property
stateinteger

000 - Pending start

001 - Waiting for action with trigger_id

002 - Waiting for device to come online

01x - Command was attempted "x" times

100 - Device acknowledged, action started

1xx - command_id specific progress codes

200 - Completed (Success)

4xx - Completed (Failed)

node_idintegerrequired

Target node ID

batch_idinteger or null

Optional batch group identifier for this action. If null then websocket-based monitoring of this action will not be possible.

responseobject
idinteger

Auto-generated action ID

command_idintegerrequired

0 - system_exec

1 - factory_reset

2 - firmware_update

3 - reboot

Response
application/json
{
  "network_id": 0,
  "created_at": 0,
  "updated_at": 0,
  "trigger_id": 0,
  "payload": {
    "property1": "string",
    "property2": "string"
  },
  "state": 0,
  "node_id": 0,
  "batch_id": 0,
  "response": {
    "message": [ … ]
  },
  "id": 0,
  "command_id": 0
}

Monitor a batch of actions (WebSocket)

Request

This websocket will produce a stream of updates as actions with the provided batch_id execute.

Security
ApiKey
Query
idnumberrequired

batch_id to be monitored on this WebSocket

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/manage/monitor?id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

WebSocket of ManageAction updates