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

WolkAbout IoT Platform API Device Management v21.GA

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 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/bindings',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

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

Parameters

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

Responses

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

device-access-api

device-access-api

revokeAccessBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

  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/accesses',
{
  method: 'DELETE',

  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 'https://api-demo.wolkabout.com/api/devices/accesses',
  params: {
  'userGroupId' => 'undefined',
'assetIds' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/devices/accesses', params={
  'userGroupId': undefined,  'assetIds': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/accesses");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

DELETE /api/devices/accesses

revokeAccessBulk

Permissions:
isAuthenticated()

Description:
Asset IDs refers to default device group ids.

Parameters

Parameter In Type Required Description
userGroupId query undefined true userGroupId
assetIds query undefined true assetIds

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/accesses \
  -H 'Authorization: API_KEY'

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

var headers = {
  'Authorization':'API_KEY'

};

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

  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/accesses',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/devices/accesses',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/accesses");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/devices/accesses

list

Permissions:
isAuthenticated()

Description:
Returns a filtered list of accesses.

Parameters

Parameter In Type Required Description
userGroupId query undefined false userGroupId
roleId query undefined false roleId
assetId query undefined false assetId
searchPhrase query undefined false searchPhrase
systemManaged query undefined false systemManaged

Responses

Status Meaning Description Schema
200 OK OK None
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/accesses \
  -H 'Authorization: API_KEY'

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/accesses',
  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/accesses',
{
  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/accesses',
  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/accesses', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/accesses");
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/accesses", data)
    req.Header = headers

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

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

page

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of accesses.

Parameters

Parameter In Type Required Description
userGroupId query undefined false userGroupId
roleId query undefined false roleId
assetId query undefined false assetId
searchPhrase query undefined false searchPhrase
systemManaged query undefined false systemManaged

Responses

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

listMyAccessesUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/myAccess HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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}/accesses/myAccess',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/myAccess',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/myAccess");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/devices/{deviceId}/accesses/myAccess

listMyAccesses

Permissions:
isAuthenticated()

Description:
Returns a list of all permissions user has over the device.

Parameters

Parameter In Type Required Description
deviceId path undefined true deviceId

Responses

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

grantAccessBulkUsingPOST

Code samples

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

POST (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses',
  method: 'POST (Content-Type: 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}/accesses',
{
  method: 'POST (CONTENT-TYPE: 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 (Content-Type: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.POST (Content-Type: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST (CONTENT-TYPE: 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 (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses", data)
    req.Header = headers

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

POST (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) /api/devices/{deviceId}/accesses

grantAccessBulk

Permissions:
isAuthenticated()

Description:
Grants access over a device to multiple user groups.

Parameters

Parameter In Type Required Description
deviceId path undefined true deviceId
dto body DeviceGroupAccessCreationBulkDto true dto

Responses

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

grantAccessUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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}/accesses',
{
  method: 'POST',

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

POST /api/devices/{deviceId}/accesses

grantAccess

Permissions:
isAuthenticated()

Description:
Grand access over a device to single user group.

Parameters

Parameter In Type Required Description
deviceId path undefined true deviceId
dto body DeviceGroupAccessCreationDto true dto

Responses

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

revokeAccessOnGroupUsingDELETE

Code samples

# You can also use wget
curl -X DELETE (CONTENT-TYPE: APPLICATION/VND.DEVICEGROUP+JSON) https://api-demo.wolkabout.com/api/devices/{deviceGroupId}/accesses/{userGroupId} \
  -H 'Authorization: API_KEY'

DELETE (CONTENT-TYPE: APPLICATION/VND.DEVICEGROUP+JSON) https://api-demo.wolkabout.com/api/devices/{deviceGroupId}/accesses/{userGroupId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceGroupId}/accesses/{userGroupId}',
  method: 'DELETE (Content-Type: application/vnd.deviceGroup+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/{deviceGroupId}/accesses/{userGroupId}',
{
  method: 'DELETE (CONTENT-TYPE: APPLICATION/VND.DEVICEGROUP+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 (Content-Type: application/vnd.deviceGroup+json) 'https://api-demo.wolkabout.com/api/devices/{deviceGroupId}/accesses/{userGroupId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.DELETE (Content-Type: application/vnd.deviceGroup+json)('https://api-demo.wolkabout.com/api/devices/{deviceGroupId}/accesses/{userGroupId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceGroupId}/accesses/{userGroupId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE (CONTENT-TYPE: APPLICATION/VND.DEVICEGROUP+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 (CONTENT-TYPE: APPLICATION/VND.DEVICEGROUP+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceGroupId}/accesses/{userGroupId}", data)
    req.Header = headers

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

DELETE (CONTENT-TYPE: APPLICATION/VND.DEVICEGROUP+JSON) /api/devices/{deviceGroupId}/accesses/{userGroupId}

revokeAccessOnGroup

Permissions:
isAuthenticated()

Description:
Revokes access over device group form a user group.

Parameters

Parameter In Type Required Description
deviceGroupId path undefined true deviceGroupId
userGroupId path undefined true userGroupId

Responses

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

revokeAccessUsingDELETE

Code samples

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

DELETE https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/{userGroupId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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}/accesses/{userGroupId}',
{
  method: 'DELETE',

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/{userGroupId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/{userGroupId}");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

DELETE /api/devices/{deviceId}/accesses/{userGroupId}

revokeAccess

Permissions:
isAuthenticated()

Description:
Revokes access over device form a user group.

Parameters

Parameter In Type Required Description
deviceId path undefined true deviceId
userGroupId path undefined true userGroupId

Responses

Status Meaning Description Schema
200 OK OK None
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/{deviceId}/accesses/{userGroupId} \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/{userGroupId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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}/accesses/{userGroupId}',
{
  method: 'PUT',

  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.PUT 'https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/{userGroupId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/accesses/{userGroupId}");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

PUT /api/devices/{deviceId}/accesses/{userGroupId}

updateAccess

Permissions:
isAuthenticated()

Description:
Changes the role a user group has over a device.

Parameters

Parameter In Type Required Description
deviceId path undefined true deviceId
userGroupId path undefined true userGroupId
roleId body long true roleId

Responses

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

listUsersWithGlobalAccessUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

  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/usersWithGlobalAccess',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/devices/usersWithGlobalAccess',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/usersWithGlobalAccess");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/devices/usersWithGlobalAccess

listUsersWithGlobalAccess

Permissions:
isAuthenticated()

Description:
Returns a list of users with access to device though a global role.

Parameters

Parameter In Type Required Description
assetId query undefined false assetId

Responses

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

pageUsersWithGlobalAccessUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/usersWithGlobalAccess',
  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/usersWithGlobalAccess',
{
  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/usersWithGlobalAccess',
  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/usersWithGlobalAccess', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/usersWithGlobalAccess");
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/usersWithGlobalAccess", data)
    req.Header = headers

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

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

pageUsersWithGlobalAccess

Permissions:
isAuthenticated()

Description:
Returns a paged list of users with access to device though a global role.

Parameters

Parameter In Type Required Description
assetId query undefined false assetId

Responses

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

device-actuator-api

device-actuator-api

resetUsingPUT

Code samples

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

PUT https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/reset HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/{id}/reset',
{
  method: 'PUT',

  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.PUT 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/reset',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/reset");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

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

reset

Permissions:
isAuthenticated()

Description:
Updates actuators state to READY from any state other then OFFLINE.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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/{deviceId}/actuators \
  -H 'Authorization: API_KEY'

DELETE 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',

  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',

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators', params={
  'ids': 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("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{
        "Authorization": []string{"API_KEY"},

    }

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

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

DELETE /api/devices/{deviceId}/actuators

bulkDelete

Permissions:
isAuthenticated()

Description:
Delete many actuators by ids.

Parameters

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

Responses

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

deleteBySearchUsingDELETE

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

deleteBySearch

Permissions:
isAuthenticated()

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

createUsingPOST

Code samples

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

POST 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: 'POST',

  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: 'POST',

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new actuator.

Parameters

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

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 'Authorization: API_KEY'

GET 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',

  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',

  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 '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('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{
        "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:
isAuthenticated()

Description:
Returns a filtered list of actuators on device.

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

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:
isAuthenticated()

Description:
Returns a filtered and paged list of actuators on device.

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

deleteUsingDELETE

Code samples

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

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

var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes actuator by id.

Parameters

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

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 'Authorization: API_KEY'

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

var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Returns information on actuator specified by id.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'

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

var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

  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.PUT 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates actuator.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/actuators/{id}/actuations',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Actuates an actuator to the sent value.

Parameters

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

Responses

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

device-alarm-api

device-alarm-api

deleteUsingDELETE

Code samples

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

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

var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes device alarm.

Parameters

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

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}/alarms/{id} \
  -H 'Authorization: API_KEY'

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

var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Returns information on device alarm specified by id.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'

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

var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

  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.PUT 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates the alarm specified by id.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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/{deviceId}/alarms \
  -H 'Authorization: API_KEY'

DELETE 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',

  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',

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms', params={
  'ids': undefined
}, 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");
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", "https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms", data)
    req.Header = headers

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

DELETE /api/devices/{deviceId}/alarms

bulkDelete

Permissions:
isAuthenticated()

Description:
Deletes multiple alarms specified by ids.

Parameters

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

Responses

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

deleteBySearchUsingDELETE

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

deleteBySearch

Permissions:
isAuthenticated()

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

createUsingPOST

Code samples

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

POST 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: 'POST',

  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: 'POST',

  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 'https://api-demo.wolkabout.com/api/devices/{deviceId}/alarms',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new alarm on device.

Parameters

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

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}/alarms \
  -H 'Authorization: API_KEY'

GET 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',

  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',

  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 '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('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{
        "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:
isAuthenticated()

Description:
Return a filtered list of alarms on device.

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

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:
isAuthenticated()

Description:
Return a filtered and paged list of alarms on device.

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

device-api

device-api

numberOfDevicesUntilLimitUsingGET

Code samples

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

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

var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Returns number of devices allowed to be created before the limit is reached.

Responses

Status Meaning Description Schema
200 OK OK None
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:
isAuthenticated()

Description:
Removes multiple links between device and points.

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

availableSlotsUsingGET

Code samples

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

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

var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Returns the number of available slots.

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'

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

var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

  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.PUT 'https://api-demo.wolkabout.com/api/devices/{deviceKey}/name',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Renames device by key.

Parameters

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

Responses

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

exportToCsvUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: TEXT/CSV) https://api-demo.wolkabout.com/api/devices/{id}/csv \
  -H 'Authorization: API_KEY'

GET (PRODUCES: TEXT/CSV) https://api-demo.wolkabout.com/api/devices/{id}/csv HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{id}/csv',
  method: 'GET (produces: text/csv)',

  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}/csv',
{
  method: 'GET (PRODUCES: TEXT/CSV)',

  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: text/csv) 'https://api-demo.wolkabout.com/api/devices/{id}/csv',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.GET (produces: text/csv)('https://api-demo.wolkabout.com/api/devices/{id}/csv', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{id}/csv");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: TEXT/CSV)");
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: TEXT/CSV)", "https://api-demo.wolkabout.com/api/devices/{id}/csv", data)
    req.Header = headers

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

GET (PRODUCES: TEXT/CSV) /api/devices/{id}/csv

exportToCsv

Permissions:
isAuthenticated()

Description:
Exports device to comma separated file.

Parameters

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

Responses

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

exportLinksUsingGET

Code samples

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

GET (PRODUCES: TEXT/CSV) 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: text/csv)',

  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: TEXT/CSV)',

  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: text/csv) 'https://api-demo.wolkabout.com/api/devices/{id}/links',
  params: {
  'linkIds' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.GET (produces: text/csv)('https://api-demo.wolkabout.com/api/devices/{id}/links', params={
  'linkIds': undefined
}, 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: TEXT/CSV)");
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: TEXT/CSV)", "https://api-demo.wolkabout.com/api/devices/{id}/links", data)
    req.Header = headers

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

GET (PRODUCES: TEXT/CSV) /api/devices/{id}/links

exportLinks

Permissions:
isAuthenticated()

Description:
Exports device-point links to comma separated file.

Parameters

Parameter In Type Required Description
linkIds query undefined true linkIds
locale query undefined false locale
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 'Authorization: API_KEY'

GET 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',

  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',

  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 '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('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{
        "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:
isAuthenticated()

Description:
Return filtered list of device-point links.

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

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:
isAuthenticated()

Description:
Return filtered and paged list of device-point links.

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

generatePasswordUsingPUT

Code samples

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

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

var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Resets password of device.

Parameters

Parameter In Type Required Description
deviceKey path undefined true deviceKey

Responses

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

deleteBySearchUsingDELETE

Code samples

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

DELETE (PRODUCES: APPLICATION/VND.CRITERIA.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: 'DELETE (produces: application/vnd.criteria.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: 'DELETE (PRODUCES: APPLICATION/VND.CRITERIA.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.criteria.operation+json) 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.DELETE (produces: application/vnd.criteria.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("DELETE (PRODUCES: APPLICATION/VND.CRITERIA.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.CRITERIA.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

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

DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/devices

deleteBySearch

Permissions:
isAuthenticated()

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

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
groupIds query undefined false groupIds

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'

DELETE 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: 'DELETE',

  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: 'DELETE',

  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 'https://api-demo.wolkabout.com/api/devices',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/devices', params={
  'ids': undefined
}, 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{
        "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:
isAuthenticated()

Description:
Deletes multiple devices defined by ids.

Parameters

Parameter In Type Required Description
ids query undefined true ids

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 (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/devices \
  -H 'Authorization: API_KEY'

POST (CONTENT-TYPE: 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 (Content-Type: 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 (CONTENT-TYPE: 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 (Content-Type: 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 (Content-Type: 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 (CONTENT-TYPE: 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 (CONTENT-TYPE: 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 (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) /api/devices

createBulk (Deprecated)

Permissions:
isAuthenticated()

Description:
Creates multiple devices.

Parameters

Parameter In Type Required Description
newDevices body array[DeviceCreationDto] true newDevices

Responses

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

listWithManageAccessUsingGET

Code samples

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

GET (PRODUCES: APPLICATION/VND.LISTWITHMANAGEACCESS+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.listWithManageAccess+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.LISTWITHMANAGEACCESS+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.listWithManageAccess+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.listWithManageAccess+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.LISTWITHMANAGEACCESS+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.LISTWITHMANAGEACCESS+JSON)", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

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

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

listWithManageAccess

Permissions:
isAuthenticated()

Description:
Retrieve devices (id and name only) on which user has ADMINISTRATION.ACCESS_CONTROL.DEVICES_ACCESS_MANAGE permission.

Parameters

Parameter In Type Required Description
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'

POST 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',

  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',

  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 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new device.

Parameters

Parameter In Type Required Description
newDevice body DeviceCreationDto true newDevice

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 \
  -H 'Authorization: API_KEY'

GET 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',

  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',

  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 'https://api-demo.wolkabout.com/api/devices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Returns filtered list of devices.-deprecated

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

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:
isAuthenticated()

Description:
Returns filtered list of devices.

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
groupIds query undefined false groupIds

Responses

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

pageWithManageAccessUsingGET

Code samples

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

GET (PRODUCES: APPLICATION/VND.PAGEWITHMANAGEACCESS+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.pageWithManageAccess+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.PAGEWITHMANAGEACCESS+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.pageWithManageAccess+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.pageWithManageAccess+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.PAGEWITHMANAGEACCESS+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.PAGEWITHMANAGEACCESS+JSON)", "https://api-demo.wolkabout.com/api/devices", data)
    req.Header = headers

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

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

pageWithManageAccess

Permissions:
isAuthenticated()

Description:
Retrieve devices (id and name only) on which user has ADMINISTRATION.ACCESS_CONTROL.DEVICES_ACCESS_MANAGE permission.

Parameters

Parameter In Type Required Description
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
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:
isAuthenticated()

Description:
Returns filtered and paged list of devices.-deprecated

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

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:
isAuthenticated()

Description:
Returns filtered and paged list of devices.

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
groupIds query undefined false groupIds

Responses

Status Meaning Description Schema
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 'Authorization: API_KEY'

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

var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Removes link between device and point.

Parameters

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

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 'Authorization: API_KEY'

DELETE 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: 'DELETE',

  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: 'DELETE',

  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 'https://api-demo.wolkabout.com/api/devices/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes device by id.

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

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:
isAuthenticated()

Description:
Returns device by id.

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

removeDeviceGroupsBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/deviceGroups',
  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/deviceGroups',
{
  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/deviceGroups',
  params: {
  'deviceIds' => 'undefined',
'groupIds' => '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/deviceGroups', params={
  'deviceIds': undefined,  'groupIds': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/deviceGroups");
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/deviceGroups", data)
    req.Header = headers

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

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) /api/devices/deviceGroups

removeDeviceGroupsBulk

Permissions:
isAuthenticated()

Description:
Removes all referenced devices from every referenced device group.

Parameters

Parameter In Type Required Description
deviceIds query undefined true deviceIds
groupIds query undefined true groupIds

Responses

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

countDevicesUsingGET

Code samples

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

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

var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)

import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Returns count of devices grouped by state.

Responses

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

replaceUsingPUT

Code samples

# You can also use wget
curl -X PUT (CONTENT-TYPE: APPLICATION/VND.DEVICE.REPLACEMENT+JSON) https://api-demo.wolkabout.com/api/devices/{deviceKey} \
  -H 'Authorization: API_KEY'

PUT (CONTENT-TYPE: APPLICATION/VND.DEVICE.REPLACEMENT+JSON) https://api-demo.wolkabout.com/api/devices/{deviceKey} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/devices/{deviceKey}',
  method: 'PUT (Content-Type: application/vnd.device.replacement+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/{deviceKey}',
{
  method: 'PUT (CONTENT-TYPE: APPLICATION/VND.DEVICE.REPLACEMENT+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.PUT (Content-Type: application/vnd.device.replacement+json) 'https://api-demo.wolkabout.com/api/devices/{deviceKey}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.PUT (Content-Type: application/vnd.device.replacement+json)('https://api-demo.wolkabout.com/api/devices/{deviceKey}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceKey}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT (CONTENT-TYPE: APPLICATION/VND.DEVICE.REPLACEMENT+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("PUT (CONTENT-TYPE: APPLICATION/VND.DEVICE.REPLACEMENT+JSON)", "https://api-demo.wolkabout.com/api/devices/{deviceKey}", data)
    req.Header = headers

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

PUT (CONTENT-TYPE: APPLICATION/VND.DEVICE.REPLACEMENT+JSON) /api/devices/{deviceKey}

replace

Permissions:
isAuthenticated()

Description:
Changes devicce key of .

Parameters

Parameter In Type Required Description
deviceKey path undefined true deviceKey
newDeviceKey body String true newDeviceKey

Responses

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

getDeviceUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/devices/{deviceKey} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/{deviceKey}',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/devices/{deviceKey}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/devices/{deviceKey}");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/devices/{deviceKey}

getDevice

Permissions:
isAuthenticated()

Description:
Returns device by key.

Parameters

Parameter In Type Required Description
deviceKey path undefined true deviceKey

Responses

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

device-asset-finder-api

device-asset-finder-api

listConfigsUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/deviceConfigs HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/deviceConfigs',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/deviceConfigs',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceConfigs");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/deviceConfigs

listConfigs

Permissions:
isAuthenticated()

Description:
Returns a filtered list of device configurations.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name

Responses

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

pageConfigsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceConfigs',
  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/deviceConfigs',
{
  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/deviceConfigs',
  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/deviceConfigs', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceConfigs");
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/deviceConfigs", data)
    req.Header = headers

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

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

pageConfigs

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of device configurations.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name

Responses

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

pageDeviceActuatorsCompatibleWithActuatorUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceActuators',
  method: 'GET (produces: application/vnd.compatibleWithActuator.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/deviceActuators',
{
  method: 'GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR.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.compatibleWithActuator.page+json) 'https://api-demo.wolkabout.com/api/deviceActuators',
  params: {
  'actuatorUnitId' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

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

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceActuators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR.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.COMPATIBLEWITHACTUATOR.PAGE+JSON)", "https://api-demo.wolkabout.com/api/deviceActuators", data)
    req.Header = headers

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

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

pageDeviceActuatorsCompatibleWithActuator

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of device actuators compatible with actuator.

Parameters

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

Responses

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

listActuatorsUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/deviceActuators HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/deviceActuators',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/deviceActuators',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceActuators");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/deviceActuators

listActuators

Permissions:
isAuthenticated()

Description:
Returns a filtered list of device actuators.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name
readingTypeId query undefined false readingTypeId

Responses

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

listDeviceActuatorsCompatibleWithActuatorUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceActuators',
  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/deviceActuators',
{
  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/deviceActuators',
  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/deviceActuators', params={
  'actuatorUnitId': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceActuators");
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/deviceActuators", data)
    req.Header = headers

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

GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHACTUATOR+JSON) /api/deviceActuators

listDeviceActuatorsCompatibleWithActuator

Permissions:
isAuthenticated()

Description:
Returns a filtered list of device actuators compatible with actuator.

Parameters

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

Responses

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

pageActuatorsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceActuators',
  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/deviceActuators',
{
  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/deviceActuators',
  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/deviceActuators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceActuators");
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/deviceActuators", data)
    req.Header = headers

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

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

pageActuators

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of device actuators.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name
readingTypeId query undefined false readingTypeId

Responses

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

getDeviceConfigUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/deviceConfigs/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/deviceConfigs/{id}',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/deviceConfigs/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceConfigs/{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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/deviceConfigs/{id}

getDeviceConfig

Permissions:
isAuthenticated()

Description:
Returns the device configuration based on id.

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

listSensorsCompatibleWithFeedUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceSensors',
  method: 'GET (produces: application/vnd.compatibleWithFeed+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/deviceSensors',
{
  method: 'GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHFEED+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.compatibleWithFeed+json) 'https://api-demo.wolkabout.com/api/deviceSensors',
  params: {
  'feedUnitId' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.GET (produces: application/vnd.compatibleWithFeed+json)('https://api-demo.wolkabout.com/api/deviceSensors', params={
  'feedUnitId': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceSensors");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHFEED+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.COMPATIBLEWITHFEED+JSON)", "https://api-demo.wolkabout.com/api/deviceSensors", data)
    req.Header = headers

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

GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHFEED+JSON) /api/deviceSensors

listSensorsCompatibleWithFeed

Permissions:
isAuthenticated()

Description:
Returns a filtered list of device sensors that are compatible with feed.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name
readingTypeId query undefined false readingTypeId
feedUnitId query undefined true feedUnitId

Responses

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

listSensorsUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/deviceSensors HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/deviceSensors',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/deviceSensors',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceSensors");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/deviceSensors

listSensors

Permissions:
isAuthenticated()

Description:
Returns a filtered list of device sensors.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name
readingTypeId query undefined false readingTypeId

Responses

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

pageSensorsCompatibleWithFeedUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceSensors',
  method: 'GET (produces: application/vnd.compatibleWithFeed.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/deviceSensors',
{
  method: 'GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHFEED.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.compatibleWithFeed.page+json) 'https://api-demo.wolkabout.com/api/deviceSensors',
  params: {
  'feedUnitId' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.GET (produces: application/vnd.compatibleWithFeed.page+json)('https://api-demo.wolkabout.com/api/deviceSensors', params={
  'feedUnitId': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceSensors");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.COMPATIBLEWITHFEED.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.COMPATIBLEWITHFEED.PAGE+JSON)", "https://api-demo.wolkabout.com/api/deviceSensors", data)
    req.Header = headers

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

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

pageSensorsCompatibleWithFeed

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of device sensors that are compatible with feed.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name
readingTypeId query undefined false readingTypeId
feedUnitId query undefined true feedUnitId

Responses

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

pageSensorsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceSensors',
  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/deviceSensors',
{
  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/deviceSensors',
  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/deviceSensors', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceSensors");
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/deviceSensors", data)
    req.Header = headers

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

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

pageSensors

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of device sensors.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name
readingTypeId query undefined false readingTypeId

Responses

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

getDeviceAlarmUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/deviceAlarms/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/deviceAlarms/{id}',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/deviceAlarms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceAlarms/{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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/deviceAlarms/{id}

getDeviceAlarm

Permissions:
isAuthenticated()

Description:
Returns the device alarm based on id.

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

getDeviceSensorUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/deviceSensors/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/deviceSensors/{id}',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/deviceSensors/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceSensors/{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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/deviceSensors/{id}

getDeviceSensor

Permissions:
isAuthenticated()

Description:
Returns the device sensor based on id.

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

getDeviceActuatorUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/deviceActuators/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/deviceActuators/{id}',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/deviceActuators/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceActuators/{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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/deviceActuators/{id}

getDeviceActuator

Permissions:
isAuthenticated()

Description:
Returns the device actuator based on id.

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

listAlarmsUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/deviceAlarms HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

  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/deviceAlarms',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/deviceAlarms',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/deviceAlarms");
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{
        "Authorization": []string{"API_KEY"},

    }

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

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

GET /api/deviceAlarms

listAlarms

Permissions:
isAuthenticated()

Description:
Returns a filtered list of device alarms.

Parameters

Parameter In Type Required Description
deviceId query undefined false deviceId
name query undefined false name

Responses

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

pageAlarmsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceAlarms',
  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/deviceAlarms',
{
  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/deviceAlarms',
  params: {
  }, headers: headers

p JSON.parse(result)