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

WolkAbout IoT Platform API v18.09.3

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

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 request = 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

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 request = 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

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 request = 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

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 request = 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

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 request = 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

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 request = 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

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 request = 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

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 request = 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

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 request = 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

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 request = 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
  },
  "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

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
  },
  "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 request = 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

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 request = 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

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 request = 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
  },
  "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

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

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 request = require('node-fetch');
const inputBody = '{
  "inUse": true,
  "toUnit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "id": null,
    "system": "SI",
    "name": null,
    "readingTypeName": null
  },
  "formula": null,
  "id": null,
  "readingType": {
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "precision": null,
    "aggregatable": true,
    "units": {
      "symbol": null,
      "readingTypeId": null,
      "inUse": true,
      "id": null,
      "system": "SI",
      "name": null,
      "readingTypeName": null
    },
    "labels": null,
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "fromUnit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "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

Body parameter

{
  "inUse": true,
  "toUnit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "id": null,
    "system": "SI",
    "name": null,
    "readingTypeName": null
  },
  "formula": null,
  "id": null,
  "readingType": {
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "precision": null,
    "aggregatable": true,
    "units": {
      "symbol": null,
      "readingTypeId": null,
      "inUse": true,
      "id": null,
      "system": "SI",
      "name": null,
      "readingTypeName": null
    },
    "labels": null,
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "fromUnit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "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 request = 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

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 request = 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

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
» inUse boolean false none none
» toUnit Unit false none none
»» symbol String false none none
»» readingTypeId long false none none
»» inUse boolean false none none
»» id long false none none
»» system string false none none
»» name String false none none
»» readingTypeName String false none none
» formula String false none none
» id long false none none
» readingType ReadingType false none none
»» image String false none none
»» fileName String false none none
»» dataType string false none none
»» precision int false none none
»» aggregatable boolean false none none
»» units Unit false none none
»» labels String false none none
»» size int false none none
»» inUse boolean false none none
»» name String false none none
»» id long false none none
» fromUnit Unit false 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 request = 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

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 request = 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

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 request = 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

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 request = 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

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 request = 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

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 request = require('node-fetch');
const inputBody = '{
  "inUse": true,
  "toUnit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "id": null,
    "system": "SI",
    "name": null,
    "readingTypeName": null
  },
  "formula": null,
  "id": null,
  "readingType": {
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "precision": null,
    "aggregatable": true,
    "units": {
      "symbol": null,
      "readingTypeId": null,
      "inUse": true,
      "id": null,
      "system": "SI",
      "name": null,
      "readingTypeName": null
    },
    "labels": null,
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "fromUnit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "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

Body parameter

{
  "inUse": true,
  "toUnit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "id": null,
    "system": "SI",
    "name": null,
    "readingTypeName": null
  },
  "formula": null,
  "id": null,
  "readingType": {
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "precision": null,
    "aggregatable": true,
    "units": {
      "symbol": null,
      "readingTypeId": null,
      "inUse": true,
      "id": null,
      "system": "SI",
      "name": null,
      "readingTypeName": null
    },
    "labels": null,
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "fromUnit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "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

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 request = require('node-fetch');
const inputBody = '{
  "creator": {
    "firstName": null,
    "lastName": null,
    "active": true,
    "id": null,
    "email": null
  },
  "accessListActive": true,
  "roleName": null,
  "creatorName": null,
  "name": null,
  "permission": "READ_ONLY",
  "id": null,
  "widgets": {
    "col": null,
    "sizeX": null,
    "mobileReady": true,
    "name": null,
    "extras": null,
    "row": null,
    "id": null,
    "type": null,
    "items": {
      "sourceId": null,
      "position": null,
      "id": null,
      "type": null
    },
    "sizeY": null
  },
  "type": "USER_DEFINED"
}';
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

Body parameter

{
  "creator": {
    "firstName": null,
    "lastName": null,
    "active": true,
    "id": null,
    "email": null
  },
  "accessListActive": true,
  "roleName": null,
  "creatorName": null,
  "name": null,
  "permission": "READ_ONLY",
  "id": null,
  "widgets": {
    "col": null,
    "sizeX": null,
    "mobileReady": true,
    "name": null,
    "extras": null,
    "row": null,
    "id": null,
    "type": null,
    "items": {
      "sourceId": null,
      "position": null,
      "id": null,
      "type": null
    },
    "sizeY": null
  },
  "type": "USER_DEFINED"
}

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

listUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

r = requests.get('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("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/dashboards", data)
    req.Header = headers

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

GET /api/dashboards

list

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 [Dashboard] false none none
» creator User false none none
»» firstName String false none none
»» lastName String false none none
»» active boolean false none none
»» id long false none none
»» email String false none none
» accessListActive boolean false none none
» roleName String false none none
» creatorName String false none none
» name String false none none
» permission string false none none
» id long false none none
» widgets Widget false none none
»» col int false none none
»» sizeX int false none none
»» mobileReady boolean false none none
»» name String false none none
»» extras Map false none none
»» row int false none none
»» id long false none none
»» type String false none none
»» items WidgetItem false none none
»»» sourceId long false none none
»»» position int false none none
»»» id long false none none
»»» type String false none none
»» sizeY int false none none
» type string false none none

Enumerated Values

Property Value
permission READ_ONLY
permission READ_WRITE
type USER_DEFINED
type GENERATED

listLightUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards',
{
  method: 'GET (PRODUCES: APPLICATION/VND.DASHBOARD.SHORT+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.dashboard.short+json) 'https://api-demo.wolkabout.com/api/dashboards',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get (produces: application/vnd.dashboard.short+json)('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("GET (PRODUCES: APPLICATION/VND.DASHBOARD.SHORT+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.DASHBOARD.SHORT+JSON)", "https://api-demo.wolkabout.com/api/dashboards", data)
    req.Header = headers

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

GET (PRODUCES: APPLICATION/VND.DASHBOARD.SHORT+JSON) /api/dashboards

listLight

Responses

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

readUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/dashboards/{id}

read

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

deleteUsingDELETE

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/dashboards/{id}

delete

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/dashboards/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/dashboards/{id}

update

Body parameter

null

Parameters

Parameter In Type Required Description
id path long true id
body body updateUsingPUTName true name

Example responses

200 Response

Responses

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

device-actuator-api

device-actuator-api

createUsingPOST

Code samples

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

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

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

};

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

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

const request = require('node-fetch');
const inputBody = '{
  "readingType": {
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "precision": null,
    "aggregatable": true,
    "units": {
      "symbol": null,
      "readingTypeId": null,
      "inUse": true,
      "id": null,
      "system": "SI",
      "name": null,
      "readingTypeName": null
    },
    "labels": null,
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "deviceName": null,
  "reference": null,
  "connected": true,
  "path": null,
  "unit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "id": null,
    "system": "SI",
    "name": null,
    "readingTypeName": null
  },
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "value": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/devices/{deviceId}/actuators

create

Body parameter

{
  "readingType": {
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "precision": null,
    "aggregatable": true,
    "units": {
      "symbol": null,
      "readingTypeId": null,
      "inUse": true,
      "id": null,
      "system": "SI",
      "name": null,
      "readingTypeName": null
    },
    "labels": null,
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "deviceName": null,
  "reference": null,
  "connected": true,
  "path": null,
  "unit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "id": null,
    "system": "SI",
    "name": null,
    "readingTypeName": null
  },
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "value": null
}

Parameters

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

Example responses

200 Response

Responses

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

pageUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

page

Parameters

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

Responses

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

listUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/devices/{deviceId}/actuators

list

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

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

readUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

read

Parameters

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

Example responses

200 Response

Responses

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

deleteUsingDELETE

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

delete

Parameters

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

Example responses

200 Response

Responses

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

updateUsingPUT

Code samples

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

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

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

};

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

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

const request = require('node-fetch');
const inputBody = '{
  "readingType": {
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "precision": null,
    "aggregatable": true,
    "units": {
      "symbol": null,
      "readingTypeId": null,
      "inUse": true,
      "id": null,
      "system": "SI",
      "name": null,
      "readingTypeName": null
    },
    "labels": null,
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "deviceName": null,
  "reference": null,
  "connected": true,
  "path": null,
  "unit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "id": null,
    "system": "SI",
    "name": null,
    "readingTypeName": null
  },
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "value": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

update

Body parameter

{
  "readingType": {
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "precision": null,
    "aggregatable": true,
    "units": {
      "symbol": null,
      "readingTypeId": null,
      "inUse": true,
      "id": null,
      "system": "SI",
      "name": null,
      "readingTypeName": null
    },
    "labels": null,
    "size": null,
    "inUse": true,
    "name": null,
    "id": null
  },
  "deviceName": null,
  "reference": null,
  "connected": true,
  "path": null,
  "unit": {
    "symbol": null,
    "readingTypeId": null,
    "inUse": true,
    "id": null,
    "system": "SI",
    "name": null,
    "readingTypeName": null
  },
  "lastUpdate": null,
  "name": null,
  "maximum": null,
  "id": null,
  "state": "READY",
  "minimum": null,
  "value": null
}

Parameters

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

Example responses

200 Response

Responses

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

device-alarm-api

device-alarm-api

createUsingPOST

Code samples

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

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

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

};

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

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

const request = require('node-fetch');
const inputBody = '{
  "severity": "ALERT",
  "reference": null,
  "connected": true,
  "path": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "message": null,
  "value": null,
  "deviceName": null,
  "status": "NORMAL"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/devices/{deviceId}/alarms

create

Body parameter

{
  "severity": "ALERT",
  "reference": null,
  "connected": true,
  "path": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "message": null,
  "value": null,
  "deviceName": null,
  "status": "NORMAL"
}

Parameters

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

Example responses

200 Response

Responses

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

pageUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

page

Parameters

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

Responses

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

listUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/devices/{deviceId}/alarms

list

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

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

readUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

read

Parameters

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

Example responses

200 Response

Responses

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

deleteUsingDELETE

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

delete

Parameters

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

Example responses

200 Response

Responses

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

updateUsingPUT

Code samples

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

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

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

};

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

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

