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

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

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

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

Base URLs:

Email: Wolkabout Web: Wolkabout

Authentication

cache-api

cache-api

clearAllUsingDELETE

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Description:
Clears all the cache.

Example responses

200 Response

Responses

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

reloadAllUsingPUT

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

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

Example responses

200 Response

Responses

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

clearUsingDELETE

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Description:
Clears the cache with given name.

Parameters

Parameter In Type Required Description
name path String true name

Example responses

200 Response

Responses

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

info-api

info-api

serverDetailsUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

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

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

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

const headers = {
  'Accept':'*/*'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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

}, headers = headers)

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() {

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

    }

    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:

Example responses

200 Response

Responses

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

listEventTypesByOriginUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

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

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

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

const headers = {
  'Accept':'*/*'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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

}, headers = headers)

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() {

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

    }

    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.

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

getLocalesUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

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

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

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

const headers = {
  'Accept':'*/*'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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

}, headers = headers)

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() {

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

    }

    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.

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
» anonymous any false none none

signupEnabledUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

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

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

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

const headers = {
  'Accept':'*/*'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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

}, headers = headers)

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() {

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

    }

    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:

Example responses

200 Response

Responses

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

getPlatformDetailsUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

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

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

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

const headers = {
  'Accept':'*/*'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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

}, headers = headers)

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() {

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

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Example responses

200 Response

Responses

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

listEventTypesUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

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

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

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

const headers = {
  'Accept':'*/*'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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

}, headers = headers)

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() {

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

    }

    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 String true originType

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
» anonymous any false none none

licence-api

licence-api

readUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Description:
Provides current licence information.

Example responses

200 Response

Responses

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

updateUsingPUT

Code samples

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

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

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

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

Body parameter

null

Parameters

Parameter In Type Required Description
body body String true key

Example responses

200 Response

Responses

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

log-api

log-api

getUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

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

Parameters

Parameter In Type Required Description
packageName path String true packageName

Example responses

200 Response

Responses

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

setUsingPUT

Code samples

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

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

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/logs/{packageName}',
  method: 'put',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api-demo.wolkabout.com/api/logs/{packageName}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api-demo.wolkabout.com/api/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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

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

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

PUT /api/logs/{packageName}

set

Permissions:
hasAuthority('PLATFORM_MANAGEMENT')

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

Body parameter

null

Parameters

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

Example responses

200 Response

Responses

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

platform-configuration-api

platform-configuration-api

setSelfRegistrationUsingPUT

Code samples

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

PUT https://api-demo.wolkabout.com/api/platformConfiguration/selfRegistration HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/platformConfiguration/selfRegistration',
  method: 'put',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api-demo.wolkabout.com/api/platformConfiguration/selfRegistration',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api-demo.wolkabout.com/api/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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

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

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

PUT /api/platformConfiguration/selfRegistration

setSelfRegistration

Permissions:
hasAuthority('PLATFORM_EDIT')

Body parameter

true

Parameters

Parameter In Type Required Description
body body boolean true selfRegistration

Example responses

200 Response

Responses

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

getPlatformSettingsUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Example responses

200 Response

Responses

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

setPlatformSettingsUsingPUT

