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

WolkAbout IoT Platform API v19.06.1

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

actility-api

actility-api

createUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/actility 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/actility',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "name": null,
  "id": null,
  "parameters": {
    "name": null,
    "id": null,
    "type": "RAW",
    "value": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/actility

create

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Body parameter

{
  "name": null,
  "id": null,
  "parameters": {
    "name": null,
    "id": null,
    "type": "RAW",
    "value": null
  }
}

Parameters

Parameter In Type Required Description
body body Integration true integration

Example responses

200 Response

Responses

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

sendMessageUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/actility/devices/{deviceId}/messages 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/actility/devices/{deviceId}/messages',
  method: 'post',

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/actility/devices/{deviceId}/messages

sendMessage

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Body parameter

null

Parameters

Parameter In Type Required Description
deviceId path Long true deviceId
body body String true message

Example responses

200 Response

Responses

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

reloadParametersUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/actility/parameters HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

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

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

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

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

};

fetch('https://api-demo.wolkabout.com/api/actility/parameters',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

    }

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

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

POST /api/actility/parameters

reloadParameters

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Example responses

200 Response

Responses

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

asset-api

asset-api

listUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/assets 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/assets',
  method: 'post',

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/assets

list

Permissions:
isAuthenticated()

Body parameter

null

Parameters

Parameter In Type Required Description
body body List true assets

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AssetDto] false none none
» assetId long false none none
» error String false Access READ_ONLY none
» asset Object false Access READ_ONLY none
» assetType String false none none

authentication-api

authentication-api

accountActivationWithTwoPasswordsUsingPUT

Code samples

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

PUT https://api-demo.wolkabout.com/api/accountActivation 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/accountActivation',
  method: 'put',

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

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

};

fetch('https://api-demo.wolkabout.com/api/accountActivation',
{
  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/accountActivation',
  params: {
  'code' => 'String'
}, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api-demo.wolkabout.com/api/accountActivation', params={
  'code': 'null'
}, headers = headers)

print r.json()

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

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

PUT /api/accountActivation

accountActivationWithTwoPasswords

Permissions:

Body parameter

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

Parameters

Parameter In Type Required Description
code query String true code
body body AccountActivationDto true dto

Example responses

200 Response

Responses

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

emailRegistrationUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/emailRegistration 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/emailRegistration',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "firstName": null,
  "lastName": null,
  "password": null,
  "newsletterSubscription": true,
  "language": null,
  "email": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/emailRegistration

emailRegistration

Permissions:

Body parameter

{
  "firstName": null,
  "lastName": null,
  "password": null,
  "newsletterSubscription": true,
  "language": null,
  "email": null
}

Parameters

Parameter In Type Required Description
body body SignUpByEmailRequest true request

Example responses

200 Response

Responses

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

emailSignInUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/emailSignIn 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/emailSignIn',
  method: 'post',

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/emailSignIn

emailSignIn

Permissions:

Body parameter

{
  "password": null,
  "username": null
}

Parameters

Parameter In Type Required Description
body body SignInRequest true request

Example responses

200 Response

Responses

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

verifyEmailUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/emailVerification HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

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

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

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api-demo.wolkabout.com/api/emailVerification',
  params: {
  'verificationCode' => 'String'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api-demo.wolkabout.com/api/emailVerification', params={
  'verificationCode': 'null'
}, headers = headers)

print r.json()

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

    }

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

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

POST /api/emailVerification

verifyEmail

Permissions:

Parameters

Parameter In Type Required Description
verificationCode query String true verificationCode
language query String false language

Example responses

200 Response

Responses

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

initiateDeletionUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/initiateDeletion 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/initiateDeletion',
  method: 'post',

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/initiateDeletion

initiateDeletion

Permissions:

Body parameter

{
  "password": null,
  "username": null
}

Parameters

Parameter In Type Required Description
body body SignInRequest true request

Example responses

200 Response

Responses

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

accountActivationInvitedUsingPUT

Code samples

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

PUT https://api-demo.wolkabout.com/api/invitations 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/invitations',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "firstName": null,
  "lastName": null,
  "password": null,
  "againPassword": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

fetch('https://api-demo.wolkabout.com/api/invitations',
{
  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/invitations',
  params: {
  'code' => 'String'
}, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api-demo.wolkabout.com/api/invitations', params={
  'code': 'null'
}, headers = headers)