const request = require('node-fetch');
const inputBody = '{
  "severity": "ALERT",
  "reference": null,
  "connected": true,
  "path": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "message": null,
  "value": null,
  "deviceName": null,
  "status": "NORMAL"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

update

Body parameter

{
  "severity": "ALERT",
  "reference": null,
  "connected": true,
  "path": null,
  "lastUpdate": null,
  "name": null,
  "id": null,
  "message": null,
  "value": null,
  "deviceName": null,
  "status": "NORMAL"
}

Parameters

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

Example responses

200 Response

Responses

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

device-api

device-api

createUsingPOST

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

create

Parameters

Parameter In Type Required Description
newDevices body List true newDevices

Responses

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

pageUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

page

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
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/devices

list

Parameters

Parameter In Type Required Description
state query string false state
query query String false query
type query String false type
connectivityType query String false connectivityType
firmwareUpdateType query String false firmwareUpdateType

Enumerated Values

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

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

deleteBulkUsingDELETE

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/devices

deleteBulk

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

countDevicesUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/devices/countByState

countDevices

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

numberOfDevicesUntilLimitUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/devices/devicesUntilLimit

numberOfDevicesUntilLimit

Example responses

200 Response

Responses

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

getDeviceUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/devices/{deviceKey}

getDevice

Parameters

