NAV Navbar
Shell HTTP JavaScript Node.JS Ruby Python Java Go

WolkAbout IoT Platform API Device Management v20.GA-DEV-28

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

WolkAbout IoT Platform API is a RESTful API used for manipulating and managing WolkAbout platform resources. In order to use the API, client has to be ableto send HTTP requests and work with JSON data.

Base URLs:

Email: Wolkabout Web: Wolkabout

Authentication

advanced-device-api

advanced-device-api

bindToPointUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "mappingId": null,
  "pointId": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/devices/{deviceId}/bindings

bindToPoint

Permissions:
hasAuthority('DEVICE_WRITE')

Description:
Links the device to a point using the specified mapping.

Body parameter

{
  "mappingId": null,
  "pointId": null
}

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
body body DevicePointBindDto true dto

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Void
401 Unauthorized Unauthorized None
404 Not Found Not Found None

device-actuator-api

device-actuator-api

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "description": null,
  "deviceKey": null,
  "contextId": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "deviceName": null,
  "reference": null,
  "connected": true,
  "originType": null,
  "path": null,
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "originId": null,
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "device": {
    "configs": {
      "dataType": "STRING",
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "deviceName": null,
      "labels": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "size": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null,
      "status": "READY"
    },
    "activationTimestamp": null,
    "serviceStatuses": {
      "extras": null,
      "id": null,
      "error": null,
      "type": null,
      "timestamp": null,
      "status": null
    },
    "lastReportTimestamp": null,
    "deviceAlarms": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "message": null,
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "id": null,
      "device": null,
      "value": null,
      "status": "NORMAL"
    },
    "creatorName": null,
    "type": null,
    "path": null,
    "password": null,
    "protocol": null,
    "originId": null,
    "id": null,
    "attributesWithoutReadOnly": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "deviceSensors": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "connectionState": "CONNECTED",
    "manifest": {
      "deviceType": null,
      "generallyAvailable": true,
      "configs": {
        "reference": null,
        "size": null,
        "defaultValue": null,
        "dataType": "STRING",
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "nullValue": null,
        "labels": null
      },
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "reference": null,
        "name": null,
        "description": null,
        "id": null,
        "message": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "permission": "VIEW",
      "published": true,
      "originType": null,
      "path": null,
      "protocol": null,
      "actuators": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "defaultValue": null,
        "options": null,
        "name": null,
        "readOnly": true,
        "id": null,
        "type": "STRING",
        "validationRegex": null,
        "required": true
      },
      "id": null
    },
    "deviceKey": null,
    "contextId": null,
    "permission": "VIEW",
    "originType": null,
    "roleName": null,
    "name": null,
    "deviceActuators": null,
    "attributes": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "parameters": {
      "id": null,
      "type": null,
      "value": null,
      "key": null
    }
  },
  "value": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/devices/{deviceId}/actuators

create

Permissions:
hasAuthority('DEVICE_WRITE')

Body parameter

{
  "description": null,
  "deviceKey": null,
  "contextId": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "deviceName": null,
  "reference": null,
  "connected": true,
  "originType": null,
  "path": null,
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "originId": null,
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "device": {
    "configs": {
      "dataType": "STRING",
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "deviceName": null,
      "labels": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "size": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null,
      "status": "READY"
    },
    "activationTimestamp": null,
    "serviceStatuses": {
      "extras": null,
      "id": null,
      "error": null,
      "type": null,
      "timestamp": null,
      "status": null
    },
    "lastReportTimestamp": null,
    "deviceAlarms": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "message": null,
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "id": null,
      "device": null,
      "value": null,
      "status": "NORMAL"
    },
    "creatorName": null,
    "type": null,
    "path": null,
    "password": null,
    "protocol": null,
    "originId": null,
    "id": null,
    "attributesWithoutReadOnly": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "deviceSensors": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "connectionState": "CONNECTED",
    "manifest": {
      "deviceType": null,
      "generallyAvailable": true,
      "configs": {
        "reference": null,
        "size": null,
        "defaultValue": null,
        "dataType": "STRING",
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "nullValue": null,
        "labels": null
      },
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "reference": null,
        "name": null,
        "description": null,
        "id": null,
        "message": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "permission": "VIEW",
      "published": true,
      "originType": null,
      "path": null,
      "protocol": null,
      "actuators": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "defaultValue": null,
        "options": null,
        "name": null,
        "readOnly": true,
        "id": null,
        "type": "STRING",
        "validationRegex": null,
        "required": true
      },
      "id": null
    },
    "deviceKey": null,
    "contextId": null,
    "permission": "VIEW",
    "originType": null,
    "roleName": null,
    "name": null,
    "deviceActuators": null,
    "attributes": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "parameters": {
      "id": null,
      "type": null,
      "value": null,
      "key": null
    }
  },
  "value": null
}

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
body body DeviceActuator true dto

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Long
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  method: 'get (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/devices/{deviceId}/actuators

page

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
query query undefined false query
readingTypeId query undefined false readingTypeId
deviceId path undefined true deviceId

Responses

