WolkAbout IoT Platform API Platform Management v21.GA

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:

https://api-demo.wolkabout.com

Email: Wolkabout Web: Wolkabout

Authentication

API Key (Bearer)
- Parameter Name: Authorization, in: header.

cache-api

clearAllUsingDELETE

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/caches

clearAll

Permissions:
isAuthenticated()

Description:
Clears all the cache.

Responses

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

reloadAllUsingPUT

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

PUT https://api-demo.wolkabout.com/api/caches HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

PUT /api/caches

reloadAll

Permissions:
isAuthenticated()

Description:
Clears and loads again all caches. This is an asynchronous operation.

Responses

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

clearUsingDELETE

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

DELETE https://api-demo.wolkabout.com/api/caches/{name} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/caches/{name}', params={

}, headers = headers)

print r.json()

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

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

DELETE /api/caches/{name}

clear

Permissions:
isAuthenticated()

Description:
Clears the cache with given name.

Parameters

Parameter	In	Type	Required	Description
name	path	undefined	true	name

Responses

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

info-api

serverDetailsUsingGET

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/infos/server

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


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

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

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

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

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

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/infos/server',
  params: {
  }

p JSON.parse(result)

import requests

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

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/infos/server");
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() {

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

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

GET /api/infos/server

serverDetails

Permissions:

Description:
Returns the details of the server.

Responses

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

hasPlatformOwnerUsingGET

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/infos/hasPlatformOwner

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


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

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

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

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

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

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/infos/hasPlatformOwner',
  params: {
  }

p JSON.parse(result)

import requests

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

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/infos/hasPlatformOwner");
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() {

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

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

GET /api/infos/hasPlatformOwner

hasPlatformOwner

Permissions:

Description:
Returns eventOrigin - eventType mapping.

Responses

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

listEventTypesByOriginUsingGET

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/infos/eventTypes

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


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

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

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

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

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

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/infos/eventTypes',
  params: {
  }

p JSON.parse(result)

import requests

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

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/infos/eventTypes");
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() {

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

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

GET /api/infos/eventTypes

listEventTypesByOrigin

Permissions:

Description:
Returns eventOrigin - eventType mapping.

Responses

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

getLocalesUsingGET

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/infos/locales

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


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

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

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

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

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

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/infos/locales',
  params: {
  }

p JSON.parse(result)

import requests

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

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/infos/locales");
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() {

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

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

GET /api/infos/locales

getLocales

Permissions:

Description:
Provides locales.

Responses

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

signupEnabledUsingGET

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/infos/signupEnabled

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


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

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

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

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

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

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/infos/signupEnabled',
  params: {
  }

p JSON.parse(result)

import requests

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

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/infos/signupEnabled");
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() {

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

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

GET /api/infos/signupEnabled

signupEnabled

Permissions:

Description:
Returns information on whether sign up is enabled.

Responses

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

getPlatformDetailsUsingGET

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/infos/platform

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


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

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

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

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

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

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/infos/platform',
  params: {
  }

p JSON.parse(result)

import requests

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

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/infos/platform");
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() {

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

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

GET /api/infos/platform

getPlatformDetails

Permissions:

Description:
Returns the details of the platform.

Responses

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

listEventTypesUsingGET

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/infos/eventTypes/{originType}

GET https://api-demo.wolkabout.com/api/infos/eventTypes/{originType} HTTP/1.1
Host: api-demo.wolkabout.com


$.ajax({
  url: 'https://api-demo.wolkabout.com/api/infos/eventTypes/{originType}',
  method: 'GET',

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

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

fetch('https://api-demo.wolkabout.com/api/infos/eventTypes/{originType}',
{
  method: 'GET'

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

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/infos/eventTypes/{originType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.GET('https://api-demo.wolkabout.com/api/infos/eventTypes/{originType}', params={

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/infos/eventTypes/{originType}");
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() {

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

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

GET /api/infos/eventTypes/{originType}

listEventTypes

Permissions:

Description:
Returns all event types that can occur for the origin type.

Parameters

Parameter	In	Type	Required	Description
originType	path	undefined	true	originType

Responses

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

licence-api

readUsingGET

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/licences

read

Permissions:
isAuthenticated()

Description:
Provides current licence information.

Responses

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

updateUsingPUT

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

PUT https://api-demo.wolkabout.com/api/licences HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

PUT /api/licences

update

Permissions:
isAuthenticated()

Description:
Updates platform licence. Dont forget to update licence in yml file too.

Parameters

Parameter	In	Type	Required	Description
key	body	String	true	key

Responses

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

log-api

getUsingGET

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

GET https://api-demo.wolkabout.com/api/logs/{packageName} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/logs/{packageName}

get

Permissions:
isAuthenticated()

Description:
Can be used to read logging level for given package name.

Parameters

Parameter	In	Type	Required	Description
packageName	path	undefined	true	packageName

Responses

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

setUsingPUT

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

PUT https://api-demo.wolkabout.com/api/logs/{packageName} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.PUT('https://api-demo.wolkabout.com/api/logs/{packageName}', params={

}, headers = headers)

print r.json()

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

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

PUT /api/logs/{packageName}

set

Permissions:
isAuthenticated()

Description:
Can be used to change logging level for given package name. Possible log levels are ERROR, WARN, INFO, DEBUG, TRACE and OFF.

Parameters

Parameter	In	Type	Required	Description
packageName	path	undefined	true	packageName
level	body	String	true	level

Responses

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

platform-configuration-api

setSelfRegistrationUsingPUT

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

PUT https://api-demo.wolkabout.com/api/platformConfiguration/selfRegistration HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.PUT('https://api-demo.wolkabout.com/api/platformConfiguration/selfRegistration', params={

}, headers = headers)

print r.json()

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

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

PUT /api/platformConfiguration/selfRegistration

setSelfRegistration

Permissions:
isAuthenticated()

Description:
Enables/disables self registration on the platform.

Parameters

Parameter	In	Type	Required	Description
dto	body	SelfRegistrationDto	true	dto

Responses

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

setLocalizationUsingPUT

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

PUT https://api-demo.wolkabout.com/api/platformConfiguration/localization HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.PUT('https://api-demo.wolkabout.com/api/platformConfiguration/localization', params={

}, headers = headers)

print r.json()

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

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

PUT /api/platformConfiguration/localization

setLocalization

Permissions:
isAuthenticated()

Description:
Sets platform default locale and default time zone.

Parameters

Parameter	In	Type	Required	Description
dto	body	LocalizationDto	true	dto

Responses

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

getPlatformSettingsUsingGET

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/platformConfiguration

getPlatformSettings

Permissions:
isAuthenticated()

Description:
Reads the platform settings.

Responses

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

setPlatformSettingsUsingPUT

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

PUT https://api-demo.wolkabout.com/api/platformConfiguration HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

PUT /api/platformConfiguration

setPlatformSettings

Permissions:
isAuthenticated()

Description:
Sets the platform settings.

Parameters

Parameter	In	Type	Required	Description
settingsDto	body	PlatformSettingsUpdateDto	true	settingsDto

Responses

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

spam-control-api

updateLimitUsingPUT

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

PUT https://api-demo.wolkabout.com/api/spam/limit HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.PUT('https://api-demo.wolkabout.com/api/spam/limit', params={

}, headers = headers)

print r.json()

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

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

PUT /api/spam/limit

updateLimit

Permissions:
isAuthenticated()

Description:
Updates the maximum number of readings per minute per sensor.

Parameters

Parameter	In	Type	Required	Description
limit	body	Integer	true	limit

Responses

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

removeWhitelistReferenceItemUsingDELETE

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

DELETE https://api-demo.wolkabout.com/api/spam/whitelistReferences HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/spam/whitelistReferences', params={

}, headers = headers)

print r.json()

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

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

DELETE /api/spam/whitelistReferences

removeWhitelistReferenceItem

Permissions:
isAuthenticated()

Description:
Removes the device from the whitelist, then returns the whitelist references.

Parameters

Parameter	In	Type	Required	Description
item	body	String	true	item

Responses

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

addWhitelistReferenceItemUsingPOST

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

POST https://api-demo.wolkabout.com/api/spam/whitelistReferences HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.POST('https://api-demo.wolkabout.com/api/spam/whitelistReferences', params={

}, headers = headers)

print r.json()

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

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

POST /api/spam/whitelistReferences

addWhitelistReferenceItem

Permissions:
isAuthenticated()

Description:
Adds the device to the whitelist, then returns the whitelist references.

Parameters

Parameter	In	Type	Required	Description
item	body	String	true	item

Responses

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

listWhitelistReferenceItemUsingGET

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/spam/whitelistReferences

listWhitelistReferenceItem

Permissions:
isAuthenticated()

Description:
Returns a list references to the devices on the whitelist.

Responses

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

removeWhitelistFullPathItemUsingDELETE

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

DELETE https://api-demo.wolkabout.com/api/spam/whitelistFullpaths HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/spam/whitelistFullpaths', params={

}, headers = headers)

print r.json()

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

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

DELETE /api/spam/whitelistFullpaths