Parameter In Type Required Description
deviceKey path String true deviceKey

Example responses

200 Response

Responses

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

generatePasswordUsingPUT

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/devices/{deviceKey}/password

generatePassword

Parameters

Parameter In Type Required Description
deviceKey path String true deviceKey

Example responses

200 Response

Responses

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

deleteUsingDELETE

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/devices/{id}

delete

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

createAccessUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/devices/{id}/access

createAccess

Body parameter

"READ_ONLY"

Parameters

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

Enumerated Values

Parameter Value
body READ_ONLY
body READ_WRITE

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/devices/{id}/access \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/devices/{id}/access

readAccess

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 [ResourceAccessTuple] false none none
» roleName String false none none
» permission string false none none
» id long false none none
» user User false none none
»» firstName String false none none
»» lastName String false none none
»» active boolean false none none
»» id long false none none
»» email String false none none

Enumerated Values

Property Value
permission READ_ONLY
permission READ_WRITE

deleteAccessUsingDELETE

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/devices/{id}/access

deleteAccess

Parameters

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

Example responses

200 Response

Responses

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

updateAccessUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/devices/{id}/access

updateAccess

Body parameter

"READ_ONLY"

Parameters

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

Enumerated Values

Parameter Value
body READ_ONLY
body READ_WRITE

Example responses

200 Response

Responses

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

updateAccessListActiveUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/devices/{id}/accessStatus

updateAccessListActive

Body parameter

true

Parameters

Parameter In Type Required Description
id path long true id
body body updateAccessListActiveUsingPUTActive true active

Example responses

200 Response

Responses

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

searchUsersUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.get('https://api-demo.wolkabout.com/api/devices/{id}/users', params={
  'query': null
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/devices/{id}/users

searchUsers

Parameters

Parameter In Type Required Description
query query String true 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 [AssetUserTuple] false none none
» role String false none none
» permission string false none none
» user User false none none
»» firstName String false none none
»» lastName String false none none
»» active boolean false none none
»» id long false none none
»» email String false none none

Enumerated Values

Property Value
permission READ_ONLY
permission READ_WRITE

renameUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/devices{deviceKey}/name

rename

Body parameter

null

Parameters

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

Example responses

200 Response

Responses

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

device-asset-finder-api

device-asset-finder-api

pageActuatorsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

pageActuators

Parameters

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

Responses

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

listActuatorsUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/deviceActuators

listActuators

Parameters

Parameter In Type Required Description
deviceId query Long false deviceId
name query String false name
readingTypeId query Long false readingTypeId

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

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

pageAlarmsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

pageAlarms

Parameters

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

Responses

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

listAlarmsUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/deviceAlarms

listAlarms

Parameters

Parameter In Type Required Description
deviceId query Long false deviceId
name query String false name

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

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

pageSensorsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

pageSensors

Parameters

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

Responses

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

listSensorsUsingGET

Code samples

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

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

Accept: */*

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/deviceSensors

listSensors

Parameters

Parameter In Type Required Description
deviceId query Long false deviceId
name query String false name
readingTypeId query Long false readingTypeId

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ResponseEntity] false none none
» headers HttpHeaders false none none
»» date long false none none
»» allow Set false none none
»» expires long false none none
»» accessControlMaxAge long false none none
»» vary String false none none
»» origin String false none none
»» ifUnmodifiedSince long false none none
»» range HttpRange false none none
»» ifModifiedSince long false none none
»» accessControlRequestMethod string false none none
»» accessControlAllowMethods [string] false none none
»» ifMatch String false none none
»» empty boolean false none none
»» accessControlAllowHeaders String false none none
»» accessControlAllowOrigin String false none none
»» contentDisposition ContentDisposition false none none
»»» charset Charset false none none
»»» modificationDate ZonedDateTime false none none
»»» f