Status Meaning Description Schema
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listCompatibleWithActuatorUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  method: 'get (produces: application/vnd.compatibleWithActuator+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
{
  method: 'GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.compatibleWithActuator+json) 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  params: {
  'actuatorUnitId' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.compatibleWithActuator+json)('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators', params={
  'actuatorUnitId': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR+JSON) /api/devices/{deviceId}/actuators

listCompatibleWithActuator

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Description:
Returns a list of sensors compatible with a given feed unit.

Parameters

Parameter In Type Required Description
query query undefined false query
readingTypeId query undefined false readingTypeId
actuatorUnitId query undefined true actuatorUnitId
deviceId path undefined true deviceId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/{deviceId}/actuators

list

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
query query String false query
readingTypeId query Long false readingTypeId
deviceId path long true deviceId

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
404 Not Found Not Found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ResponseEntity] false none none
» headers HttpHeaders false none none
»» date long false none none
»» allow Set false none none
»» expires long false none none
»» accessControlMaxAge long false none none
»» vary String false none none
»» origin String false none none
»» ifUnmodifiedSince long false none none
»» range HttpRange false none none
»» ifModifiedSince long false none none
»» accessControlRequestMethod string false none none
»» accessControlAllowMethods [string] false none none
»» ifMatch String false none none
»» empty boolean false none none
»» accessControlAllowHeaders String false none none
»» accessControlAllowOrigin String false none none
»» contentDisposition ContentDisposition false none none
»»» charset Charset false none none
»»» modificationDate ZonedDateTime false none none
»»» filename String false none none
»»» size Long false none none
»»» readDate ZonedDateTime false none none
»»» name String false none none
»»» creationDate ZonedDateTime false none none
»»» type String false none none
»» host InetSocketAddress false none none
»» connection String false none none
»» eTag String false none none
»» contentType MediaType false none none
»»» concrete boolean false none none
»»» charset Charset false none none
»»» subtype String false none none
»»» qualityValue double false none none
»»» type String false none none
»»» wildcardSubtype boolean false none none
»»» parameters Map false none none
»»» wildcardType boolean false none none
»» accessControlRequestHeaders String false none none
»» acceptLanguageAsLocales Locale false none none
»» upgrade String false none none
»» acceptCharset Charset false none none
»» cacheControl String false none none
»» ifNoneMatch String false none none
»» pragma String false none none
»» accept MediaType false none none
»» accessControlExposeHeaders String false none none
»» acceptLanguage LanguageRange false none none
»» accessControlAllowCredentials boolean false none none
»» contentLanguage Locale false none none
»» contentLength long false none none
»» location URI false none none
»» lastModified long false none none
» statusCodeValue int false none none
» body Object false none none
» statusCode string false none none

Enumerated Values

Property Value
accessControlRequestMethod GET
accessControlRequestMethod HEAD
accessControlRequestMethod POST
accessControlRequestMethod PUT
accessControlRequestMethod PATCH
accessControlRequestMethod DELETE
accessControlRequestMethod OPTIONS
accessControlRequestMethod TRACE
statusCode CONTINUE
statusCode SWITCHING_PROTOCOLS
statusCode PROCESSING
statusCode CHECKPOINT
statusCode OK
statusCode CREATED
statusCode ACCEPTED
statusCode NON_AUTHORITATIVE_INFORMATION
statusCode NO_CONTENT
statusCode RESET_CONTENT
statusCode PARTIAL_CONTENT
statusCode MULTI_STATUS
statusCode ALREADY_REPORTED
statusCode IM_USED
statusCode MULTIPLE_CHOICES
statusCode MOVED_PERMANENTLY
statusCode FOUND
statusCode MOVED_TEMPORARILY
statusCode SEE_OTHER
statusCode NOT_MODIFIED
statusCode USE_PROXY
statusCode TEMPORARY_REDIRECT
statusCode PERMANENT_REDIRECT
statusCode BAD_REQUEST
statusCode UNAUTHORIZED
statusCode PAYMENT_REQUIRED
statusCode FORBIDDEN
statusCode NOT_FOUND
statusCode METHOD_NOT_ALLOWED
statusCode NOT_ACCEPTABLE
statusCode PROXY_AUTHENTICATION_REQUIRED
statusCode REQUEST_TIMEOUT
statusCode CONFLICT
statusCode GONE
statusCode LENGTH_REQUIRED
statusCode PRECONDITION_FAILED
statusCode PAYLOAD_TOO_LARGE
statusCode REQUEST_ENTITY_TOO_LARGE
statusCode URI_TOO_LONG
statusCode REQUEST_URI_TOO_LONG
statusCode UNSUPPORTED_MEDIA_TYPE
statusCode REQUESTED_RANGE_NOT_SATISFIABLE
statusCode EXPECTATION_FAILED
statusCode I_AM_A_TEAPOT
statusCode INSUFFICIENT_SPACE_ON_RESOURCE
statusCode METHOD_FAILURE
statusCode DESTINATION_LOCKED
statusCode UNPROCESSABLE_ENTITY
statusCode LOCKED
statusCode FAILED_DEPENDENCY
statusCode UPGRADE_REQUIRED
statusCode PRECONDITION_REQUIRED
statusCode TOO_MANY_REQUESTS
statusCode REQUEST_HEADER_FIELDS_TOO_LARGE
statusCode UNAVAILABLE_FOR_LEGAL_REASONS
statusCode INTERNAL_SERVER_ERROR
statusCode NOT_IMPLEMENTED
statusCode BAD_GATEWAY
statusCode SERVICE_UNAVAILABLE
statusCode GATEWAY_TIMEOUT
statusCode HTTP_VERSION_NOT_SUPPORTED
statusCode VARIANT_ALSO_NEGOTIATES
statusCode INSUFFICIENT_STORAGE
statusCode LOOP_DETECTED
statusCode BANDWIDTH_LIMIT_EXCEEDED
statusCode NOT_EXTENDED
statusCode NETWORK_AUTHENTICATION_REQUIRED

bulkDeleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators \
  -H 'Authorization: API_KEY'

DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  method: 'delete (produces: application/vnd.bulk.search.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete (produces: application/vnd.bulk.search.operation+json) 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete (produces: application/vnd.bulk.search.operation+json)('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON) /api/devices/{deviceId}/actuators

bulkDelete

Permissions:
hasAuthority('DEVICE_WRITE')

Description:
Performs a delete operation based on given search criteria. Response gives count of deleted items.

Parameters

Parameter In Type Required Description
query query undefined false query
readingTypeId query undefined false readingTypeId
deviceId path undefined true deviceId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

readUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id} HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/{deviceId}/actuators/{id}

read

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK DeviceActuator
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id} HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/devices/{deviceId}/actuators/{id}

delete