print r.json()

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

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

PUT /api/invitations

accountActivationInvited

Permissions:

Body parameter

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

Parameters

Parameter In Type Required Description
code query String true code
language query String false language
body body ActivateInvitedDto true dto

Example responses

200 Response

Responses

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

passwordResetUsingPUT

Code samples

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

PUT /api/passwordReset

passwordReset

Permissions:

Body parameter

null

Parameters

Parameter In Type Required Description
language query String false language
body body passwordResetUsingPUTEmail true email

Example responses

200 Response

Responses

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

refreshTokenUsingPUT

Code samples

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

PUT /api/refreshToken

refreshToken

Permissions:

Body parameter

null

Parameters

Parameter In Type Required Description
body body String true refreshToken

Example responses

200 Response

Responses

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

resendVerificationEmailUsingPOST

Code samples

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/verificationMail

resendVerificationEmail

Permissions:

Body parameter

null

Parameters

Parameter In Type Required Description
language query String false language
body body passwordResetUsingPUTEmail true email

Example responses

200 Response

Responses

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

brand-api

brand-api

createUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/brands 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/brands',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "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
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/brands

create

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Body parameter

{
  "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
}

Parameters

Parameter In Type Required Description
body body Brand true brand

Example responses

200 Response

Responses

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

readUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/brands

read

Permissions:
isAuthenticated()

Example responses

200 Response

Responses

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

deleteBrandUsingDELETE

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/brands

deleteBrand

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Example responses

200 Response

Responses

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

updateUsingPUT

Code samples

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

PUT https://api-demo.wolkabout.com/api/brands 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/brands',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "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
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/brands',
{
  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/brands',
  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/brands', params={

}, headers = headers)

print r.json()

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

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

PUT /api/brands

update

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Body parameter

{
  "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
}

Parameters

Parameter In Type Required Description
body body Brand true brand

Example responses

200 Response

Responses

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

calculation-api

calculation-api

pageUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

page

Permissions:

Parameters

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

Responses

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

listUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/calculations/{id}/messageSubscriptions

list

Permissions:

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [MessageSubscription] false none none
» originType String false none none
» originId Long false none none
» messageType string true none none
» context Context false none none
»» generallyAvailable boolean false none none
»» name String true Size (0, 127) Name of the entity.
»» active boolean false none none
»» id long false none Unique identifier per entity class.
» eventType String true none none
» id long false none Unique identifier per entity class.
» priority int false none none
» user User false none none
»» firstName String false Size (0, 64) none
»» lastName String false Size (0, 64) none
»» verified boolean false none none
»» id long false none Unique identifier per entity class.
»» email String false Size (6, 128) none

Enumerated Values

Property Value
messageType INFO
messageType WARNING
messageType ALARM
messageType OFF

validateUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/calculations/validate 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/calculations/validate',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "inputs": {
    "reference": null,
    "value": null
  },
  "dataType": "STRING",
  "formula": null,
  "initialValue": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/calculations/validate

validate

Permissions:
hasAuthority('POINT_READ')

Body parameter

{
  "inputs": {
    "reference": null,
    "value": null
  },
  "dataType": "STRING",
  "formula": null,
  "initialValue": null
}

Parameters

Parameter In Type Required Description
body body FormulaDto true dto

Example responses

200 Response

Responses

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

createAccessUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/calculations/{id}/access

createAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

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

Enumerated Values

Parameter Value
body VIEW
body MODIFY
body MANAGE

Example responses

200 Response

Responses

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

readAccessUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/calculations/{id}/access

readAccess

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

Property Value
permission VIEW
permission MODIFY
permission MANAGE

deleteAccessUsingDELETE

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/calculations/{id}/access

deleteAccess

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

updateAccessUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/calculations/{id}/access

updateAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

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

Enumerated Values

Parameter Value
body VIEW
body MODIFY
body MANAGE

Example responses

200 Response

Responses

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

getMyPermissionUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/calculations/{id}/access/myAccess

getMyPermission

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

subscribeUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/calculations/{id}/messageSubscriptions HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

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

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

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

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

};