removeWhitelistFullPathItem

Permissions:
isAuthenticated()

Description:
Removes the sensor from the whitelist by full path, then returns the sensor whitelist.

Parameters

Parameter	In	Type	Required	Description
item	body	String	true	item

Responses

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

addWhitelistFullPathItemUsingPOST

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

POST https://api-demo.wolkabout.com/api/spam/whitelistFullpaths HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.POST('https://api-demo.wolkabout.com/api/spam/whitelistFullpaths', params={

}, headers = headers)

print r.json()

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

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

POST /api/spam/whitelistFullpaths

addWhitelistFullPathItem

Permissions:
isAuthenticated()

Description:
Adds sensor full path to the whitelist, then returns the sensor whitelist.

Parameters

Parameter	In	Type	Required	Description
item	body	String	true	item

Responses

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

listWhitelistFullPathItemUsingGET

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/spam/whitelistFullpaths

listWhitelistFullPathItem

Permissions:
isAuthenticated()

Description:
Return a list of full paths for sensors that are whitelisted.

Responses

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

removeWhitelistDeviceItemUsingDELETE

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

DELETE https://api-demo.wolkabout.com/api/spam/whitelistDevices HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/spam/whitelistDevices', params={

}, headers = headers)

print r.json()

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

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

DELETE /api/spam/whitelistDevices

removeWhitelistDeviceItem

Permissions:
isAuthenticated()

Description:
Remove the device from the whitelist by device key, then returns a list of the device keys on the whitelist.

Parameters

Parameter	In	Type	Required	Description
item	body	String	true	item

Responses

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

addWhitelistDeviceItemUsingPOST

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

POST https://api-demo.wolkabout.com/api/spam/whitelistDevices HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.POST('https://api-demo.wolkabout.com/api/spam/whitelistDevices', params={

}, headers = headers)

print r.json()

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

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

POST /api/spam/whitelistDevices

addWhitelistDeviceItem

Permissions:
isAuthenticated()

Description:
Adds the device to the whitelist by device key, then returns a list of the device keys on the whitelist.

Parameters

Parameter	In	Type	Required	Description
item	body	String	true	item

Responses

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

listWhitelistDeviceItemUsingGET

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/spam/whitelistDevices

listWhitelistDeviceItem

Permissions:
isAuthenticated()

Description:
Returns a list of the keys of the devices on the whitelist.

Responses

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

removeBlacklistDeviceItemUsingDELETE

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

DELETE https://api-demo.wolkabout.com/api/spam/blacklistDevices HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.DELETE('https://api-demo.wolkabout.com/api/spam/blacklistDevices', params={

}, headers = headers)

print r.json()

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

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

DELETE /api/spam/blacklistDevices

removeBlacklistDeviceItem

Permissions:
isAuthenticated()

Description:
Removes the device from the blacklist, then returns the blacklist.

Parameters

Parameter	In	Type	Required	Description
item	body	String	true	item

Responses

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

addBlacklistDeviceItemUsingPOST

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

POST https://api-demo.wolkabout.com/api/spam/blacklistDevices HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

r = requests.POST('https://api-demo.wolkabout.com/api/spam/blacklistDevices', params={

}, headers = headers)

print r.json()

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

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

POST /api/spam/blacklistDevices

addBlacklistDeviceItem

Permissions:
isAuthenticated()

Description:
Adds device to the blacklist, then returns the blacklist.

Parameters

Parameter	In	Type	Required	Description
item	body	String	true	item

Responses

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

listBlacklistDeviceItemUsingGET

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/spam/blacklistDevices

listBlacklistDeviceItem

Permissions:
isAuthenticated()

Description:
Returns a list of device keys referencing blacklisted devices.

Responses

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

Schemas

Access

{
  "contextName": null,
  "userActive": true,
  "contextLocale": null,
  "permissions": null,
  "contextActive": true,
  "roleName": null,
  "contextId": null,
  "accessToken": null,
  "contextTimeZone": null,
  "masterContext": true
}

Properties

Name	Type	Required	Restrictions	Description
contextName	String	false	none	none
userActive	boolean	false	none	none
contextLocale	String	false	none	none
permissions	String	false	none	none
contextActive	boolean	false	none	none
roleName	String	false	none	none
contextId	long	false	none	none
accessToken	String	false	none	none
contextTimeZone	String	false	none	none
masterContext	boolean	false	none	none

AccessDto

{
  "userGroupId": null,
  "userGroupDisplayName": null,
  "userGroupSystemManaged": true,
  "roleId": null,
  "userGroupName": null,
  "roleName": null,
  "id": null,
  "asset": null
}

Properties

Name	Type	Required	Restrictions	Description
userGroupId	long	false	none	none
userGroupDisplayName	String	false	none	none
userGroupSystemManaged	boolean	false	none	none
roleId	long	false	none	none
userGroupName	String	false	none	none
roleName	String	false	none	none
id	long	false	none	none
asset	Object	false	none	none

AccessToken

{
  "name": null,
  "id": null,
  "suspended": true,
  "status": "VALID",
  "token": null,
  "expirationDate": null
}

Properties

Name	Type	Required	Restrictions	Description
name	String	false	Size (0, 127)	Name of the entity.
id	long	false	none	Unique identifier per entity class.
suspended	boolean	false	none	none
status	string	false	none	none
token	String	false	none	none
expirationDate	ZonedDateTime	true	ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.	none

Enumerated Values

Property	Value
status	VALID
status	EXPIRED

AccessTokenStatus

null

Properties

None

AccountActivationDto

{
  "password": null,
  "againPassword": null
}

Properties

Name	Type	Required	Restrictions	Description
password	String	false	none	none
againPassword	String	false	none	none

ActivateInvitedDto

{
  "firstName": null,
  "lastName": null,
  "password": null,
  "againPassword": null
}

Properties

Name	Type	Required	Restrictions	Description
firstName	String	true	Size (1, 64)	none
lastName	String	true	Size (1, 64)	none
password	String	false	none	none
againPassword	String	false	none	none

Actuator

{
  "sourceId": null,
  "alarmMessage": null,
  "contextId": null,
  "pathId": null,
  "creationDate": null,
  "message": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "point": {
    "metadata": {
      "contextId": null,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "reference": null,
      "originType": null,
      "path": null,
      "originId": null,
      "valueValidationRegex": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "value": null
    },
    "creatorName": null,
    "pathId": null,
    "type": null,
    "templateId": {
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "name": null,
        "id": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "originType": null,
      "path": null,
      "actuators": {
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "id": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "valueValidationRegex": null,
        "defaultValue": null,
        "options": null,
        "name": null,
        "id": null,
        "type": "STRING",
        "required": true
      },
      "id": null
    },
    "path": null,
    "originId": null,
    "id": null,
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "contextId": null,
    "creationDate": null,
    "parentId": null,
    "originType": null,
    "lastUpdate": null,
    "roleName": null,
    "name": null,
    "guid": null,
    "location": {
      "latitude": null,
      "longitude": null
    },
    "status": "NORMAL"
  },
  "sourceStatus": "ACTIVE",
  "originType": null,
  "path": null,
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "alarmState": "ERROR",
  "originId": null,
  "sourceType": null,
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "value": null
}

Properties

Name	Type	Required	Restrictions	Description
sourceId	Long	false	none	none
alarmMessage	String	false	Access READ_ONLY	none
contextId	long	false	Access READ_ONLY	none
pathId	String	false	Size (0, 512) Access READ_ONLY	Holds info about asset logical parent(s) via ids, and it is unique in system.
creationDate	ZonedDateTime	false	Access READ_ONLY ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.	none
message	String	false	none	none
readingType	ReadingType	false	Access READ_ONLY ReadingTypeSerializer will serialize to { "id" : 0, "name" : value, "dataType" : value, "size" : 0, "lablels" : [], "iconName" : value }	none
point	Point	false	Access READ_ONLY EntityToIdSerializer will serialize to a long number, that is ID of the entity.	none
sourceStatus	string	false	Access READ_ONLY	none
originType	String	false	none	none
path	String	false	Access READ_ONLY	none
unit	Unit	true	UnitDeserializer can deserialize using several different json values and in this order: 1) { "guid" : "value"} 2) { "symbol" : "value", "readingTypeName" : "reading type name" } 3) { "id" : 0 } 4) { "symbol" : "value", "readingType" : "reading type name" } NOTE: both readingTypeName and readingType are the name of the reading type. Symbol can have null value.	none
alarmState	string	false	Access READ_ONLY	none
originId	long	false	none	none
sourceType	String	false	Size (0, 63)	none
lastUpdate	ZonedDateTime	false	Access READ_ONLY ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.	none
name	String	false	Size (0, 127)	Name of the entity.
maximum	BigDecimal	false	Integer 10 Fraction 10	none
id	long	false	none	Unique identifier per entity class.
state	string	false	Access AUTO	none
minimum	BigDecimal	false	Integer 10 Fraction 10	none
value	String	false	Size (0, 2048)	none

Enumerated Values