Permissions:
hasAuthority('DEVICE_WRITE')

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id} HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "description": null,
  "deviceKey": null,
  "contextId": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "deviceName": null,
  "reference": null,
  "connected": true,
  "originType": null,
  "path": null,
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "originId": null,
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "device": {
    "configs": {
      "dataType": "STRING",
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "deviceName": null,
      "labels": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "size": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null,
      "status": "READY"
    },
    "activationTimestamp": null,
    "serviceStatuses": {
      "extras": null,
      "id": null,
      "error": null,
      "type": null,
      "timestamp": null,
      "status": null
    },
    "lastReportTimestamp": null,
    "deviceAlarms": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "message": null,
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "id": null,
      "device": null,
      "value": null,
      "status": "NORMAL"
    },
    "creatorName": null,
    "type": null,
    "path": null,
    "password": null,
    "protocol": null,
    "originId": null,
    "id": null,
    "attributesWithoutReadOnly": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "deviceSensors": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "connectionState": "CONNECTED",
    "manifest": {
      "deviceType": null,
      "generallyAvailable": true,
      "configs": {
        "reference": null,
        "size": null,
        "defaultValue": null,
        "dataType": "STRING",
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "nullValue": null,
        "labels": null
      },
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "reference": null,
        "name": null,
        "description": null,
        "id": null,
        "message": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "permission": "VIEW",
      "published": true,
      "originType": null,
      "path": null,
      "protocol": null,
      "actuators": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "defaultValue": null,
        "options": null,
        "name": null,
        "readOnly": true,
        "id": null,
        "type": "STRING",
        "validationRegex": null,
        "required": true
      },
      "id": null
    },
    "deviceKey": null,
    "contextId": null,
    "permission": "VIEW",
    "originType": null,
    "roleName": null,
    "name": null,
    "deviceActuators": null,
    "attributes": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "parameters": {
      "id": null,
      "type": null,
      "value": null,
      "key": null
    }
  },
  "value": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/devices/{deviceId}/actuators/{id}

update

Permissions:
hasAuthority('DEVICE_WRITE')

Body parameter

{
  "description": null,
  "deviceKey": null,
  "contextId": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "deviceName": null,
  "reference": null,
  "connected": true,
  "originType": null,
  "path": null,
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "originId": null,
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "device": {
    "configs": {
      "dataType": "STRING",
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "deviceName": null,
      "labels": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "size": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null,
      "status": "READY"
    },
    "activationTimestamp": null,
    "serviceStatuses": {
      "extras": null,
      "id": null,
      "error": null,
      "type": null,
      "timestamp": null,
      "status": null
    },
    "lastReportTimestamp": null,
    "deviceAlarms": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "message": null,
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "id": null,
      "device": null,
      "value": null,
      "status": "NORMAL"
    },
    "creatorName": null,
    "type": null,
    "path": null,
    "password": null,
    "protocol": null,
    "originId": null,
    "id": null,
    "attributesWithoutReadOnly": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "deviceSensors": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "connectionState": "CONNECTED",
    "manifest": {
      "deviceType": null,
      "generallyAvailable": true,
      "configs": {
        "reference": null,
        "size": null,
        "defaultValue": null,
        "dataType": "STRING",
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "nullValue": null,
        "labels": null
      },
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "reference": null,
        "name": null,
        "description": null,
        "id": null,
        "message": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "permission": "VIEW",
      "published": true,
      "originType": null,
      "path": null,
      "protocol": null,
      "actuators": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "defaultValue": null,
        "options": null,
        "name": null,
        "readOnly": true,
        "id": null,
        "type": "STRING",
        "validationRegex": null,
        "required": true
      },
      "id": null
    },
    "deviceKey": null,
    "contextId": null,
    "permission": "VIEW",
    "originType": null,
    "roleName": null,
    "name": null,
    "deviceActuators": null,
    "attributes": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "parameters": {
      "id": null,
      "type": null,
      "value": null,
      "key": null
    }
  },
  "value": null
}

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
id path long true id
body body DeviceActuator true update

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

actuateUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/devices/{deviceId}/actuators/{id}/actuations

actuate

Permissions:
hasAuthority('DEVICE_WRITE')

Body parameter

null

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
id path long true id
body body String false value

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

device-alarm-api

device-alarm-api

readUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id} HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/{deviceId}/alarms/{id}

read

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK DeviceAlarm
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id} HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/devices/{deviceId}/alarms/{id}

delete

Permissions:
hasAuthority('DEVICE_WRITE')

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id} HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "description": null,
  "deviceKey": null,
  "contextId": null,
  "message": null,
  "deviceName": null,
  "reference": null,
  "connected": true,
  "originType": null,
  "path": null,
  "originId": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "device": {
    "configs": {
      "dataType": "STRING",
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "deviceName": null,
      "labels": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "size": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null,
      "status": "READY"
    },
    "activationTimestamp": null,
    "serviceStatuses": {
      "extras": null,
      "id": null,
      "error": null,
      "type": null,
      "timestamp": null,
      "status": null
    },
    "lastReportTimestamp": null,
    "deviceAlarms": null,
    "creatorName": null,
    "type": null,
    "path": null,
    "password": null,
    "protocol": null,
    "originId": null,
    "id": null,
    "attributesWithoutReadOnly": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "deviceSensors": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "connectionState": "CONNECTED",
    "manifest": {
      "deviceType": null,
      "generallyAvailable": true,
      "configs": {
        "reference": null,
        "size": null,
        "defaultValue": null,
        "dataType": "STRING",
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "nullValue": null,
        "labels": null
      },
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "reference": null,
        "name": null,
        "description": null,
        "id": null,
        "message": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "permission": "VIEW",
      "published": true,
      "originType": null,
      "path": null,
      "protocol": null,
      "actuators": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "defaultValue": null,
        "options": null,
        "name": null,
        "readOnly": true,
        "id": null,
        "type": "STRING",
        "validationRegex": null,
        "required": true
      },
      "id": null
    },
    "deviceKey": null,
    "contextId": null,
    "permission": "VIEW",
    "originType": null,
    "roleName": null,
    "name": null,
    "deviceActuators": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "state": "READY",
      "minimum": null,
      "device": null,
      "value": null
    },
    "attributes": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "parameters": {
      "id": null,
      "type": null,
      "value": null,
      "key": null
    }
  },
  "value": null,
  "status": "NORMAL"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/devices/{deviceId}/alarms/{id}