fetch('https://api-demo.wolkabout.com/api/calculations/{id}/messageSubscriptions',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api-demo.wolkabout.com/api/calculations/{id}/messageSubscriptions',
  params: {
  'eventType' => 'String',
'messageType' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api-demo.wolkabout.com/api/calculations/{id}/messageSubscriptions', params={
  'eventType': 'null',  'messageType': 'INFO'
}, headers = headers)

print r.json()

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

    }

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

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

POST /api/calculations/{id}/messageSubscriptions

subscribe

Permissions:

Parameters

Parameter In Type Required Description
eventType query String true eventType
messageType query string true messageType
userId query Long false userId
id path long true id

Enumerated Values

Parameter Value
messageType INFO
messageType WARNING
messageType ALARM
messageType OFF

Example responses

200 Response

Responses

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

unsubscribeBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.delete (produces: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/calculations/{id}/messageSubscriptions',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.delete (produces: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/calculations/{id}/messageSubscriptions', params={
  'ids': undefined
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) /api/calculations/{id}/messageSubscriptions

unsubscribeBulk

Permissions:

Parameters

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

Responses

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

unsubscribeUsingDELETE

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/calculations/{id}/messageSubscriptions/{subscriptionId}

unsubscribe

Permissions:

Parameters

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

Example responses

200 Response

Responses

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

updateSubscriptionUsingPUT

Code samples

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

PUT https://api-demo.wolkabout.com/api/calculations/{id}/messageSubscriptions/{subscriptionId} 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/calculations/{id}/messageSubscriptions/{subscriptionId}',
  method: 'put',

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

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

};

fetch('https://api-demo.wolkabout.com/api/calculations/{id}/messageSubscriptions/{subscriptionId}',
{
  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/calculations/{id}/messageSubscriptions/{subscriptionId}',
  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/calculations/{id}/messageSubscriptions/{subscriptionId}', params={

}, headers = headers)

print r.json()

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

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

PUT /api/calculations/{id}/messageSubscriptions/{subscriptionId}

updateSubscription

Permissions:

Body parameter

"INFO"

Parameters

Parameter In Type Required Description
id path long true id
subscriptionId path long true subscriptionId
body body updateSubscriptionUsingPUTMessagetype true messageType

Enumerated Values

Parameter Value
body INFO
body WARNING
body ALARM
body OFF

Example responses

200 Response

Responses

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

searchGroupsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/calculations/{id}/userGroups

searchGroups

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

Property Value
permission VIEW
permission MODIFY
permission MANAGE

conversion-api

conversion-api

createUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/conversions 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/conversions',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "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,
    "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,
      "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,
      "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,
    "readingTypeName": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/conversions

create

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Body parameter

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

Parameters

Parameter In Type Required Description
body body Conversion true conversion

Example responses

200 Response

Responses

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

listPagedUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

listPaged

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
readingTypeId query undefined false readingTypeId
unit query undefined false unit

Responses

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

listUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/conversions

list

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
readingTypeId query Long false readingTypeId
unit query String false unit

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Conversion] false none none
» formula String true Size (0, 1024) none
» toUnit Unit true none none
»» symbol String false Size (0, 32) Display symbol for the unit.
»» precision int false Min 0
Max 15
How many digits will be in mantissa (digits after the decimal point).
»» readingTypeId long false none ReadingType id that this unit belongs to.
»» inUse boolean false none none
»» context Context false none none
»»» generallyAvailable boolean false none none
»»» name String true Size (0, 127) Name of the entity.
»»» active boolean false none none
»»» id long false none Unique identifier per entity class.
»» id long false none Unique identifier per entity class.
»» system string true none none
»» name String true Size (0, 127) Name of the entity.
»» readingTypeName String false none none
» id long false none Unique identifier per entity class.
» readingType ReadingType false none none
»» trending boolean false none none
»» image String false none Transient Base64 encoded image.
»» fileName String false none Transient file name of the icon file.
»» dataType string true none none
»» aggregatable boolean false none none
»» contextId Context false none none
»» units Unit false none none
»» labels String false Size (0, 255) Labels can be used on UI as unit when size is gt 1. E.g. x,y,z for acceleration. Lat,Long for location. Labels are comma separated.
»» defaultUnit Unit false none none
»» size int false Min 1 How many independent values are in one reading. E.g. for location value 12.88,10,34 size is 2, while for acceleration value 1,-1,0 size is 3.
»» inUse boolean false none none
»» name String true Size (0, 127) Name of the entity.
»» id long false none Unique identifier per entity class.
» fromUnit Unit true none none