Code samples

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

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

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

};

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "defaultRole": null,
  "multiTenancy": true,
  "defaultPlatformLocale": null,
  "feedValidity": null,
  "selfRegisterEnabled": true,
  "limits": {
    "maxDevicesPerTenant": null,
    "maxUsersPerTenant": null,
    "maxReportsPerTenant": null,
    "maxRulesPerTenant": null,
    "maxDashboardsPerTenant": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.put('https://api-demo.wolkabout.com/api/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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

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

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

PUT /api/platformConfiguration

setPlatformSettings

Permissions:
hasAuthority('PLATFORM_EDIT')

Body parameter

{
  "defaultRole": null,
  "multiTenancy": true,
  "defaultPlatformLocale": null,
  "feedValidity": null,
  "selfRegisterEnabled": true,
  "limits": {
    "maxDevicesPerTenant": null,
    "maxUsersPerTenant": null,
    "maxReportsPerTenant": null,
    "maxRulesPerTenant": null,
    "maxDashboardsPerTenant": null
  }
}

Parameters

Parameter In Type Required Description
body body PlatformSettingsDto true settingsDto

Example responses

200 Response

Responses

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

spam-control-api

spam-control-api

updateLimitUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/spam/limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

PUT https://api-demo.wolkabout.com/api/spam/limit HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api-demo.wolkabout.com/api/spam/limit',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body Integer true limit

Example responses

200 Response

Responses

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

addWhitelistReferenceItemUsingPOST

Code samples

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

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

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body addWhitelistReferenceItemUsingPOSTItem true item

Example responses

200 Response

Responses

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

listWhitelistReferenceItemUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Example responses

200 Response

Responses

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

removeWhitelistReferenceItemUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/spam/whitelistReferences \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

DELETE https://api-demo.wolkabout.com/api/spam/whitelistReferences HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body addWhitelistReferenceItemUsingPOSTItem true item

Example responses

200 Response

Responses

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

addWhitelistFullPathItemUsingPOST

Code samples

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

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

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body addWhitelistReferenceItemUsingPOSTItem true item

Example responses

200 Response

Responses

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

listWhitelistFullPathItemUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Example responses

200 Response

Responses

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

removeWhitelistFullPathItemUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/spam/whitelistFullpaths \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

DELETE https://api-demo.wolkabout.com/api/spam/whitelistFullpaths HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body addWhitelistReferenceItemUsingPOSTItem true item

Example responses

200 Response

Responses

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

addWhitelistDeviceItemUsingPOST

Code samples

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

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

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body addWhitelistReferenceItemUsingPOSTItem true item

Example responses

200 Response

Responses

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

listWhitelistDeviceItemUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Example responses

200 Response

Responses

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

removeWhitelistDeviceItemUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/spam/whitelistDevices \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

DELETE https://api-demo.wolkabout.com/api/spam/whitelistDevices HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body addWhitelistReferenceItemUsingPOSTItem true item

Example responses

200 Response

Responses

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

addBlacklistDeviceItemUsingPOST

Code samples

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

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

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body addWhitelistReferenceItemUsingPOSTItem true item

Example responses

200 Response

Responses

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

listBlacklistDeviceItemUsingGET

Code samples

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

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

var headers = {
  'Accept':'*/*'

};

$.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 = {
  'Accept':'*/*'

};

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 = {
  'Accept' => '*/*'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

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{
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Example responses

200 Response

Responses

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

removeBlacklistDeviceItemUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/spam/blacklistDevices \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

DELETE https://api-demo.wolkabout.com/api/spam/blacklistDevices HTTP/1.1
Host: api-demo.wolkabout.com
Content-Type: application/json
Accept: */*

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

};

$.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 inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},

    }

    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:
hasAuthority('PLATFORM_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
body body addWhitelistReferenceItemUsingPOSTItem true item

Example responses

200 Response

Responses

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

Schemas

Access

{
  "role": {
    "accessPermissions": {
      "special": true,
      "name": null,
      "implicitPermissions": null
    },
    "name": null,
    "description": null,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": null
    },
    "id": null,
    "roleType": "SYSTEM"
  },
  "context": {
    "generallyAvailable": true,
    "name": null,
    "active": true,
    "id": null
  },
  "accessToken": null,
  "tenantProperties": {
    "maxUsers": null,
    "maxDashboards": null,
    "defaultRole": {
      "accessPermissions": {
        "special": true,
        "name": null,
        "implicitPermissions": null
      },
      "name": null,
      "description": null,
      "contextId": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "roleType": "SYSTEM"
    },
    "maxDevices": null,
    "assetCreationRules": {
      "publicDeviceTemplateCreation": true,
      "publicRuleCreation": true,
      "publicReportCreation": true,
      "publicDeviceCreation": true,
      "publicCalculationCreation": true,
      "publicPointCreation": true,
      "publicDashboardCreation": true,
      "publicPointTemplateCreation": true
    },
    "maxReports": null,
    "maxRules": null
  }
}

Properties

Name Type Required Restrictions Description
role Role false none none
context Context false none none
accessToken String false none none
tenantProperties TenantPropertiesDto false none 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,
  "contextId": null,
  "alarmMessage": 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": {
      "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,
      "permission": "VIEW",
      "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,
    "actuators": null,
    "originId": null,
    "feeds": {
      "sourceId": null,
      "trend": "RISING",
      "pathId": 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": null,
      "path": null,
      "originId": null,
      "alarmState": "ERROR",
      "id": null,
      "value": null,
      "contextId": null,
      "alarmMessage": null,
      "creationDate": null,
      "message": null,
      "sourceStatus": "ACTIVE",
      "originType": 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
      },
      "sourceType": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "validity": null,
      "minimum": null,
      "thresholdsEnabled": true
    },
    "id": null,
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "alarms": {
      "sourceId": null,
      "contextId": null,
      "alarmMessage": null,
      "pathId": null,
      "creationDate": null,
      "message": null,
      "point": null,
      "sourceStatus": "ACTIVE",
      "originType": null,
      "path": null,
      "originId": null,
      "alarmState": "ERROR",
      "sourceType": null,
      "lastUpdate": null,
      "name": null,
      "id": null,
      "value": null,
      "status": "NORMAL"
    },
    "contextId": null,
    "permission": "VIEW",
    "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
  },
  "originId": null,
  "alarmState": "ERROR",
  "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
contextId long false Access READ_ONLY none
alarmMessage String 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
originId long false none none
alarmState string false Access READ_ONLY 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

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
state READY
state COMMANDED
state BUSY
state ERROR

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

ActuatorWithRoute

{
  "actuator": {
    "sourceId": null,
    "contextId": null,
    "alarmMessage": 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": {
        "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,
        "permission": "VIEW",
        "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,
      "actuators": null,
      "originId": null,
      "feeds": {
        "sourceId": null,
        "trend": "RISING",
        "pathId": 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": null,
        "path": null,
        "originId": null,
        "alarmState": "ERROR",
        "id": null,
        "value": null,
        "contextId": null,
        "alarmMessage": null,
        "creationDate": null,
        "message": null,
        "sourceStatus": "ACTIVE",
        "originType": 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
        },
        "sourceType": null,
        "lastUpdate": null,
        "name": null,
        "maximum": null,
        "validity": null,
        "minimum": null,
        "thresholdsEnabled": true
      },
      "id": null,
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": {
        "sourceId": null,
        "contextId": null,
        "alarmMessage": null,
        "pathId": null,
        "creationDate": null,
        "message": null,
        "point": null,
        "sourceStatus": "ACTIVE",
        "originType": null,
        "path": null,
        "originId": null,
        "alarmState": "ERROR",
        "sourceType": null,
        "lastUpdate": null,
        "name": null,
        "id": null,
        "value": null,
        "status": "NORMAL"
      },
      "contextId": null,
      "permission": "VIEW",
      "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
    },
    "originId": null,
    "alarmState": "ERROR",
    "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,
  "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
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,
  "contextId": null,
  "alarmMessage": null,
  "pathId": null,
  "creationDate": null,
  "message": null,
  "point": {
    "metadata": {
      "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,
      "permission": "VIEW",
      "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,
    "actuators": {
      "sourceId": null,
      "contextId": null,
      "alarmMessage": 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": 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,
      "alarmState": "ERROR",
      "sourceType": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "id": null,
      "state": "READY",
      "minimum": null,
      "value": null
    },
    "originId": null,
    "feeds": {
      "sourceId": null,
      "trend": "RISING",
      "pathId": 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": null,
      "path": null,
      "originId": null,
      "alarmState": "ERROR",
      "id": null,
      "value": null,
      "contextId": null,
      "alarmMessage": null,
      "creationDate": null,
      "message": null,
      "sourceStatus": "ACTIVE",
      "originType": 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
      },
      "sourceType": null,
      "lastUpdate": null,
      "name": null,
      "maximum": null,
      "validity": null,
      "minimum": null,
      "thresholdsEnabled": true
    },
    "id": null,
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "alarms": null,
    "contextId": null,
    "permission": "VIEW",
    "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,
  "originId": null,
  "alarmState": "ERROR",
  "sourceType": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "value": null,
  "status": "NORMAL"
}

Properties

Name Type Required Restrictions Description
sourceId Long false none none
contextId long false Access READ_ONLY none
alarmMessage String 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
originId long false none none
alarmState string false Access READ_ONLY 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

{
  "sourceId": null,
  "sourceStatus": "ACTIVE",
  "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
sourceId Long false none none
sourceStatus string 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

AlarmWithRoute

{
  "route": {
    "originType": null,
    "originId": null
  },
  "alarm": {
    "sourceId": null,
    "contextId": null,
    "alarmMessage": null,
    "pathId": null,
    "creationDate": null,
    "message": null,
    "point": {
      "metadata": {
        "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,
        "permission": "VIEW",
        "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,
      "actuators": {
        "sourceId": null,
        "contextId": null,
        "alarmMessage": 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": 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,
        "alarmState": "ERROR",
        "sourceType": null,
        "lastUpdate": null,
        "name": null,
        "maximum": null,
        "id": null,
        "state": "READY",
        "minimum": null,
        "value": null
      },
      "originId": null,
      "feeds": {
        "sourceId": null,
        "trend": "RISING",
        "pathId": 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": null,
        "path": null,
        "originId": null,
        "alarmState": "ERROR",
        "id": null,
        "value": null,
        "contextId": null,
        "alarmMessage": null,
        "creationDate": null,
        "message": null,
        "sourceStatus": "ACTIVE",
        "originType": 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
        },
        "sourceType": null,
        "lastUpdate": null,
        "name": null,
        "maximum": null,
        "validity": null,
        "minimum": null,
        "thresholdsEnabled": true
      },
      "id": null,
      "creator": {
        "firstName": null,
        "lastName": null,
        "verified": true,
        "id": null,
        "email": null
      },
      "alarms": null,
      "contextId": null,
      "permission": "VIEW",
      "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,
    "originId": null,
    "alarmState": "ERROR",
    "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

AssetDto

{
  "assetId": null,
  "error": null,
  "asset": null,
  "assetType": null
}

Properties

Name Type Required Restrictions Description
assetId long false none none
error String false Access READ_ONLY none
asset Object false Access READ_ONLY none
assetType String false none none

AssetPermission

null

Properties

None

AttributeManifest

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

Properties

Name Type Required Restrictions Description
defaultValue String false Size (0, 255) none
options String false none none
name String false Size (0, 127) Name of the entity.
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 INTEGER
type BOOLEAN
type LOCATION
type HEXADECIMAL
type ENUM

AttributeManifestDto

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

Properties

Name Type Required Restrictions Description
defaultValue String false none none
dataType string false none none
options String false none none
name String 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 INTEGER
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

Authority

{
  "role": {
    "accessPermissions": {
      "special": true,
      "name": null,
      "implicitPermissions": null
    },
    "name": null,
    "description": null,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": 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 Role 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,
    "sourceId": null,
    "sourceType": null,
    "lastUpdate": null,
    "sourceName": null,
    "validity": null,
    "id": null,
    "value": null,
    "sourcePath": null
  },
  "creatorName": null,
  "contextId": null,
  "permission": "VIEW",
  "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.
permission string false Access READ_ONLY Permissions for the asset granted to the user making the request.
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

Enumerated Values

Property Value
permission VIEW
permission MODIFY

CalculationInput

{
  "reference": null,
  "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
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

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 INTEGER
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 INTEGER
dataType BOOLEAN
dataType LOCATION
dataType HEXADECIMAL
dataType ENUM

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,
  "defaultRole": {
    "accessPermissions": {
      "special": true,
      "name": null,
      "implicitPermissions": null
    },
    "name": null,
    "description": null,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": true,
      "id": 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
defaultRole Role false none none
maxDevices Long false none none
defaultContextLocale String true 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

{
  "creator": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "creatorName": null,
  "contextId": null,
  "permission": "VIEW",
  "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,
  "roleName": null,
  "name": null,
  "id": null
}

Properties

Name Type Required Restrictions Description
creator User false Access READ_ONLY Read only info about the creator.
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.
permission string false Access READ_ONLY Permissions for the asset granted to the user making the request.
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
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.
id long false none Unique identifier per entity class.

Enumerated Values

Property Value
permission VIEW
permission MODIFY
type USER_DEFINED
type GENERATED

DataExportParameters

{
  "taskType": null,
  "factExportPeriodStart": null,
  "dimensionExportType": "ALL",
  "factExportPeriodEnd": null,
  "dataFormat": 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
factExportPeriodEnd ZonedDateTime false ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.
ZonedDateTimeDeserializer
none
dataFormat String false none 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,
    "thresholds": {
      "start": null,
      "end": null,
      "state": "ERROR",
      "message": 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
    },
    "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",
    "description": null,
    "deviceKey": null,
    "contextId": null,
    "deviceName": null,
    "labels": null,
    "reference": null,
    "connected": true,
    "originType": null,
    "path": null,
    "originId": null,
    "size": null,
    "lastUpdate": null,
    "name": null,
    "maximum": null,
    "id": null,
    "minimum": null,
    "device": null,
    "value": null,
    "status": "READY"
  },
  "activationTimestamp": null,
  "serviceStatuses": {
    "extras": null,
    "id": null,
    "error": null,
    "type": null,
    "timestamp": null,
    "status": null
  },
  "lastReportTimestamp": null,
  "deviceAlarms": {
    "description": null,
    "deviceKey": null,
    "contextId": null,
    "message": null,
    "deviceName": null,
    "reference": null,
    "connected": true,
    "originType": null,
    "path": null,
    "originId": null,
    "lastUpdate": null,
    "name": null,
    "id": null,
    "device": null,
    "value": null,
    "status": "NORMAL"
  },
  "creatorName": null,
  "type": null,
  "path": null,
  "password": null,
  "protocol": null,
  "originId": null,
  "id": null,
  "attributesWithoutReadOnly": {
    "deviceKey": null,
    "contextId": null,
    "readOnly": true,
    "creationDate": null,
    "type": "STRING",
    "required": true,
    "originType": null,
    "path": null,
    "originId": null,
    "lastUpdate": null,
    "options": null,
    "name": null,
    "id": null,
    "validationRegex": null,
    "value": null
  },
  "deviceSensors": {
    "description": null,
    "deviceKey": null,
    "contextId": null,
    "readingType": {
      "trending": true,
      "image": null,
      "fileName": null,
      "dataType": "STRING",
      "aggregatable": true,
      "contextId": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "units": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "labels": null,
      "defaultUnit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "size": null,
      "inUse": true,
      "name": null,
      "id": null
    },
    "deviceName": null,
    "reference": null,
    "connected": true,
    "originType": null,
    "path": null,
    "unit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "originId": null,
    "lastUpdate": null,
    "name": null,
    "maximum": null,
    "id": null,
    "minimum": null,
    "device": null,
    "value": null
  },
  "creator": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "connectionState": "CONNECTED",
  "manifest": {
    "deviceType": null,
    "generallyAvailable": true,
    "configs": {
      "reference": null,
      "size": null,
      "defaultValue": null,
      "dataType": "STRING",
      "name": null,
      "maximum": null,
      "description": null,
      "id": null,
      "minimum": null,
      "nullValue": null,
      "labels": null
    },
    "creator": {
      "firstName": null,
      "lastName": null,
      "verified": true,
      "id": null,
      "email": null
    },
    "alarms": {
      "reference": null,
      "name": null,
      "description": null,
      "id": null,
      "message": null
    },
    "creatorName": null,
    "description": null,
    "contextId": null,
    "permission": "VIEW",
    "published": true,
    "originType": null,
    "path": null,
    "protocol": null,
    "actuators": {
      "reference": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "name": null,
      "maximum": null,
      "description": null,
      "id": null,
      "minimum": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      }
    },
    "originId": null,
    "inUse": true,
    "roleName": null,
    "name": null,
    "guid": null,
    "feeds": {
      "reference": null,
      "unit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "name": null,
      "maximum": null,
      "description": null,
      "id": null,
      "minimum": null,
      "readingType": {
        "trending": true,
        "image": null,
        "fileName": null,
        "dataType": "STRING",
        "aggregatable": true,
        "contextId": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "units": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "labels": null,
        "defaultUnit": {
          "symbol": null,
          "precision": null,
          "readingTypeId": null,
          "inUse": true,
          "context": {
            "generallyAvailable": true,
            "name": null,
            "active": true,
            "id": null
          },
          "id": null,
          "system": "SI",
          "name": null,
          "guid": null,
          "readingTypeName": null
        },
        "size": null,
        "inUse": true,
        "name": null,
        "id": null
      }
    },
    "attributes": {
      "defaultValue": null,
      "options": null,
      "name": null,
      "readOnly": true,
      "id": null,
      "type": "STRING",
      "validationRegex": null,
      "required": true
    },
    "id": null
  },
  "deviceKey": null,
  "contextId": null,
  "permission": "VIEW",
  "originType": null,
  "roleName": null,
  "name": null,
  "deviceActuators": {
    "description": null,
    "deviceKey": null,
    "contextId": null,
    "readingType": {
      "trending": true,
      "image": null,
      "fileName": null,
      "dataType": "STRING",
      "aggregatable": true,
      "contextId": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "units": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "labels": null,
      "defaultUnit": {
        "symbol": null,
        "precision": null,
        "readingTypeId": null,
        "inUse": true,
        "context": {
          "generallyAvailable": true,
          "name": null,
          "active": true,
          "id": null
        },
        "id": null,
        "system": "SI",
        "name": null,
        "guid": null,
        "readingTypeName": null
      },
      "size": null,
      "inUse": true,
      "name": null,
      "id": null
    },
    "deviceName": null,
    "reference": null,
    "connected": true,
    "originType": null,
    "path": null,
    "unit": {
      "symbol": null,
      "precision": null,
      "readingTypeId": null,
      "inUse": true,
      "context": {
        "generallyAvailable": true,
        "name": null,
        "active": true,
        "id": null
      },
      "id": null,
      "system": "SI",
      "name": null,
      "guid": null,
      "readingTypeName": null
    },
    "originId": null,
    "lastUpdate": null,
    "name": null,
    "maximum": null,
    "id": null,
    "state": "READY",
    "minimum": null,
    "device": null,
    "value": null
  },
  "attributes": {
    "deviceKey": null,
    "contextId": null,
    "readOnly": true,
    "creationDate": null,
    "type": "STRING",
    "required": true,
    "originType": null,
    "path": null,
    "originId": null,
    "lastUpdate": null,
    "options": null,
    "name": null,
    "id": null,
    "validationRegex": null,
    "value": null
  },
  "parameters": {
    "id": null,
    "type": null,
    "value": null,
    "key": null
  }
}

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.
permission string false Access READ_ONLY Permissions for the asset granted to the user making the request.
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
permission VIEW
permission MODIFY

DeviceAccessDto

{
  "accessList": null,
  "deviceGroupName": null
}

Properties

Name Type Required Restrictions Description
accessList Map false none none
deviceGroupName String false none none

DeviceActuator

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