update

Permissions:
hasAuthority('DEVICE_WRITE')

Body parameter

{
  "description": null,
  "deviceKey": null,
  "contextId": null,
  "message": null,
  "deviceName": null,
  "reference": null,
  "connected": true,
  "originType": null,
  "path": null,
  "originId": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "device": {
    "configs": {
      "dataType": "STRING",
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "deviceName": null,
      "labels": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "size": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null,
      "status": "READY"
    },
    "activationTimestamp": null,
    "serviceStatuses": {
      "extras": null,
      "id": null,
      "error": null,
      "type": null,
      "timestamp": null,
      "status": null
    },
    "lastReportTimestamp": null,
    "deviceAlarms": null,
    "creatorName": null,
    "type": null,
    "path": null,
    "password": null,
    "protocol": null,
    "originId": null,
    "id": null,
    "attributesWithoutReadOnly": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "deviceSensors": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "connectionState": "CONNECTED",
    "manifest": {
      "deviceType": null,
      "generallyAvailable": true,
      "configs": {
        "reference": null,
        "size": null,
        "defaultValue": null,
        "dataType": "STRING",
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "nullValue": null,
        "labels": null
      },
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "reference": null,
        "name": null,
        "description": null,
        "id": null,
        "message": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "permission": "VIEW",
      "published": true,
      "originType": null,
      "path": null,
      "protocol": null,
      "actuators": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "defaultValue": null,
        "options": null,
        "name": null,
        "readOnly": true,
        "id": null,
        "type": "STRING",
        "validationRegex": null,
        "required": true
      },
      "id": null
    },
    "deviceKey": null,
    "contextId": null,
    "permission": "VIEW",
    "originType": null,
    "roleName": null,
    "name": null,
    "deviceActuators": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "state": "READY",
      "minimum": null,
      "device": null,
      "value": null
    },
    "attributes": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "parameters": {
      "id": null,
      "type": null,
      "value": null,
      "key": null
    }
  },
  "value": null,
  "status": "NORMAL"
}

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
id path long true id
body body DeviceAlarm true update

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "description": null,
  "deviceKey": null,
  "contextId": null,
  "message": null,
  "deviceName": null,
  "reference": null,
  "connected": true,
  "originType": null,
  "path": null,
  "originId": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "device": {
    "configs": {
      "dataType": "STRING",
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "deviceName": null,
      "labels": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "size": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null,
      "status": "READY"
    },
    "activationTimestamp": null,
    "serviceStatuses": {
      "extras": null,
      "id": null,
      "error": null,
      "type": null,
      "timestamp": null,
      "status": null
    },
    "lastReportTimestamp": null,
    "deviceAlarms": null,
    "creatorName": null,
    "type": null,
    "path": null,
    "password": null,
    "protocol": null,
    "originId": null,
    "id": null,
    "attributesWithoutReadOnly": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "deviceSensors": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "connectionState": "CONNECTED",
    "manifest": {
      "deviceType": null,
      "generallyAvailable": true,
      "configs": {
        "reference": null,
        "size": null,
        "defaultValue": null,
        "dataType": "STRING",
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "nullValue": null,
        "labels": null
      },
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "reference": null,
        "name": null,
        "description": null,
        "id": null,
        "message": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "permission": "VIEW",
      "published": true,
      "originType": null,
      "path": null,
      "protocol": null,
      "actuators": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "defaultValue": null,
        "options": null,
        "name": null,
        "readOnly": true,
        "id": null,
        "type": "STRING",
        "validationRegex": null,
        "required": true
      },
      "id": null
    },
    "deviceKey": null,
    "contextId": null,
    "permission": "VIEW",
    "originType": null,
    "roleName": null,
    "name": null,
    "deviceActuators": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "state": "READY",
      "minimum": null,
      "device": null,
      "value": null
    },
    "attributes": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "parameters": {
      "id": null,
      "type": null,
      "value": null,
      "key": null
    }
  },
  "value": null,
  "status": "NORMAL"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/devices/{deviceId}/alarms

create

Permissions:
hasAuthority('DEVICE_WRITE')

Body parameter

{
  "description": null,
  "deviceKey": null,
  "contextId": null,
  "message": null,
  "deviceName": null,
  "reference": null,
  "connected": true,
  "originType": null,
  "path": null,
  "originId": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "device": {
    "configs": {
      "dataType": "STRING",
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "deviceName": null,
      "labels": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "originId": null,
      "size": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null,
      "status": "READY"
    },
    "activationTimestamp": null,
    "serviceStatuses": {
      "extras": null,
      "id": null,
      "error": null,
      "type": null,
      "timestamp": null,
      "status": null
    },
    "lastReportTimestamp": null,
    "deviceAlarms": null,
    "creatorName": null,
    "type": null,
    "path": null,
    "password": null,
    "protocol": null,
    "originId": null,
    "id": null,
    "attributesWithoutReadOnly": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "deviceSensors": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "minimum": null,
      "device": null,
      "value": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "connectionState": "CONNECTED",
    "manifest": {
      "deviceType": null,
      "generallyAvailable": true,
      "configs": {
        "reference": null,
        "size": null,
        "defaultValue": null,
        "dataType": "STRING",
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "nullValue": null,
        "labels": null
      },
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "reference": null,
        "name": null,
        "description": null,
        "id": null,
        "message": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "permission": "VIEW",
      "published": true,
      "originType": null,
      "path": null,
      "protocol": null,
      "actuators": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "reference": null,
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "description": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "defaultValue": null,
        "options": null,
        "name": null,
        "readOnly": true,
        "id": null,
        "type": "STRING",
        "validationRegex": null,
        "required": true
      },
      "id": null
    },
    "deviceKey": null,
    "contextId": null,
    "permission": "VIEW",
    "originType": null,
    "roleName": null,
    "name": null,
    "deviceActuators": {
      "description": null,
      "deviceKey": null,
      "contextId": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      },
      "deviceName": null,
      "reference": null,
      "connected": true,
      "originType": null,
      "path": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "originId": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "state": "READY",
      "minimum": null,
      "device": null,
      "value": null
    },
    "attributes": {
      "deviceKey": null,
      "contextId": null,
      "readOnly": true,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "originType": null,
      "path": null,
      "originId": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "validationRegex": null,
      "value": null
    },
    "parameters": {
      "id": null,
      "type": null,
      "value": null,
      "key": null
    }
  },
  "value": null,
  "status": "NORMAL"
}

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
body body DeviceAlarm true dto

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Long
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  method: 'get (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/devices/{deviceId}/alarms