Property	Value
sourceStatus	ACTIVE
sourceStatus	INACTIVE
sourceStatus	NO_SOURCE
alarmState	ERROR
alarmState	WARNING
alarmState	NORMAL
state	READY
state	COMMANDED
state	BUSY
state	ERROR
state	OFFLINE

ActuatorDto

{
  "sourceId": null,
  "readingTypeDataType": null,
  "pointName": null,
  "readingTypeLabels": null,
  "readingTypeId": null,
  "path": null,
  "originId": null,
  "pointId": null,
  "unitId": null,
  "unitSymbol": null,
  "id": null,
  "value": null,
  "sourcePath": null,
  "unitName": null,
  "readingTypeSize": null,
  "pointPath": null,
  "sourceStatus": "ACTIVE",
  "originType": null,
  "sourceType": null,
  "commandStatus": "READY",
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "sourceName": null,
  "minimum": null
}

Properties

Name	Type	Required	Restrictions	Description
sourceId	Long	false	none	none
readingTypeDataType	String	false	none	none
pointName	String	false	none	none
readingTypeLabels	String	false	none	none
readingTypeId	long	false	none	none
path	String	false	none	none
originId	long	false	none	none
pointId	long	false	none	none
unitId	long	false	none	none
unitSymbol	String	false	none	none
id	long	false	none	none
value	String	false	none	none
sourcePath	String	false	none	none
unitName	String	false	none	none
readingTypeSize	int	false	none	none
pointPath	String	false	none	none
sourceStatus	string	false	none	none
originType	String	false	none	none
sourceType	String	false	none	none
commandStatus	string	false	none	none
lastUpdate	long	false	none	none
name	String	false	none	none
maximum	BigDecimal	false	none	none
sourceName	String	false	none	none
minimum	BigDecimal	false	none	none

Enumerated Values

Property	Value
sourceStatus	ACTIVE
sourceStatus	INACTIVE
sourceStatus	NO_SOURCE
commandStatus	READY
commandStatus	COMMANDED
commandStatus	BUSY
commandStatus	ERROR
commandStatus	OFFLINE

ActuatorExtendedProjection

{
  "sourceId": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "point": {
    "name": null,
    "id": null
  },
  "sourceStatus": "ACTIVE",
  "originType": null,
  "path": null,
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "originId": null,
  "sourceType": null,
  "commandStatus": "READY",
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "state": "READY",
  "id": null,
  "minimum": null,
  "value": null
}

Properties

Name	Type	Required	Restrictions	Description
sourceId	Long	false	none	none
readingType	ReadingType	false	ReadingTypeSerializer will serialize to { "id" : 0, "name" : value, "dataType" : value, "size" : 0, "lablels" : [], "iconName" : value }	none
point	NamedEntity	false	none	none
sourceStatus	string	false	none	none
originType	String	false	none	none
path	String	false	none	none
unit	Unit	false	none	none
originId	long	false	none	none
sourceType	String	false	none	none
commandStatus	string	false	none	none
lastUpdate	ZonedDateTime	false	none	none
name	String	false	none	none
maximum	BigDecimal	false	none	none
state	string	false	none	none
id	long	false	none	none
minimum	BigDecimal	false	none	none
value	String	false	none	none

Enumerated Values

Property	Value
sourceStatus	ACTIVE
sourceStatus	INACTIVE
sourceStatus	NO_SOURCE
commandStatus	READY
commandStatus	COMMANDED
commandStatus	BUSY
commandStatus	ERROR
commandStatus	OFFLINE
state	READY
state	COMMANDED
state	BUSY
state	ERROR
state	OFFLINE

ActuatorManifest

{
  "reference": null,
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "name": null,
  "maximum": null,
  "description": null,
  "id": null,
  "minimum": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
reference	String	true	Size (0, 64)	none
unit	Unit	true	UnitDeserializer can deserialize using several different json values and in this order: 1) { "symbol" : "String", "readingTypeName" : "String" } 2) { "id" : Number } NOTE: both readingTypeName and readingType are the name of the reading type. Symbol can have null value.	none
name	String	false	Size (0, 127)	Name of the entity.
maximum	BigDecimal	false	Integer 10 Fraction 10	none
description	String	false	Size (0, 255)	none
id	long	false	none	Unique identifier per entity class.
minimum	BigDecimal	false	Integer 10 Fraction 10	none
readingType	ReadingType	false	Access READ_ONLY ReadingTypeSerializer will serialize to { "id" : 0, "name" : value, "dataType" : value, "size" : 0, "lablels" : [], "iconName" : value }	none

ActuatorManifestDto

{
  "reference": null,
  "unit": {
    "name": null,
    "guid": null
  },
  "name": null,
  "maximum": null,
  "description": null,
  "minimum": null
}

Properties

Name	Type	Required	Restrictions	Description
reference	String	false	none	none
unit	UnitDto	false	none	none
name	String	false	none	none
maximum	BigDecimal	false	none	none
description	String	false	none	none
minimum	BigDecimal	false	none	none

ActuatorMappingCreateDto

{
  "deviceActuatorName": null,
  "actuatorName": null
}

Properties

Name	Type	Required	Restrictions	Description
deviceActuatorName	String	true	none	none
actuatorName	String	true	none	none

ActuatorMappingListDto

{
  "mappingId": null,
  "deviceActuatorId": null,
  "id": null,
  "deviceActuatorName": null,
  "actuatorName": null,
  "actuatorId": null
}

Properties

Name	Type	Required	Restrictions	Description
mappingId	long	false	none	none
deviceActuatorId	long	false	none	none
id	long	false	none	none
deviceActuatorName	String	false	none	none
actuatorName	String	false	none	none
actuatorId	long	false	none	none

ActuatorTemplate

{
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "name": null,
  "maximum": null,
  "id": null,
  "minimum": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
unit	Unit	true	UnitDeserializer can deserialize using several different json values and in this order: 1) { "guid" : "value"} 2) { "symbol" : "value", "readingTypeName" : "reading type name" } 3) { "id" : 0 } 4) { "symbol" : "value", "readingType" : "reading type name" } NOTE: both readingTypeName and readingType are the name of the reading type. Symbol can have null value.	none
name	String	false	Size (0, 127)	Name of the entity.
maximum	BigDecimal	false	Integer 16 Fraction 10	none
id	long	false	none	Unique identifier per entity class.
minimum	BigDecimal	false	Integer 16 Fraction 10	none
readingType	ReadingType	false	Access READ_ONLY ReadingTypeSerializer will serialize to { "id" : 0, "name" : value, "dataType" : value, "size" : 0, "lablels" : [], "iconName" : value }	none

ActuatorTemplateDto

{
  "unit": {
    "name": null,
    "guid": null
  },
  "name": null,
  "maximum": null,
  "minimum": null
}

Properties

Name	Type	Required	Restrictions	Description
unit	UnitDto	false	none	none
name	String	false	none	none
maximum	BigDecimal	false	none	none
minimum	BigDecimal	false	none	none

ActuatorWithExtras