Enumerated Values

Property Value
system SI
system NON_SI
system CUSTOM
dataType STRING
dataType NUMERIC
dataType BOOLEAN

listSimpleUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/VND.CONVERSION.SIMPLE+JSON) /api/conversions

listSimple

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
from query undefined false from

Responses

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

bulkDeleteUsingDELETE

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/conversions

bulkDelete

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Parameters

Parameter In Type Required Description
ids query List true ids

Example responses

200 Response

Responses

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

validateUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/conversions/validate 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/conversions/validate',
  method: 'post',

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/conversions/validate

validate

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Body parameter

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

Parameters

Parameter In Type Required Description
body body ConversionValidateDto true dto

Example responses

200 Response

Responses

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

readUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/conversions/{id}

read

Permissions:

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

deleteConversionUsingDELETE

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/conversions/{id}

deleteConversion

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

updateUsingPUT

Code samples

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

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

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

};

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "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,
    "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,
      "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,
      "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,
    "readingTypeName": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/conversions/{id}

update

Permissions:
hasAuthority('CONTEXT_MANAGEMENT')

Body parameter

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

Parameters

Parameter In Type Required Description
id path long true id
body body Conversion true conversion

Example responses

200 Response

Responses

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

d-v-t-device-api

d-v-t-device-api

pageWithPageAssetsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

pageWithPageAssets

Permissions:
hasAuthority('DEVICE_READ')

Parameters

Parameter In Type Required Description
query query undefined false query
type query undefined false type
connectivityType query undefined false connectivityType
firmwareUpdateType query undefined false firmwareUpdateType
connectionState query undefined false connectionState
includeSensors query undefined false includeSensors
includeActuators query undefined false includeActuators
includeAlarms query undefined false includeAlarms
includeConfigs query undefined false includeConfigs

Responses

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

listUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

list

Permissions:
hasAuthority('DEVICE_READ')

Parameters

Parameter In Type Required Description
query query undefined false query
type query undefined false type
connectivityType query undefined false connectivityType
firmwareUpdateType query undefined false firmwareUpdateType
includeSensors query undefined false includeSensors
includeActuators query undefined false includeActuators
includeAlarms query undefined false includeAlarms
includeConfigs query undefined false includeConfigs
connectionState query undefined false connectionState

Responses

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

pageWithListAssetUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

pageWithListAsset

Permissions:
hasAuthority('DEVICE_READ')

Parameters

Parameter In Type Required Description
query query undefined false query
type query undefined false type
connectivityType query undefined false connectivityType
firmwareUpdateType query undefined false firmwareUpdateType
includeSensors query undefined false includeSensors
includeActuators query undefined false includeActuators
includeAlarms query undefined false includeAlarms
includeConfigs query undefined false includeConfigs
connectionState query undefined false connectionState

Responses

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

pageWithParametersUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

pageWithParameters

Permissions:
hasAuthority('DEVICE_READ')

Parameters

Parameter In Type Required Description
state query undefined false state
query query undefined false query
type query undefined false type
connectivityType query undefined false connectivityType
firmwareUpdateType query undefined false firmwareUpdateType

Responses

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

d-v-t-device-group-api

d-v-t-device-group-api

bulkDevicesFromBulkGroupsUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/deviceGroups',
  method: 'delete (produces: application/vnd.bulk.everything+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/deviceGroups',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.BULK.EVERYTHING+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete (produces: application/vnd.bulk.everything+json) 'https://api-demo.wolkabout.com/api/deviceGroups',
  params: {
  'groupIds' => 'undefined',
'deviceIds' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.delete (produces: application/vnd.bulk.everything+json)('https://api-demo.wolkabout.com/api/deviceGroups', params={
  'groupIds': undefined,  'deviceIds': undefined
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

bulkDevicesFromBulkGroups

Permissions:
hasAuthority('DEVICE_UPDATE')

Parameters

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

Responses

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

bulkDevicesToBulkGroupsUsingPOST

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST (CONSUMES: APPLICATION/VND.BULK.EVERYTHING+JSON) /api/deviceGroups

bulkDevicesToBulkGroups

Permissions:
hasAuthority('DEVICE_UPDATE')

Parameters

Parameter In Type Required Description
dto body BulkDeviceGroupDto true dto

Responses

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

d-v-t-feed-api

d-v-t-feed-api

createUsingPOST

Code samples

# You can also use wget
curl -X POST (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/feeds \
  -H 'Authorization: API_KEY'

POST (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/feeds HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/feeds',
  method: 'post (consumes: application/vnd.feedWithExtras+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/feeds',
{
  method: 'POST (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.post (consumes: application/vnd.feedWithExtras+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/feeds',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post (consumes: application/vnd.feedWithExtras+json)('https://api-demo.wolkabout.com/api/points/{pointId}/feeds', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) /api/points/{pointId}/feeds

create

Permissions:
hasAuthority('POINT_UPDATE')

Parameters

Parameter In Type Required Description
pointId path undefined true pointId
body body FeedWithExtras true body

Responses

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

readUsingGET

Code samples

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

GET (PRODUCES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}',
  method: 'get (produces: application/vnd.feedWithExtras+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}',
{
  method: 'GET (PRODUCES: APPLICATION/VND.FEEDWITHEXTRAS+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.get (produces: application/vnd.feedWithExtras+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get (produces: application/vnd.feedWithExtras+json)('https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) /api/points/{pointId}/feeds/{feedId}

read

Permissions:
hasAuthority('POINT_READ')

Parameters

Parameter In Type Required Description
pointId path undefined true pointId
feedId path undefined true feedId

Responses

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

updateUsingPUT

Code samples

# You can also use wget
curl -X PUT (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId} \
  -H 'Authorization: API_KEY'

PUT (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}',
  method: 'put (consumes: application/vnd.feedWithExtras+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}',
{
  method: 'PUT (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.put (consumes: application/vnd.feedWithExtras+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put (consumes: application/vnd.feedWithExtras+json)('https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON)", "https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{feedId}", data)
    req.Header = headers

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

PUT (CONSUMES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) /api/points/{pointId}/feeds/{feedId}

update

Permissions:
hasAuthority('POINT_UPDATE')

Parameters

Parameter In Type Required Description
pointId path undefined true pointId
feedId path undefined true feedId
body body FeedWithExtras true body

Responses

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

deleteUsingDELETE

Code samples

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

DELETE (PRODUCES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{id}',
  method: 'delete (produces: application/vnd.feedWithExtras+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{id}',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.FEEDWITHEXTRAS+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete (produces: application/vnd.feedWithExtras+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete (produces: application/vnd.feedWithExtras+json)('https://api-demo.wolkabout.com/api/points/{pointId}/feeds/{id}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE (PRODUCES: APPLICATION/VND.FEEDWITHEXTRAS+JSON) /api/points/{pointId}/feeds/{id}

delete

Permissions:
hasAuthority('POINT_UPDATE')

Parameters

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

Responses

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

d-v-t-message-subscription-api

d-v-t-message-subscription-api

pageUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/VND.EXTENDEDPAGE+JSON) /api/messageSubscriptions

page

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
originType query undefined false originType
originId query undefined false originId
eventType query undefined false eventType
userId query undefined false userId

Responses

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

listUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/VND.EXTENDED+JSON) /api/messageSubscriptions

list

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
originType query undefined false originType
originId query undefined false originId
eventType query undefined false eventType
userId query undefined false userId

Responses

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

d-v-t-point-api

d-v-t-point-api

getWithLocationUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/VND.LOCATIONPOINTTREEPAGE+JSON) /api/points

getWithLocation

Permissions:
hasAuthority('POINT_READ')

Parameters

Parameter In Type Required Description
query query undefined false query
includeFeeds query undefined false includeFeeds
includeActuators query undefined false includeActuators
includeAlarms query undefined false includeAlarms
includeMetadata query undefined false includeMetadata

Responses

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

pageUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/VND.LEGACYPOINTTREEPAGE+JSON) /api/points

page

Permissions:
hasAuthority('POINT_READ')

Parameters

Parameter In Type Required Description
query query undefined false query
dataSize query undefined false dataSize
dataType query undefined false dataType
readingTypeId query undefined false readingTypeId
includeFeeds query undefined false includeFeeds
includeActuators query undefined false includeActuators
includeAlarms query undefined false includeAlarms
includeMetadata query undefined false includeMetadata

Responses

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

listUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/VND.LEGACYPOINTTREE+JSON) /api/points

list

Permissions:
hasAuthority('POINT_READ')

Parameters

Parameter In Type Required Description
query query undefined false query
dataSize query undefined false dataSize
dataType query undefined false dataType
readingTypeId query undefined false readingTypeId
includeFeeds query undefined false includeFeeds
includeActuators query undefined false includeActuators
includeAlarms query undefined false includeAlarms
includeMetadata query undefined false includeMetadata

Responses

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

createUsingPOST

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST (CONSUMES: APPLICATION/VND.CREATEWITHROUTE+JSON) /api/points

create

Permissions:
hasAuthority('POINT_CREATE')

Parameters

Parameter In Type Required Description
dto body PointRouteCreationDto true dto

Responses

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

getBreadcrumbsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/points/{id}/breadcrumbs

getBreadcrumbs

Permissions:
hasAuthority('POINT_READ')

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [NamedDto] false none none
» name String false none none
» id long false none none

d-v-t-user-group-api

d-v-t-user-group-api

bulkUsersFromBulkGroupsUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/userGroups',
  method: 'delete (produces: application/vnd.bulk.everything+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/userGroups',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.BULK.EVERYTHING+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete (produces: application/vnd.bulk.everything+json) 'https://api-demo.wolkabout.com/api/userGroups',
  params: {
  'groupIds' => 'undefined',
'userIds' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.delete (produces: application/vnd.bulk.everything+json)('https://api-demo.wolkabout.com/api/userGroups', params={
  'groupIds': undefined,  'userIds': undefined
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE (PRODUCES: APPLICATION/VND.BULK.EVERYTHING+JSON) /api/userGroups

bulkUsersFromBulkGroups

Permissions:
hasAuthority('USER_UPDATE')

Parameters

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

Responses

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

bulkUsersToBulkGroupsUsingPOST

Code samples

# You can also use wget
curl -X POST (CONSUMES: APPLICATION/VND.BULK.EVERYTHING+JSON) https://api-demo.wolkabout.com/api/userGroups \
  -H 'Authorization: API_KEY'

POST (CONSUMES: APPLICATION/VND.BULK.EVERYTHING+JSON) https://api-demo.wolkabout.com/api/userGroups HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/userGroups',
  method: 'post (consumes: application/vnd.bulk.everything+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/userGroups',
{
  method: 'POST (CONSUMES: APPLICATION/VND.BULK.EVERYTHING+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.post (consumes: application/vnd.bulk.everything+json) 'https://api-demo.wolkabout.com/api/userGroups',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.post (consumes: application/vnd.bulk.everything+json)('https://api-demo.wolkabout.com/api/userGroups', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/userGroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST (CONSUMES: APPLICATION/VND.BULK.EVERYTHING+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST (CONSUMES: APPLICATION/VND.BULK.EVERYTHING+JSON)", "https://api-demo.wolkabout.com/api/userGroups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST (CONSUMES: APPLICATION/VND.BULK.EVERYTHING+JSON) /api/userGroups

bulkUsersToBulkGroups

Permissions:
hasAuthority('USER_UPDATE')

Parameters

Parameter In Type Required Description
dto body BulkUserGroupDto true dto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

dashboard-api

dashboard-api

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/dashboards \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/dashboards 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/dashboards',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "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
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api-demo.wolkabout.com/api/dashboards',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api-demo.wolkabout.com/api/dashboards', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/dashboards", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/dashboards

create

Permissions:
hasAuthority('DASHBOARD_CREATE')

Body parameter

{
  "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
}

Parameters

Parameter In Type Required Description
body body Dashboard true dashboard

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Long
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/dashboards/{id}/messageSubscriptions \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/dashboards/{id}/messageSubscriptions HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{id}/messageSubscriptions',
  method: 'get (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{id}/messageSubscriptions',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/dashboards/{id}/messageSubscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/dashboards/{id}/messageSubscriptions', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{id}/messageSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

p