page

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
query query undefined false query
deviceId path undefined true deviceId

Responses

Status Meaning Description Schema
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/{deviceId}/alarms

list

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
query query String false query
deviceId path long true deviceId

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
404 Not Found Not Found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ResponseEntity] false none none
» headers HttpHeaders false none none
»» date long false none none
»» allow Set false none none
»» expires long false none none
»» accessControlMaxAge long false none none
»» vary String false none none
»» origin String false none none
»» ifUnmodifiedSince long false none none
»» range HttpRange false none none
»» ifModifiedSince long false none none
»» accessControlRequestMethod string false none none
»» accessControlAllowMethods [string] false none none
»» ifMatch String false none none
»» empty boolean false none none
»» accessControlAllowHeaders String false none none
»» accessControlAllowOrigin String false none none
»» contentDisposition ContentDisposition false none none
»»» charset Charset false none none
»»» modificationDate ZonedDateTime false none none
»»» filename String false none none
»»» size Long false none none
»»» readDate ZonedDateTime false none none
»»» name String false none none
»»» creationDate ZonedDateTime false none none
»»» type String false none none
»» host InetSocketAddress false none none
»» connection String false none none
»» eTag String false none none
»» contentType MediaType false none none
»»» concrete boolean false none none
»»» charset Charset false none none
»»» subtype String false none none
»»» qualityValue double false none none
»»» type String false none none
»»» wildcardSubtype boolean false none none
»»» parameters Map false none none
»»» wildcardType boolean false none none
»» accessControlRequestHeaders String false none none
»» acceptLanguageAsLocales Locale false none none
»» upgrade String false none none
»» acceptCharset Charset false none none
»» cacheControl String false none none
»» ifNoneMatch String false none none
»» pragma String false none none
»» accept MediaType false none none
»» accessControlExposeHeaders String false none none
»» acceptLanguage LanguageRange false none none
»» accessControlAllowCredentials boolean false none none
»» contentLanguage Locale false none none
»» contentLength long false none none
»» location URI false none none
»» lastModified long false none none
» statusCodeValue int false none none
» body Object false none none
» statusCode string false none none

Enumerated Values

Property Value
accessControlRequestMethod GET
accessControlRequestMethod HEAD
accessControlRequestMethod POST
accessControlRequestMethod PUT
accessControlRequestMethod PATCH
accessControlRequestMethod DELETE
accessControlRequestMethod OPTIONS
accessControlRequestMethod TRACE
statusCode CONTINUE
statusCode SWITCHING_PROTOCOLS
statusCode PROCESSING
statusCode CHECKPOINT
statusCode OK
statusCode CREATED
statusCode ACCEPTED
statusCode NON_AUTHORITATIVE_INFORMATION
statusCode NO_CONTENT
statusCode RESET_CONTENT
statusCode PARTIAL_CONTENT
statusCode MULTI_STATUS
statusCode ALREADY_REPORTED
statusCode IM_USED
statusCode MULTIPLE_CHOICES
statusCode MOVED_PERMANENTLY
statusCode FOUND
statusCode MOVED_TEMPORARILY
statusCode SEE_OTHER
statusCode NOT_MODIFIED
statusCode USE_PROXY
statusCode TEMPORARY_REDIRECT
statusCode PERMANENT_REDIRECT
statusCode BAD_REQUEST
statusCode UNAUTHORIZED
statusCode PAYMENT_REQUIRED
statusCode FORBIDDEN
statusCode NOT_FOUND
statusCode METHOD_NOT_ALLOWED
statusCode NOT_ACCEPTABLE
statusCode PROXY_AUTHENTICATION_REQUIRED
statusCode REQUEST_TIMEOUT
statusCode CONFLICT
statusCode GONE
statusCode LENGTH_REQUIRED
statusCode PRECONDITION_FAILED
statusCode PAYLOAD_TOO_LARGE
statusCode REQUEST_ENTITY_TOO_LARGE
statusCode URI_TOO_LONG
statusCode REQUEST_URI_TOO_LONG
statusCode UNSUPPORTED_MEDIA_TYPE
statusCode REQUESTED_RANGE_NOT_SATISFIABLE
statusCode EXPECTATION_FAILED
statusCode I_AM_A_TEAPOT
statusCode INSUFFICIENT_SPACE_ON_RESOURCE
statusCode METHOD_FAILURE
statusCode DESTINATION_LOCKED
statusCode UNPROCESSABLE_ENTITY
statusCode LOCKED
statusCode FAILED_DEPENDENCY
statusCode UPGRADE_REQUIRED
statusCode PRECONDITION_REQUIRED
statusCode TOO_MANY_REQUESTS
statusCode REQUEST_HEADER_FIELDS_TOO_LARGE
statusCode UNAVAILABLE_FOR_LEGAL_REASONS
statusCode INTERNAL_SERVER_ERROR
statusCode NOT_IMPLEMENTED
statusCode BAD_GATEWAY
statusCode SERVICE_UNAVAILABLE
statusCode GATEWAY_TIMEOUT
statusCode HTTP_VERSION_NOT_SUPPORTED
statusCode VARIANT_ALSO_NEGOTIATES
statusCode INSUFFICIENT_STORAGE
statusCode LOOP_DETECTED
statusCode BANDWIDTH_LIMIT_EXCEEDED
statusCode NOT_EXTENDED
statusCode NETWORK_AUTHENTICATION_REQUIRED

bulkDeleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms \
  -H 'Authorization: API_KEY'

DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  method: 'delete (produces: application/vnd.bulk.search.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete (produces: application/vnd.bulk.search.operation+json) 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete (produces: application/vnd.bulk.search.operation+json)('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE (PRODUCES: APPLICATION/VND.BULK.SEARCH.OPERATION+JSON) /api/devices/{deviceId}/alarms

bulkDelete

Permissions:
hasAuthority('DEVICE_WRITE')

Description:
Performs a delete operation based on given search criteria. Response gives count of deleted items.

Parameters

Parameter In Type Required Description
query query undefined false query
deviceId path undefined true deviceId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

device-api

device-api

numberOfDevicesUntilLimitUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/devicesUntilLimit \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/devicesUntilLimit HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/devicesUntilLimit',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/devicesUntilLimit',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/devicesUntilLimit',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/devicesUntilLimit', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/devicesUntilLimit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/devicesUntilLimit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/devicesUntilLimit

numberOfDevicesUntilLimit (Deprecated)

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Long
401 Unauthorized Unauthorized None
404 Not Found Not Found None

removeLinkBulkUsingDELETE

Code samples

# You can also use wget
curl -X DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/links \
  -H 'Authorization: API_KEY'

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/links HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/links',
  method: 'delete (produces: application/vnd.bulk.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/links',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete (produces: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/devices/{deviceId}/links',
  params: {
  'linkIds' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete (produces: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/devices/{deviceId}/links', params={
  'linkIds': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/links");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceId}/links", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) /api/devices/{deviceId}/links

removeLinkBulk

Permissions:
hasAuthority('DEVICE_WRITE')

Parameters

Parameter In Type Required Description
linkIds query undefined true linkIds
deviceId path undefined true deviceId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageByAttributeUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGEBYATTRIBUTE+JSON) https://api-demo.wolkabout.com/api/devices \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGEBYATTRIBUTE+JSON) https://api-demo.wolkabout.com/api/devices HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices',
  method: 'get (produces: application/vnd.pageByAttribute+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGEBYATTRIBUTE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.pageByAttribute+json) 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.pageByAttribute+json)('https://api-demo.wolkabout.com/api/devices', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGEBYATTRIBUTE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGEBYATTRIBUTE+JSON)", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGEBYATTRIBUTE+JSON) /api/devices

pageByAttribute

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
state query undefined false state
query query undefined false query
type query undefined false type
protocol query undefined false protocol
templateId query undefined false templateId

Responses

Status Meaning Description Schema
401 Unauthorized Unauthorized None
404 Not Found Not Found None

bulkDeleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/devices \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/devices HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api-demo.wolkabout.com/api/devices',
  params: {
  'ids' => 'List'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api-demo.wolkabout.com/api/devices', params={
  'ids': 'null'
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/devices

bulkDelete

Permissions:
hasAuthority('DEVICE_WRITE')

Parameters

Parameter In Type Required Description
ids query List true ids

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/devices \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/devices HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "protocol": null,
  "defaultBinding": true,
  "name": null,
  "deviceKey": null,
  "deviceAttributes": null,
  "type": null,
  "group": null,
  "deviceTypeParameters": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api-demo.wolkabout.com/api/devices', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/devices

create

Permissions:
hasAuthority('DEVICE_WRITE')

Body parameter

{
  "protocol": null,
  "defaultBinding": true,
  "name": null,
  "deviceKey": null,
  "deviceAttributes": null,
  "type": null,
  "group": null,
  "deviceTypeParameters": null
}

Parameters

Parameter In Type Required Description
body body DeviceCreationDto2 true newDevice

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Device
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices',
  method: 'get (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/devices', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/devices

page (Deprecated)

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
state query undefined false state
query query undefined false query
type query undefined false type
protocol query undefined false protocol
templateId query undefined false templateId

Responses

Status Meaning Description Schema
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices

list (Deprecated)

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
state query string false state
query query String false query
type query String false type
protocol query String false protocol
templateId query Long false templateId

Enumerated Values

Parameter Value
state CONNECTED
state OFFLINE
state DEACTIVATED
state SERVICE_MODE
state SLEEP

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
404 Not Found Not Found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ResponseEntity] false none none
» headers HttpHeaders false none none
»» date long false none none
»» allow Set false none none
»» expires long false none none
»» accessControlMaxAge long false none none
»» vary String false none none
»» origin String false none none
»» ifUnmodifiedSince long false none none
»» range HttpRange false none none
»» ifModifiedSince long false none none
»» accessControlRequestMethod string false none none
»» accessControlAllowMethods [string] false none none
»» ifMatch String false none none
»» empty boolean false none none
»» accessControlAllowHeaders String false none none
»» accessControlAllowOrigin String false none none
»» contentDisposition ContentDisposition false none none
»»» charset Charset false none none
»»» modificationDate ZonedDateTime false none none
»»» filename String false none none
»»» size Long false none none
»»» readDate ZonedDateTime false none none
»»» name String false none none
»»» creationDate ZonedDateTime false none none
»»» type String false none none
»» host InetSocketAddress false none none
»» connection String false none none
»» eTag String false none none
»» contentType MediaType false none none
»»» concrete boolean false none none
»»» charset Charset false none none
»»» subtype String false none none
»»» qualityValue double false none none
»»» type String false none none
»»» wildcardSubtype boolean false none none
»»» parameters Map false none none
»»» wildcardType boolean false none none
»» accessControlRequestHeaders String false none none
»» acceptLanguageAsLocales Locale false none none
»» upgrade String false none none
»» acceptCharset Charset false none none
»» cacheControl String false none none
»» ifNoneMatch String false none none
»» pragma String false none none
»» accept MediaType false none none
»» accessControlExposeHeaders String false none none
»» acceptLanguage LanguageRange false none none
»» accessControlAllowCredentials boolean false none none
»» contentLanguage Locale false none none
»» contentLength long false none none
»» location URI false none none
»» lastModified long false none none
» statusCodeValue int false none none
» body Object false none none
» statusCode string false none none

Enumerated Values

Property Value
accessControlRequestMethod GET
accessControlRequestMethod HEAD
accessControlRequestMethod POST
accessControlRequestMethod PUT
accessControlRequestMethod PATCH
accessControlRequestMethod DELETE
accessControlRequestMethod OPTIONS
accessControlRequestMethod TRACE
statusCode CONTINUE
statusCode SWITCHING_PROTOCOLS
statusCode PROCESSING
statusCode CHECKPOINT
statusCode OK
statusCode CREATED
statusCode ACCEPTED
statusCode NON_AUTHORITATIVE_INFORMATION
statusCode NO_CONTENT
statusCode RESET_CONTENT
statusCode PARTIAL_CONTENT
statusCode MULTI_STATUS
statusCode ALREADY_REPORTED
statusCode IM_USED
statusCode MULTIPLE_CHOICES
statusCode MOVED_PERMANENTLY
statusCode FOUND
statusCode MOVED_TEMPORARILY
statusCode SEE_OTHER
statusCode NOT_MODIFIED
statusCode USE_PROXY
statusCode TEMPORARY_REDIRECT
statusCode PERMANENT_REDIRECT
statusCode BAD_REQUEST
statusCode UNAUTHORIZED
statusCode PAYMENT_REQUIRED
statusCode FORBIDDEN
statusCode NOT_FOUND
statusCode METHOD_NOT_ALLOWED
statusCode NOT_ACCEPTABLE
statusCode PROXY_AUTHENTICATION_REQUIRED
statusCode REQUEST_TIMEOUT
statusCode CONFLICT
statusCode GONE
statusCode LENGTH_REQUIRED
statusCode PRECONDITION_FAILED
statusCode PAYLOAD_TOO_LARGE
statusCode REQUEST_ENTITY_TOO_LARGE
statusCode URI_TOO_LONG
statusCode REQUEST_URI_TOO_LONG
statusCode UNSUPPORTED_MEDIA_TYPE
statusCode REQUESTED_RANGE_NOT_SATISFIABLE
statusCode EXPECTATION_FAILED
statusCode I_AM_A_TEAPOT
statusCode INSUFFICIENT_SPACE_ON_RESOURCE
statusCode METHOD_FAILURE
statusCode DESTINATION_LOCKED
statusCode UNPROCESSABLE_ENTITY
statusCode LOCKED
statusCode FAILED_DEPENDENCY
statusCode UPGRADE_REQUIRED
statusCode PRECONDITION_REQUIRED
statusCode TOO_MANY_REQUESTS
statusCode REQUEST_HEADER_FIELDS_TOO_LARGE
statusCode UNAVAILABLE_FOR_LEGAL_REASONS
statusCode INTERNAL_SERVER_ERROR
statusCode NOT_IMPLEMENTED
statusCode BAD_GATEWAY
statusCode SERVICE_UNAVAILABLE
statusCode GATEWAY_TIMEOUT
statusCode HTTP_VERSION_NOT_SUPPORTED
statusCode VARIANT_ALSO_NEGOTIATES
statusCode INSUFFICIENT_STORAGE
statusCode LOOP_DETECTED
statusCode BANDWIDTH_LIMIT_EXCEEDED
statusCode NOT_EXTENDED
statusCode NETWORK_AUTHENTICATION_REQUIRED

listByAttributeUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.LISTBYATTRIBUTE+JSON) https://api-demo.wolkabout.com/api/devices \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.LISTBYATTRIBUTE+JSON) https://api-demo.wolkabout.com/api/devices HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices',
  method: 'get (produces: application/vnd.listByAttribute+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices',
{
  method: 'GET (PRODUCES: APPLICATION/VND.LISTBYATTRIBUTE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.listByAttribute+json) 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.listByAttribute+json)('https://api-demo.wolkabout.com/api/devices', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.LISTBYATTRIBUTE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.LISTBYATTRIBUTE+JSON)", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.LISTBYATTRIBUTE+JSON) /api/devices

listByAttribute

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
state query undefined false state
query query undefined false query
type query undefined false type
protocol query undefined false protocol
templateId query undefined false templateId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

createBulkUsingPOST

Code samples

# You can also use wget
curl -X POST (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices \
  -H 'Authorization: API_KEY'

POST (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices',
  method: 'post (consumes: application/vnd.bulk.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices',
{
  method: 'POST (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.post (consumes: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.post (consumes: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/devices', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON) /api/devices

createBulk (Deprecated)

Permissions:
hasAuthority('DEVICE_WRITE')

Parameters

Parameter In Type Required Description
newDevices body List true newDevices

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

removeLinkUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/devices/{deviceId}/links/{linkId} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/devices/{deviceId}/links/{linkId} HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/links/{linkId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceId}/links/{linkId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api-demo.wolkabout.com/api/devices/{deviceId}/links/{linkId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api-demo.wolkabout.com/api/devices/{deviceId}/links/{linkId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/links/{linkId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/devices/{deviceId}/links/{linkId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/devices/{deviceId}/links/{linkId}

removeLink

Permissions:
hasAuthority('DEVICE_WRITE')

Parameters

Parameter In Type Required Description
deviceId path long true deviceId
linkId path long true linkId

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Void
401 Unauthorized Unauthorized None
404 Not Found Not Found None

searchGroupsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/{id}/userGroups \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/{id}/userGroups HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/userGroups',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}/userGroups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/{id}/userGroups',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/{id}/userGroups', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/userGroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/{id}/userGroups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/{id}/userGroups

searchGroups

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
query query String false query
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
404 Not Found Not Found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ResourceAccess] false none none
» permission string true none none
» id long false none Unique identifier per entity class.
» userGroup UserGroup true none none
»» systemManaged boolean false Access READ_ONLY none
»» name String false Size (0, 256) Name of the entity.
»» description String false Size (0, 255) none
»» contextId Context false none none
»»» generallyAvailable boolean false none none
»»» name String false Size (0, 127) Name of the entity.
»»» active boolean false none none
»»» id long false none Unique identifier per entity class.
»» id long false none Unique identifier per entity class.

Enumerated Values

Property Value
permission VIEW
permission MODIFY

readUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.ID+JSON) https://api-demo.wolkabout.com/api/devices/{id} \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.ID+JSON) https://api-demo.wolkabout.com/api/devices/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}',
  method: 'get (produces: application/vnd.id+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}',
{
  method: 'GET (PRODUCES: APPLICATION/VND.ID+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.id+json) 'https://api-demo.wolkabout.com/api/devices/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.id+json)('https://api-demo.wolkabout.com/api/devices/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.ID+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.ID+JSON)", "https://api-demo.wolkabout.com/api/devices/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.ID+JSON) /api/devices/{id}

read

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/devices/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/devices/{id} HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api-demo.wolkabout.com/api/devices/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api-demo.wolkabout.com/api/devices/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/devices/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/devices/{id}

delete

Permissions:
hasAuthority('DEVICE_WRITE')

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

availableSlotsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/availableSlots \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/availableSlots HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/availableSlots',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/availableSlots',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/availableSlots',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/availableSlots', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/availableSlots");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/availableSlots", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/availableSlots

availableSlots

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Long
401 Unauthorized Unauthorized None
404 Not Found Not Found None

renameUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/devices/{deviceKey}/name \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/devices/{deviceKey}/name HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceKey}/name',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceKey}/name',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api-demo.wolkabout.com/api/devices/{deviceKey}/name',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api-demo.wolkabout.com/api/devices/{deviceKey}/name', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceKey}/name");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/devices/{deviceKey}/name", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/devices/{deviceKey}/name

rename

Permissions:
hasAuthority('DEVICE_WRITE')

Body parameter

null

Parameters

Parameter In Type Required Description
deviceKey path String true deviceKey
body body updateNameUsingPUTName true name

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

createAccessUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/devices/{id}/access \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/devices/{id}/access HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'VIEW';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}/access',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  params: {
  'userGroupId' => 'long'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api-demo.wolkabout.com/api/devices/{id}/access', params={
  'userGroupId': 'null'
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/access");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/devices/{id}/access", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/devices/{id}/access

createAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

Parameter In Type Required Description
userGroupId query long true userGroupId
id path long true id
body body createUsingPOSTPermission true permission

Enumerated Values

Parameter Value
body VIEW
body MODIFY

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageAccessUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices/{id}/access \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices/{id}/access HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  method: 'get (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}/access',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/devices/{id}/access', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/access");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/devices/{id}/access", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/devices/{id}/access

pageAccess

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
query query undefined false query
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listAccessUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/{id}/access \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/{id}/access HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}/access',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/{id}/access', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/access");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/{id}/access", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/{id}/access

listAccess

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
query query String false query
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
404 Not Found Not Found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ResourceAccess] false none none
» permission string true none none
» id long false none Unique identifier per entity class.
» userGroup UserGroup true none none
»» systemManaged boolean false Access READ_ONLY none
»» name String false Size (0, 256) Name of the entity.
»» description String false Size (0, 255) none
»» contextId Context false none none
»»» generallyAvailable boolean false none none
»»» name String false Size (0, 127) Name of the entity.
»»» active boolean false none none
»»» id long false none Unique identifier per entity class.
»» id long false none Unique identifier per entity class.

Enumerated Values

Property Value
permission VIEW
permission MODIFY

deleteAccessUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/devices/{id}/access \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/devices/{id}/access HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}/access',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  params: {
  'userGroupId' => 'long'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api-demo.wolkabout.com/api/devices/{id}/access', params={
  'userGroupId': 'null'
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/access");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/devices/{id}/access", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/devices/{id}/access

deleteAccess

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
userGroupId query long true userGroupId
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateAccessUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/devices/{id}/access \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/devices/{id}/access HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'VIEW';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}/access',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api-demo.wolkabout.com/api/devices/{id}/access',
  params: {
  'userGroupId' => 'long'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api-demo.wolkabout.com/api/devices/{id}/access', params={
  'userGroupId': 'null'
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/access");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/devices/{id}/access", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/devices/{id}/access

updateAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

Parameter In Type Required Description
userGroupId query long true userGroupId
id path long true id
body body createUsingPOSTPermission true permission

Enumerated Values

Parameter Value
body VIEW
body MODIFY

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseEntity
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageLinksUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices/{id}/links \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/devices/{id}/links HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/links',
  method: 'get (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}/links',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/devices/{id}/links',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/devices/{id}/links', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/links");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/devices/{id}/links", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/devices/{id}/links

pageLinks

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
query query undefined false query
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listLinksUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/{id}/links \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/{id}/links HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/links',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{id}/links',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/{id}/links',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/{id}/links', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/links");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/{id}/links", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/{id}/links

listLinks

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Parameters

Parameter In Type Required Description
query query String false query
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
404 Not Found Not Found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [DevicePointLinkDto] false none none
» mapping MappingDto false none none
» linkedAt Instant false none none
» id long false none none
» device DeviceDto false none none
» point PointDto false none none

countDevicesUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/devices/countByState \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/devices/countByState HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/countByState',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/countByState',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api-demo.wolkabout.com/api/devices/countByState',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api-demo.wolkabout.com/api/devices/countByState', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/countByState");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/devices/countByState", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/devices/countByState

countDevices

Permissions:
hasAnyAuthority('DEVICE_READ', 'DEVICE_WRITE')

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
404 Not Found Not Found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ConnectionStateLong] false none none
» map false none none

generatePasswordUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/devices/{deviceKey}/password \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/devices/{deviceKey}/password HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

var headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceKey}/password',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/devices/{deviceKey}/password',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api-demo.wolkabout.com/api/devices/{deviceKey}/password',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api-demo.wolkabout.com/api/devices/{deviceKey}/password', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceKey}/password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/devices/{deviceKey}/password", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/devices/{deviceKey}/password

generatePassword

Permissions:
hasAuthority('DEVICE_WRITE')

Parameters

Parameter In Type Required Description
deviceKey path String true deviceKey

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK String
401 Unauthorized<