{
  "actuator": {
    "sourceId": null,
    "alarmMessage": null,
    "contextId": null,
    "pathId": null,
    "creationDate": null,
    "message": null,
    "readingType": {
      "trending": true,
      "image": null,
      "fileName": null,
      "dataType": "STRING",
      "aggregatable": true,
      "contextId": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "units": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "labels": null,
      "defaultUnit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "size": null,
      "inUse": true,
      "name": null,
      "id": null
    },
    "point": {
      "metadata": {
        "contextId": null,
        "creationDate": null,
        "type": "STRING",
        "required": true,
        "reference": null,
        "originType": null,
        "path": null,
        "originId": null,
        "valueValidationRegex": null,
        "lastUpdate": null,
        "options": null,
        "name": null,
        "id": null,
        "value": null
      },
      "creatorName": null,
      "pathId": null,
      "type": null,
      "templateId": {
        "creator": {
          "firstName": null,
          "lastName": null,
          "verified": true,
          "id": null,
          "email": null
        },
        "alarms": {
          "name": null,
          "id": null
        },
        "creatorName": null,
        "description": null,
        "contextId": null,
        "originType": null,
        "path": null,
        "actuators": {
          "unit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "name": null,
          "maximum": null,
          "id": null,
          "minimum": null,
          "readingType": {
            "trending": true,
            "image": null,
            "fileName": null,
            "dataType": "STRING",
            "aggregatable": true,
            "contextId": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "units": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "labels": null,
            "defaultUnit": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "size": null,
            "inUse": true,
            "name": null,
            "id": null
          }
        },
        "originId": null,
        "inUse": true,
        "roleName": null,
        "name": null,
        "guid": null,
        "feeds": {
          "unit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "name": null,
          "id": null,
          "readingType": {
            "trending": true,
            "image": null,
            "fileName": null,
            "dataType": "STRING",
            "aggregatable": true,
            "contextId": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "units": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "labels": null,
            "defaultUnit": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "size": null,
            "inUse": true,
            "name": null,
            "id": null
          }
        },
        "attributes": {
          "valueValidationRegex": null,
          "defaultValue": null,
          "options": null,
          "name": null,
          "id": null,
          "type": "STRING",
          "required": true
        },
        "id": null
      },
      "path": null,
      "originId": null,
      "id": null,
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "contextId": null,
      "creationDate": null,
      "parentId": null,
      "originType": null,
      "lastUpdate": null,
      "roleName": null,
      "name": null,
      "guid": null,
      "location": {
        "latitude": null,
        "longitude": null
      },
      "status": "NORMAL"
    },
    "sourceStatus": "ACTIVE",
    "originType": null,
    "path": null,
    "unit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "alarmState": "ERROR",
    "originId": null,
    "sourceType": null,
    "lastUpdate": null,
    "name": null,
    "maximum": null,
    "id": null,
    "state": "READY",
    "minimum": null,
    "value": null
  },
  "eventOrigin": {
    "originType": null,
    "path": null,
    "originId": null,
    "contextId": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
actuator	Actuator	false	none	none
eventOrigin	EventOrigin	false	none	none

ActuatorWithRoute

{
  "actuator": {
    "sourceId": null,
    "alarmMessage": null,
    "contextId": null,
    "pathId": null,
    "creationDate": null,
    "message": null,
    "readingType": {
      "trending": true,
      "image": null,
      "fileName": null,
      "dataType": "STRING",
      "aggregatable": true,
      "contextId": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "units": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "labels": null,
      "defaultUnit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "size": null,
      "inUse": true,
      "name": null,
      "id": null
    },
    "point": {
      "metadata": {
        "contextId": null,
        "creationDate": null,
        "type": "STRING",
        "required": true,
        "reference": null,
        "originType": null,
        "path": null,
        "originId": null,
        "valueValidationRegex": null,
        "lastUpdate": null,
        "options": null,
        "name": null,
        "id": null,
        "value": null
      },
      "creatorName": null,
      "pathId": null,
      "type": null,
      "templateId": {
        "creator": {
          "firstName": null,
          "lastName": null,
          "verified": true,
          "id": null,
          "email": null
        },
        "alarms": {
          "name": null,
          "id": null
        },
        "creatorName": null,
        "description": null,
        "contextId": null,
        "originType": null,
        "path": null,
        "actuators": {
          "unit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "name": null,
          "maximum": null,
          "id": null,
          "minimum": null,
          "readingType": {
            "trending": true,
            "image": null,
            "fileName": null,
            "dataType": "STRING",
            "aggregatable": true,
            "contextId": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "units": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "labels": null,
            "defaultUnit": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "size": null,
            "inUse": true,
            "name": null,
            "id": null
          }
        },
        "originId": null,
        "inUse": true,
        "roleName": null,
        "name": null,
        "guid": null,
        "feeds": {
          "unit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "name": null,
          "id": null,
          "readingType": {
            "trending": true,
            "image": null,
            "fileName": null,
            "dataType": "STRING",
            "aggregatable": true,
            "contextId": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "units": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "labels": null,
            "defaultUnit": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "size": null,
            "inUse": true,
            "name": null,
            "id": null
          }
        },
        "attributes": {
          "valueValidationRegex": null,
          "defaultValue": null,
          "options": null,
          "name": null,
          "id": null,
          "type": "STRING",
          "required": true
        },
        "id": null
      },
      "path": null,
      "originId": null,
      "id": null,
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "contextId": null,
      "creationDate": null,
      "parentId": null,
      "originType": null,
      "lastUpdate": null,
      "roleName": null,
      "name": null,
      "guid": null,
      "location": {
        "latitude": null,
        "longitude": null
      },
      "status": "NORMAL"
    },
    "sourceStatus": "ACTIVE",
    "originType": null,
    "path": null,
    "unit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "alarmState": "ERROR",
    "originId": null,
    "sourceType": null,
    "lastUpdate": null,
    "name": null,
    "maximum": null,
    "id": null,
    "state": "READY",
    "minimum": null,
    "value": null
  },
  "route": {
    "originType": null,
    "originId": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
actuator	Actuator	false	none	none
route	Route	false	none	none

AdvancedRuleCreationDto

{
  "name": null,
  "description": null,
  "active": true,
  "traced": true,
  "content": null
}

Properties

Name	Type	Required	Restrictions	Description
name	String	false	none	none
description	String	false	none	none
active	boolean	false	none	none
traced	boolean	false	none	none
content	String	false	none	none

AdvancedRuleDto

{
  "executionTracing": true,
  "creatorName": null,
  "creatorId": null,
  "lastModification": null,
  "name": null,
  "description": null,
  "active": true,
  "modifiedBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "id": null,
  "creationDate": null,
  "lastExecutionTime": null,
  "content": null
}

Properties

Name	Type	Required	Restrictions	Description
executionTracing	boolean	false	none	none
creatorName	String	false	none	none
creatorId	long	false	none	none
lastModification	long	false	none	none
name	String	false	none	none
description	String	false	none	none
active	boolean	false	none	none
modifiedBy	User	false	none	none
id	long	false	none	none
creationDate	long	false	none	none
lastExecutionTime	Long	false	none	none
content	String	false	none	none

Alarm

{
  "sourceId": null,
  "alarmMessage": null,
  "contextId": null,
  "pathId": null,
  "creationDate": null,
  "message": null,
  "point": {
    "metadata": {
      "contextId": null,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "reference": null,
      "originType": null,
      "path": null,
      "originId": null,
      "valueValidationRegex": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "value": null
    },
    "creatorName": null,
    "pathId": null,
    "type": null,
    "templateId": {
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "name": null,
        "id": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "originType": null,
      "path": null,
      "actuators": {
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "id": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "valueValidationRegex": null,
        "defaultValue": null,
        "options": null,
        "name": null,
        "id": null,
        "type": "STRING",
        "required": true
      },
      "id": null
    },
    "path": null,
    "originId": null,
    "id": null,
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "contextId": null,
    "creationDate": null,
    "parentId": null,
    "originType": null,
    "lastUpdate": null,
    "roleName": null,
    "name": null,
    "guid": null,
    "location": {
      "latitude": null,
      "longitude": null
    },
    "status": "NORMAL"
  },
  "sourceStatus": "ACTIVE",
  "originType": null,
  "path": null,
  "alarmState": "ERROR",
  "originId": null,
  "sourceType": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "value": null,
  "status": "NORMAL"
}

Properties

Name	Type	Required	Restrictions	Description
sourceId	Long	false	none	none
alarmMessage	String	false	Access READ_ONLY	none
contextId	long	false	Access READ_ONLY	none
pathId	String	false	Size (0, 512) Access READ_ONLY	Holds info about asset logical parent(s) via ids, and it is unique in system.
creationDate	ZonedDateTime	false	Access READ_ONLY ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.	none
message	String	false	none	none
point	Point	false	Access READ_ONLY EntityToIdSerializer will serialize to a long number, that is ID of the entity.	none
sourceStatus	string	false	Access READ_ONLY	none
originType	String	false	none	none
path	String	false	Access READ_ONLY	none
alarmState	string	false	Access READ_ONLY	none
originId	long	false	none	none
sourceType	String	false	Size (0, 63)	none
lastUpdate	ZonedDateTime	false	Access READ_ONLY ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.	none
name	String	false	Size (0, 127)	Name of the entity.
id	long	false	none	Unique identifier per entity class.
value	String	false	Size (0, 2048)	none
status	string	false	Access READ_ONLY	none

Enumerated Values

Property	Value
sourceStatus	ACTIVE
sourceStatus	INACTIVE
sourceStatus	NO_SOURCE
alarmState	ERROR
alarmState	WARNING
alarmState	NORMAL
status	NORMAL
status	ALARM

AlarmExtendedProjection

{
  "sourceStatus": "ACTIVE",
  "sourceId": null,
  "originType": null,
  "path": null,
  "originId": null,
  "sourceType": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "value": null,
  "point": {
    "name": null,
    "id": null
  },
  "status": "NORMAL"
}

Properties

Name	Type	Required	Restrictions	Description
sourceStatus	string	false	none	none
sourceId	Long	false	none	none
originType	String	false	none	none
path	String	false	none	none
originId	long	false	none	none
sourceType	String	false	none	none
lastUpdate	ZonedDateTime	false	none	none
name	String	false	none	none
id	long	false	none	none
value	String	false	none	none
point	NamedEntity	false	none	none
status	string	false	none	none

Enumerated Values

Property	Value
sourceStatus	ACTIVE
sourceStatus	INACTIVE
sourceStatus	NO_SOURCE
status	NORMAL
status	ALARM

AlarmManifest

{
  "reference": null,
  "name": null,
  "description": null,
  "id": null,
  "message": null
}

Properties

Name	Type	Required	Restrictions	Description
reference	String	true	Size (0, 64)	none
name	String	false	Size (0, 127)	Name of the entity.
description	String	false	Size (0, 512)	none
id	long	false	none	Unique identifier per entity class.
message	String	false	Size (0, 512)	none

AlarmManifestDto

{
  "reference": null,
  "name": null,
  "description": null,
  "message": null
}

Properties

Name	Type	Required	Restrictions	Description
reference	String	false	none	none
name	String	false	none	none
description	String	false	none	none
message	String	false	none	none

AlarmMappingCreateDto

{
  "alarmName": null,
  "deviceAlarmName": null
}

Properties

Name	Type	Required	Restrictions	Description
alarmName	String	true	none	none
deviceAlarmName	String	true	none	none

AlarmMappingListDto

{
  "mappingId": null,
  "alarmId": null,
  "alarmName": null,
  "id": null,
  "deviceAlarmName": null,
  "deviceAlarmId": null
}

Properties

Name	Type	Required	Restrictions	Description
mappingId	long	false	none	none
alarmId	long	false	none	none
alarmName	String	false	none	none
id	long	false	none	none
deviceAlarmName	String	false	none	none
deviceAlarmId	long	false	none	none

AlarmState

null

Properties

None

AlarmStatus

null

Properties

None

AlarmTemplate

{
  "name": null,
  "id": null
}

Properties

Name	Type	Required	Restrictions	Description
name	String	false	Size (0, 127)	Name of the entity.
id	long	false	none	Unique identifier per entity class.

AlarmTemplateDto

{
  "name": null
}

Properties

Name	Type	Required	Restrictions	Description
name	String	false	none	none

AlarmWithExtras

{
  "alarm": {
    "sourceId": null,
    "alarmMessage": null,
    "contextId": null,
    "pathId": null,
    "creationDate": null,
    "message": null,
    "point": {
      "metadata": {
        "contextId": null,
        "creationDate": null,
        "type": "STRING",
        "required": true,
        "reference": null,
        "originType": null,
        "path": null,
        "originId": null,
        "valueValidationRegex": null,
        "lastUpdate": null,
        "options": null,
        "name": null,
        "id": null,
        "value": null
      },
      "creatorName": null,
      "pathId": null,
      "type": null,
      "templateId": {
        "creator": {
          "firstName": null,
          "lastName": null,
          "verified": true,
          "id": null,
          "email": null
        },
        "alarms": {
          "name": null,
          "id": null
        },
        "creatorName": null,
        "description": null,
        "contextId": null,
        "originType": null,
        "path": null,
        "actuators": {
          "unit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "name": null,
          "maximum": null,
          "id": null,
          "minimum": null,
          "readingType": {
            "trending": true,
            "image": null,
            "fileName": null,
            "dataType": "STRING",
            "aggregatable": true,
            "contextId": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "units": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "labels": null,
            "defaultUnit": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "size": null,
            "inUse": true,
            "name": null,
            "id": null
          }
        },
        "originId": null,
        "inUse": true,
        "roleName": null,
        "name": null,
        "guid": null,
        "feeds": {
          "unit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "name": null,
          "id": null,
          "readingType": {
            "trending": true,
            "image": null,
            "fileName": null,
            "dataType": "STRING",
            "aggregatable": true,
            "contextId": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "units": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "labels": null,
            "defaultUnit": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "size": null,
            "inUse": true,
            "name": null,
            "id": null
          }
        },
        "attributes": {
          "valueValidationRegex": null,
          "defaultValue": null,
          "options": null,
          "name": null,
          "id": null,
          "type": "STRING",
          "required": true
        },
        "id": null
      },
      "path": null,
      "originId": null,
      "id": null,
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "contextId": null,
      "creationDate": null,
      "parentId": null,
      "originType": null,
      "lastUpdate": null,
      "roleName": null,
      "name": null,
      "guid": null,
      "location": {
        "latitude": null,
        "longitude": null
      },
      "status": "NORMAL"
    },
    "sourceStatus": "ACTIVE",
    "originType": null,
    "path": null,
    "alarmState": "ERROR",
    "originId": null,
    "sourceType": null,
    "lastUpdate": null,
    "name": null,
    "id": null,
    "value": null,
    "status": "NORMAL"
  },
  "eventOrigin": {
    "originType": null,
    "path": null,
    "originId": null,
    "contextId": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
alarm	Alarm	false	none	none
eventOrigin	EventOrigin	false	none	none

AlarmWithRoute

{
  "route": {
    "originType": null,
    "originId": null
  },
  "alarm": {
    "sourceId": null,
    "alarmMessage": null,
    "contextId": null,
    "pathId": null,
    "creationDate": null,
    "message": null,
    "point": {
      "metadata": {
        "contextId": null,
        "creationDate": null,
        "type": "STRING",
        "required": true,
        "reference": null,
        "originType": null,
        "path": null,
        "originId": null,
        "valueValidationRegex": null,
        "lastUpdate": null,
        "options": null,
        "name": null,
        "id": null,
        "value": null
      },
      "creatorName": null,
      "pathId": null,
      "type": null,
      "templateId": {
        "creator": {
          "firstName": null,
          "lastName": null,
          "verified": true,
          "id": null,
          "email": null
        },
        "alarms": {
          "name": null,
          "id": null
        },
        "creatorName": null,
        "description": null,
        "contextId": null,
        "originType": null,
        "path": null,
        "actuators": {
          "unit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "name": null,
          "maximum": null,
          "id": null,
          "minimum": null,
          "readingType": {
            "trending": true,
            "image": null,
            "fileName": null,
            "dataType": "STRING",
            "aggregatable": true,
            "contextId": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "units": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "labels": null,
            "defaultUnit": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "size": null,
            "inUse": true,
            "name": null,
            "id": null
          }
        },
        "originId": null,
        "inUse": true,
        "roleName": null,
        "name": null,
        "guid": null,
        "feeds": {
          "unit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "name": null,
          "id": null,
          "readingType": {
            "trending": true,
            "image": null,
            "fileName": null,
            "dataType": "STRING",
            "aggregatable": true,
            "contextId": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "units": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "labels": null,
            "defaultUnit": {
              "symbol": null,
              "precision": null,
              "readingTypeId": null,
              "inUse": true,
              "context": {
                "generallyAvailable": true,
                "name": null,
                "active": true,
                "id": null
              },
              "id": null,
              "system": "SI",
              "name": null,
              "guid": null,
              "readingTypeName": null
            },
            "size": null,
            "inUse": true,
            "name": null,
            "id": null
          }
        },
        "attributes": {
          "valueValidationRegex": null,
          "defaultValue": null,
          "options": null,
          "name": null,
          "id": null,
          "type": "STRING",
          "required": true
        },
        "id": null
      },
      "path": null,
      "originId": null,
      "id": null,
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "contextId": null,
      "creationDate": null,
      "parentId": null,
      "originType": null,
      "lastUpdate": null,
      "roleName": null,
      "name": null,
      "guid": null,
      "location": {
        "latitude": null,
        "longitude": null
      },
      "status": "NORMAL"
    },
    "sourceStatus": "ACTIVE",
    "originType": null,
    "path": null,
    "alarmState": "ERROR",
    "originId": null,
    "sourceType": null,
    "lastUpdate": null,
    "name": null,
    "id": null,
    "value": null,
    "status": "NORMAL"
  }
}

Properties

Name	Type	Required	Restrictions	Description
route	Route	false	none	none
alarm	Alarm	false	none	none

AssetCreationRules

{
  "publicDeviceTemplateCreation": true,
  "publicRuleCreation": true,
  "publicReportCreation": true,
  "publicDeviceCreation": true,
  "publicCalculationCreation": true,
  "publicPointCreation": true,
  "publicDashboardCreation": true,
  "publicPointTemplateCreation": true
}

Properties

Name	Type	Required	Restrictions	Description
publicDeviceTemplateCreation	boolean	false	none	none
publicRuleCreation	boolean	false	none	none
publicReportCreation	boolean	false	none	none
publicDeviceCreation	boolean	false	none	none
publicCalculationCreation	boolean	false	none	none
publicPointCreation	boolean	false	none	none
publicDashboardCreation	boolean	false	none	none
publicPointTemplateCreation	boolean	false	none	none

AssetPermission

{
  "permissionString": null,
  "feature": null,
  "module": null,
  "permission": null,
  "id": null
}

Properties

Name	Type	Required	Restrictions	Description
permissionString	String	false	none	none
feature	String	false	Size (0, 32)	none
module	String	false	Size (0, 32)	none
permission	String	false	Size (0, 32)	none
id	long	false	none	Unique identifier per entity class.

AssetRole

{
  "permissions": {
    "permissionString": null,
    "feature": null,
    "module": null,
    "permission": null,
    "id": null
  },
  "name": null,
  "description": null,
  "id": null,
  "roleType": "SYSTEM"
}

Properties

Name	Type	Required	Restrictions	Description
permissions	AssetPermission	false	none	none
name	String	false	Size (0, 127)	Name of the entity.
description	String	false	Size (0, 512)	none
id	long	false	none	Unique identifier per entity class.
roleType	string	false	Access READ_ONLY	none

Enumerated Values

Property	Value
roleType	SYSTEM
roleType	USER

AssetRoleDto

{
  "permissionTree": {
    "modules": {
      "children": {
        "children": {
          "name": null,
          "fullName": null,
          "selected": true
        },
        "name": null,
        "fullName": null
      },
      "name": null,
      "fullName": null
    }
  },
  "inUse": true,
  "name": null,
  "description": null,
  "permissionList": {
    "permissionString": null,
    "feature": null,
    "module": null,
    "permission": null,
    "id": null
  },
  "id": null,
  "roleType": "SYSTEM"
}

Properties

Name	Type	Required	Restrictions	Description
permissionTree	PermissionTree	false	none	none
inUse	boolean	false	none	none
name	String	false	none	none
description	String	false	none	none
permissionList	AssetPermission	false	none	none
id	long	false	none	none
roleType	string	false	none	none

Enumerated Values

Property	Value
roleType	SYSTEM
roleType	USER

AttributeLocationDto

{
  "path": null,
  "name": null,
  "id": null,
  "type": "STRING",
  "value": null
}

Properties

Name	Type	Required	Restrictions	Description
path	String	false	none	none
name	String	false	none	none
id	long	false	none	none
type	string	false	none	none
value	String	false	none	none

Enumerated Values

Property	Value
type	STRING
type	NUMERIC
type	BOOLEAN
type	LOCATION
type	HEXADECIMAL
type	ENUM

AttributeManifest

{
  "system": true,
  "defaultValue": null,
  "options": null,
  "name": null,
  "maxSize": null,
  "minSize": null,
  "readOnly": true,
  "id": null,
  "type": "STRING",
  "validationRegex": null,
  "required": true
}

Properties

Name	Type	Required	Restrictions	Description
system	boolean	false	none	none
defaultValue	String	false	Size (0, 255)	none
options	String	false	none	none
name	String	false	Size (0, 127)	Name of the entity.
maxSize	Integer	false	none	none
minSize	Integer	false	none	none
readOnly	boolean	false	none	none
id	long	false	none	Unique identifier per entity class.
type	string	true	none	none
validationRegex	String	false	none	none
required	boolean	false	none	none

Enumerated Values

Property	Value
type	STRING
type	NUMERIC
type	BOOLEAN
type	LOCATION
type	HEXADECIMAL
type	ENUM

AttributeManifestDto

{
  "system": true,
  "defaultValue": null,
  "dataType": "STRING",
  "options": null,
  "name": null,
  "maxSize": null,
  "minSize": null,
  "readOnly": true,
  "validationRegex": null,
  "required": true
}

Properties

Name	Type	Required	Restrictions	Description
system	boolean	false	none	none
defaultValue	String	false	none	none
dataType	string	false	none	none
options	String	false	none	none
name	String	false	none	none
maxSize	Integer	false	none	none
minSize	Integer	false	none	none
readOnly	boolean	false	none	none
validationRegex	String	false	none	none
required	boolean	false	none	none

Enumerated Values

Property	Value
dataType	STRING
dataType	NUMERIC
dataType	BOOLEAN
dataType	LOCATION
dataType	HEXADECIMAL
dataType	ENUM

AttributeMappingCreateDto

{
  "deviceAttributeName": null,
  "attributeName": null
}

Properties

Name	Type	Required	Restrictions	Description
deviceAttributeName	String	true	none	none
attributeName	String	true	none	none

AttributeMappingListDto

{
  "mappingId": null,
  "attributeId": null,
  "deviceAttributeName": null,
  "deviceAttributeId": null,
  "attributeName": null,
  "id": null
}

Properties

Name	Type	Required	Restrictions	Description
mappingId	long	false	none	none
attributeId	long	false	none	none
deviceAttributeName	String	false	none	none
deviceAttributeId	long	false	none	none
attributeName	String	false	none	none
id	long	false	none	none

AuditLogEntry

{
  "contextId": null,
  "message": null,
  "timestamp": null
}

Properties

Name	Type	Required	Restrictions	Description
contextId	long	false	none	none
message	String	false	none	none
timestamp	long	false	none	none

Authority

{
  "role": {
    "permissions": {
      "permissionString": null,
      "feature": null,
      "module": null,
      "permission": null,
      "id": null
    },
    "name": null,
    "description": null,
    "id": null,
    "roleType": "SYSTEM"
  },
  "context": {
    "generallyAvailable": true,
    "name": null,
    "active": true,
    "id": null
  },
  "active": true,
  "id": null,
  "user": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
role	GlobalRole	false	none	none
context	Context	false	none	none
active	boolean	false	none	none
id	long	false	none	Unique identifier per entity class.
user	User	false	none	none

Brand

{
  "images": {
    "toolbarLogoImage": null,
    "favicon": null,
    "logoImageBlack": null,
    "loginLogoImage": null
  },
  "name": null,
  "theme": {
    "warningColor": null,
    "offlineWidgetTextColor": null,
    "accentColor": null,
    "offlineColor": null,
    "lightTint": true,
    "primaryLight": null,
    "primaryDark": null,
    "alarmWidgetTextColor": null,
    "normalStatusColor": null,
    "normalStatusTextColor": null,
    "alarmColor": null,
    "warningWidgetTextColor": null,
    "primary": null
  },
  "contextId": {
    "generallyAvailable": true,
    "name": null,
    "active": true,
    "id": null
  },
  "webClientSettings": null,
  "id": null,
  "mobileClientSettings": null
}

Properties

Name	Type	Required	Restrictions	Description
images	Images	false	none	none
name	String	false	Size (0, 127)	Name of the entity.
theme	Theme	false	none	none
contextId	Context	false	Access READ_ONLY EntityToIdSerializer will serialize to a long number, that is ID of the entity.	none
webClientSettings	Map	false	none	none
id	long	false	none	Unique identifier per entity class.
mobileClientSettings	Map	false	none	none

BulkDeviceGroupDto

{
  "deviceIds": null,
  "groupIds": null
}

Properties

Name	Type	Required	Restrictions	Description
deviceIds	Long	true	none	none
groupIds	Long	true	none	none

BulkUserGroupDto

{
  "groupIds": null,
  "userIds": null
}

Properties

Name	Type	Required	Restrictions	Description
groupIds	Long	true	none	none
userIds	Long	true	none	none

ByteArrayResource

{
  "readable": true,
  "filename": null,
  "file": null,
  "byteArray": [
    {}
  ],
  "description": null,
  "inputStream": null,
  "uRI": null,
  "uRL": null,
  "open": true
}

Properties

Name	Type	Required	Restrictions	Description
readable	boolean	false	none	none
filename	String	false	none	none
file	File	false	none	none
byteArray	[byteArray]	false	none	none
description	String	false	none	none
inputStream	InputStream	false	none	none
uRI	URI	false	none	none
uRL	URL	false	none	none
open	boolean	false	none	none

Calculation

{
  "creator": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "inputs": {
    "reference": null,
    "valid": true,
    "sourceId": null,
    "sourceType": null,
    "lastUpdate": null,
    "sourceName": null,
    "validity": null,
    "id": null,
    "value": null,
    "sourcePath": null
  },
  "creatorName": null,
  "contextId": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "originType": null,
  "path": null,
  "unit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "originId": null,
  "lastUpdate": null,
  "roleName": null,
  "name": null,
  "maximum": null,
  "formula": null,
  "validity": null,
  "id": null,
  "minimum": null,
  "initialValue": null,
  "value": null
}

Properties

Name	Type	Required	Restrictions	Description
creator	User	false	Access READ_ONLY	Read only info about the creator.
inputs	CalculationInput	false	none	none
creatorName	String	false	none	Name of initial asset creator. This field will not change if ownership is changed.
contextId	long	false	none	Context id that this entity belongs to.
readingType	ReadingType	false	Access READ_ONLY ReadingTypeSerializer will serialize to { "id" : 0, "name" : value, "dataType" : value, "size" : 0, "lablels" : [], "iconName" : value }	none
originType	String	false	none	none
path	String	false	none	none
unit	Unit	true	UnitDeserializer can deserialize using several different json values and in this order: 1) { "guid" : "value"} 2) { "symbol" : "value", "readingTypeName" : "reading type name" } 3) { "id" : 0 } 4) { "symbol" : "value", "readingType" : "reading type name" } NOTE: both readingTypeName and readingType are the name of the reading type. Symbol can have null value.	none
originId	long	false	none	none
lastUpdate	ZonedDateTime	false	Access READ_ONLY	none
roleName	String	false	Access READ_ONLY	Transient and read only role name of the creator.
name	String	false	Size (0, 127)	Name of the entity.
maximum	BigDecimal	false	Integer 16 Fraction 10	none
formula	String	false	Size (0, 1024)	none
validity	Integer	false	none	none
id	long	false	none	Unique identifier per entity class.
minimum	BigDecimal	false	Integer 16 Fraction 10	none
initialValue	String	false	Size (0, 255)	none
value	String	false	Size (0, 255) Access READ_ONLY	none

CalculationInput

{
  "reference": null,
  "valid": true,
  "sourceId": null,
  "sourceType": null,
  "lastUpdate": null,
  "sourceName": null,
  "validity": null,
  "id": null,
  "value": null,
  "sourcePath": null
}

Properties

Name	Type	Required	Restrictions	Description
reference	String	true	Size (0, 64)	none
valid	boolean	false	none	none
sourceId	Long	false	none	none
sourceType	String	false	Size (0, 63)	none
lastUpdate	ZonedDateTime	false	Access READ_ONLY	none
sourceName	String	false	none	none
validity	int	false	Min 0	none
id	long	false	none	Unique identifier per entity class.
value	String	false	Size (0, 255)	none
sourcePath	String	false	none	none

ChangePasswordRequest

{
  "oldPassword": null,
  "newPassword": null,
  "username": null
}

Properties

Name	Type	Required	Restrictions	Description
oldPassword	String	true	Size (6, 32)	none
newPassword	String	true	Size (6, 32)	none
username	String	false	none	none

Channel

{
  "name": null,
  "description": null,
  "id": null,
  "type": null,
  "parameters": null
}

Properties

Name	Type	Required	Restrictions	Description
name	String	false	Size (0, 127)	Name of the entity.
description	String	false	none	none
id	long	false	none	Unique identifier per entity class.
type	String	true	Size (0, 64)	none
parameters	Map	false	none	none

ChannelType

{
  "name": null,
  "properties": {
    "regex": null,
    "name": null,
    "required": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	String	false	none	none
properties	ChannelTypeProperty	false	none	none

ChannelTypeProperty

{
  "regex": null,
  "name": null,
  "required": true
}

Properties

Name	Type	Required	Restrictions	Description
regex	String	false	none	none
name	String	false	none	none
required	boolean	false	none	none

CommandStatus

null

Properties

None

ConfigManifest

{
  "reference": null,
  "size": null,
  "defaultValue": null,
  "dataType": "STRING",
  "name": null,
  "maximum": null,
  "description": null,
  "id": null,
  "minimum": null,
  "nullValue": null,
  "labels": null
}

Properties

Name	Type	Required	Restrictions	Description
reference	String	true	Size (0, 64)	none
size	int	false	Min 1 Max 3	none
defaultValue	String	true	Size (0, 255)	none
dataType	string	true	none	none
name	String	false	Size (0, 127)	Name of the entity.
maximum	BigDecimal	false	Integer 10 Fraction 10	none
description	String	false	Size (0, 255)	none
id	long	false	none	Unique identifier per entity class.
minimum	BigDecimal	false	Integer 10 Fraction 10	none
nullValue	String	false	Size (0, 255)	none
labels	String	false	none	none

Enumerated Values

Property	Value
dataType	STRING
dataType	NUMERIC
dataType	BOOLEAN
dataType	LOCATION
dataType	HEXADECIMAL
dataType	ENUM

ConfigManifestDto

{
  "reference": null,
  "size": null,
  "defaultValue": null,
  "dataType": "STRING",
  "name": null,
  "maximum": null,
  "description": null,
  "minimum": null,
  "labels": null
}

Properties

Name	Type	Required	Restrictions	Description
reference	String	false	none	none
size	int	false	none	none
defaultValue	String	false	none	none
dataType	string	false	none	none
name	String	false	none	none
maximum	BigDecimal	false	none	none
description	String	false	none	none
minimum	BigDecimal	false	none	none
labels	String	false	none	none

Enumerated Values

Property	Value
dataType	STRING
dataType	NUMERIC
dataType	BOOLEAN
dataType	LOCATION
dataType	HEXADECIMAL
dataType	ENUM

ConfigUpdateDto

{
  "configId": null,
  "value": null
}

Properties

Name	Type	Required	Restrictions	Description
configId	long	false	none	none
value	String	false	none	none

ConnectionState

null

Properties

None

ConnectionStateLong

{
  "map": null
}

Properties

Name	Type	Required	Restrictions	Description
map		false	none	none

ContentDisposition

{
  "charset": null,
  "modificationDate": null,
  "filename": null,
  "size": null,
  "readDate": null,
  "name": null,
  "creationDate": null,
  "type": null
}

Properties

Name	Type	Required	Restrictions	Description
charset	Charset	false	none	none
modificationDate	ZonedDateTime	false	none	none
filename	String	false	none	none
size	Long	false	none	none
readDate	ZonedDateTime	false	none	none
name	String	false	none	none
creationDate	ZonedDateTime	false	none	none
type	String	false	none	none

Context

{
  "generallyAvailable": true,
  "name": null,
  "active": true,
  "id": null
}

Properties

Name	Type	Required	Restrictions	Description
generallyAvailable	boolean	false	none	none
name	String	false	Size (0, 127)	Name of the entity.
active	boolean	false	none	none
id	long	false	none	Unique identifier per entity class.

ContextProperties

{
  "maxUsers": null,
  "maxDashboards": null,
  "defaultTimeZone": null,
  "defaultRole": {
    "permissions": {
      "permissionString": null,
      "feature": null,
      "module": null,
      "permission": null,
      "id": null
    },
    "name": null,
    "description": null,
    "id": null,
    "roleType": "SYSTEM"
  },
  "maxDevices": null,
  "defaultContextLocale": null,
  "context": {
    "generallyAvailable": true,
    "name": null,
    "active": true,
    "id": null
  },
  "assetCreationRules": {
    "publicDeviceTemplateCreation": true,
    "publicRuleCreation": true,
    "publicReportCreation": true,
    "publicDeviceCreation": true,
    "publicCalculationCreation": true,
    "publicPointCreation": true,
    "publicDashboardCreation": true,
    "publicPointTemplateCreation": true
  },
  "id": null,
  "maxReports": null,
  "maxRules": null
}

Properties

Name	Type	Required	Restrictions	Description
maxUsers	Long	false	none	none
maxDashboards	Long	false	none	none
defaultTimeZone	String	false	none	none
defaultRole	GlobalRole	false	none	none
maxDevices	Long	false	none	none
defaultContextLocale	String	false	none	none
context	Context	false	none	none
assetCreationRules	AssetCreationRules	false	none	none
id	long	false	none	Unique identifier per entity class.
maxReports	Long	false	none	none
maxRules	Long	false	none	none

Conversion

{
  "formula": null,
  "toUnit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  },
  "id": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "units": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "labels": null,
    "defaultUnit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "fromUnit": {
    "symbol": null,
    "precision": null,
    "readingTypeId": null,
    "inUse": true,
    "context": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "system": "SI",
    "name": null,
    "guid": null,
    "readingTypeName": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
formula	String	true	Size (0, 1024)	none
toUnit	Unit	true	none	none
id	long	false	none	Unique identifier per entity class.
readingType	ReadingType	false	Access READ_ONLY NamedEntitySerializer will serialize to { "id" : Number, "name" : String }	none
fromUnit	Unit	true	none	none

ConversionValidateDto

{
  "input": null,
  "formula": null
}

Properties

Name	Type	Required	Restrictions	Description
input	String	true	none	none
formula	String	true	none	none

CountDto

{
  "count": null
}

Properties

Name	Type	Required	Restrictions	Description
count	long	false	none	none

CreateDeviceGroupDto

{
  "deviceIds": null,
  "name": null
}

Properties

Name	Type	Required	Restrictions	Description
deviceIds	Long	false	none	Array of existing devices ids.
name	String	true	none	Name of the group that will be created.

Dashboard

{
  "shared": true,
  "creator": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "backgroundImage": null,
  "creatorName": null,
  "contextId": null,
  "creationDate": null,
  "widgets": {
    "col": null,
    "sizeX": null,
    "mobileReady": true,
    "name": null,
    "extras": null,
    "row": null,
    "id": null,
    "type": null,
    "items": {
      "sourceId": null,
      "position": null,
      "id": null,
      "type": null
    },
    "sizeY": null
  },
  "type": "USER_DEFINED",
  "originType": null,
  "path": null,
  "originId": null,
  "scope": {
    "metadata": {
      "contextId": null,
      "creationDate": null,
      "type": "STRING",
      "required": true,
      "reference": null,
      "originType": null,
      "path": null,
      "originId": null,
      "valueValidationRegex": null,
      "lastUpdate": null,
      "options": null,
      "name": null,
      "id": null,
      "value": null
    },
    "creatorName": null,
    "pathId": null,
    "type": null,
    "templateId": {
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "name": null,
        "id": null
      },
      "creatorName": null,
      "description": null,
      "contextId": null,
      "originType": null,
      "path": null,
      "actuators": {
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "maximum": null,
        "id": null,
        "minimum": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "originId": null,
      "inUse": true,
      "roleName": null,
      "name": null,
      "guid": null,
      "feeds": {
        "unit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "name": null,
        "id": null,
        "readingType": {
          "trending": true,
          "image": null,
          "fileName": null,
          "dataType": "STRING",
          "aggregatable": true,
          "contextId": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "units": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "labels": null,
          "defaultUnit": {
            "symbol": null,
            "precision": null,
            "readingTypeId": null,
            "inUse": true,
            "context": {
              "generallyAvailable": true,
              "name": null,
              "active": true,
              "id": null
            },
            "id": null,
            "system": "SI",
            "name": null,
            "guid": null,
            "readingTypeName": null
          },
          "size": null,
          "inUse": true,
          "name": null,
          "id": null
        }
      },
      "attributes": {
        "valueValidationRegex": null,
        "defaultValue": null,
        "options": null,
        "name": null,
        "id": null,
        "type": "STRING",
        "required": true
      },
      "id": null
    },
    "path": null,
    "originId": null,
    "id": null,
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "contextId": null,
    "creationDate": null,
    "parentId": null,
    "originType": null,
    "lastUpdate": null,
    "roleName": null,
    "name": null,
    "guid": null,
    "location": {
      "latitude": null,
      "longitude": null
    },
    "status": "NORMAL"
  },
  "name": null,
  "id": null
}

Properties

Name	Type	Required	Restrictions	Description
shared	boolean	false	none	none
creator	User	false	Access READ_ONLY	Read only info about the creator.
backgroundImage	String	false	Size (0, 255)	none
creatorName	String	false	none	Name of initial asset creator. This field will not change if ownership is changed.
contextId	long	false	none	Context id that this entity belongs to.
creationDate	ZonedDateTime	false	Access READ_ONLY ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.	none
widgets	Widget	false	none	none
type	string	false	Access READ_ONLY	none
originType	String	false	none	none
path	String	false	none	none
originId	long	false	none	none
scope	Point	true	EntityToIdSerializer will serialize to a long number, that is ID of the entity.	Id of the semantic that is covered by this dashboard.
name	String	false	Size (0, 127)	Name of the entity.
id	long	false	none	Unique identifier per entity class.

Enumerated Values

Property	Value
type	USER_DEFINED
type	GENERATED

DashboardCreationDto

{
  "shared": true,
  "scopeId": null,
  "backgroundImage": null,
  "name": null,
  "favorite": true
}

Properties

Name	Type	Required	Restrictions	Description
shared	boolean	false	none	none
scopeId	long	true	none	none
backgroundImage	String	false	Size (0, 255)	none
name	String	false	Size (0, 255)	none
favorite	boolean	false	none	none

DashboardDto

{
  "shared": true,
  "creator": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "backgroundImage": null,
  "creatorName": null,
  "creationDate": null,
  "widgets": {
    "col": null,
    "sizeX": null,
    "mobileReady": true,
    "name": null,
    "extras": null,
    "row": null,
    "id": null,
    "type": null,
    "items": {
      "sourceId": null,
      "position": null,
      "id": null,
      "type": null
    },
    "sizeY": null
  },
  "message": null,
  "type": "USER_DEFINED",
  "originType": null,
  "path": null,
  "originId": null,
  "scope": {
    "path": null,
    "name": null,
    "id": null
  },
  "name": null,
  "id": null,
  "favorite": true
}

Properties

Name	Type	Required	Restrictions	Description
shared	boolean	false	none	none
creator	User	false	none	none
backgroundImage	String	false	Size (0, 255)	none
creatorName	String	false	none	none
creationDate	ZonedDateTime	false	none	none
widgets	Widget	false	none	none
message	String	false	none	none
type	string	false	none	none
originType	String	false	none	none
path	String	false	none	none
originId	long	false	none	none
scope	DashboardScopeDto	false	none	none
name	String	false	none	none
id	long	false	none	none
favorite	boolean	false	none	none

Enumerated Values

Property	Value
type	USER_DEFINED
type	GENERATED

DashboardScopeDto

{
  "path": null,
  "name": null,
  "id": null
}

Properties

Name	Type	Required	Restrictions	Description
path	String	false	none	none
name	String	false	none	none
id	long	false	none	none

DashboardUpdateDto

{
  "shared": true,
  "backgroundImage": null,
  "name": null,
  "favorite": true
}

Properties

Name	Type	Required	Restrictions	Description
shared	boolean	false	none	none
backgroundImage	String	false	Size (0, 255)	none
name	String	false	Size (0, 255)	none
favorite	boolean	false	none	none

DataExportParameters

{
  "taskType": null,
  "factExportPeriodStart": null,
  "dimensionExportType": "ALL",
  "dataFormat": null,
  "factExportPeriodEnd": null,
  "factExportPeriod": null,
  "factExportType": "SNAPSHOT_ALL",
  "locale": null,
  "tasks": {
    "whatIsKnown": {
      "idPath": null,
      "attributeValues": null,
      "id": null
    },
    "id": null,
    "type": null,
    "whatIsNeeded": {
      "feedNames": null,
      "attributes": null,
      "eventTypes": null
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
taskType	String	false	none	none
factExportPeriodStart	ZonedDateTime	false	ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds. ZonedDateTimeDeserializer	none
dimensionExportType	string	false	none	none
dataFormat	String	false	none	none
factExportPeriodEnd	ZonedDateTime	false	ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds. ZonedDateTimeDeserializer	none
factExportPeriod	Integer	false	none	none
factExportType	string	false	none	none
locale	String	false	none	none
tasks	DataSet	false	none	none

Enumerated Values

Property	Value
dimensionExportType	ALL
dimensionExportType	DELTA
factExportType	SNAPSHOT_ALL
factExportType	SNAPSHOT_DELTA
factExportType	TIME_SERIES

DataSet

{
  "whatIsKnown": {
    "idPath": null,
    "attributeValues": null,
    "id": null
  },
  "id": null,
  "type": null,
  "whatIsNeeded": {
    "feedNames": null,
    "attributes": null,
    "eventTypes": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
whatIsKnown	SemanticFilter	false	none	none
id	String	false	none	none
type	String	false	none	none
whatIsNeeded	ExportSpecification	false	none	none

DataSnapshot

{
  "reports": {
    "path": null,
    "unit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "thresholds": {
      "start": null,
      "end": null,
      "state": "ERROR",
      "message": null
    },
    "min": {
      "values": null,
      "time": null
    },
    "readings": {
      "values": null,
      "time": null
    },
    "max": {
      "values": null,
      "time": null
    },
    "feedId": null,
    "name": null,
    "messages": {
      "sourceId": null,
      "severity": null,
      "path": null,
      "read": null,
      "data": null,
      "sourceType": null,
      "description": null,
      "contextId": null,
      "type": null,
      "userId": null,
      "timestamp": null
    },
    "readingType": {
      "trending": true,
      "image": null,
      "fileName": null,
      "dataType": "STRING",
      "aggregatable": true,
      "contextId": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "units": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "labels": null,
      "defaultUnit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "size": null,
      "inUse": true,
      "name": null,
      "id": null
    }
  },
  "interval": null
}

Properties

Name	Type	Required	Restrictions	Description
reports	FeedSnapshot	false	none	none
interval	long	false	none	none

DataType

null

Properties

None

DateTimeStyle

null

Properties

None

Device

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

Properties

Name	Type	Required	Restrictions	Description
configs	DeviceConfig	false	none	Array of configurations belonging to the device.
activationTimestamp	ZonedDateTime	true	none	Date and time when devices was created.
serviceStatuses	ServiceStatus	false	none	Holds info about firmware update.
lastReportTimestamp	ZonedDateTime	false	Access READ_ONLY	Date and time when devices last time recevived any data.
deviceAlarms	DeviceAlarm	false	none	Array of alarms belonging to the device.
creatorName	String	false	none	Name of initial asset creator. This field will not change if ownership is changed.
type	String	true	none	Device type is used when on create and on delete automated actions. Those actions can be defined only in java code.
path	String	false	none	none
password	String	false	none	Transient field, used only to provide raw password to used on device create.
protocol	String	true	Size (0, 64)	Defines what data protocol does this device uses to send and receive data. (defines format of data).
originId	long	false	none	none
id	long	false	none	Unique identifier per entity class.
attributesWithoutReadOnly	DeviceAttribute	false	none	none
deviceSensors	DeviceSensor	false	none	Array of sensors belonging to the device.
creator	User	false	Access READ_ONLY	Read only info about the creator.
connectionState	string	false	Access READ_ONLY	Holds info about device connection status.
manifest	DeviceManifest	false	NamedEntitySerializer will serialize to { "id" : Number, "name" : String }	none
deviceKey	String	true	Size (0, 128)	This key is unique in the system and it is used to identify the device.
contextId	long	false	none	Context id that this entity belongs to.
originType	String	false	none	none
roleName	String	false	Access READ_ONLY	Transient and read only role name of the creator.
name	String	false	Size (0, 127)	Name of the entity.
deviceActuators	DeviceActuator	false	none	Array of actuators belonging to the device.
attributes	DeviceAttribute	false	none	Array of attributes belonging to the device. They hold values that are specific for the device like MAC address etc and are user defined. They are linked to Device Variety.
parameters	DeviceParameter	false	none	Array of parameters belonging to the device. Those are linked to device, connection and firmware update type. They hold data that does not change after createion like connection parameters etc.

Enumerated Values

Property	Value
connectionState	CONNECTED
connectionState	OFFLINE
connectionState	DEACTIVATED
connectionState	SERVICE_MODE
connectionState	SLEEP

DeviceActuator

{
  "deviceKey": null,
  "description": null,
  "contextId": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable"