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

WolkAbout IoT Platform API Rule Engine, Data Monitoring And Visualisation v20.GA-DEV-28

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

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

Base URLs:

Email: Wolkabout Web: Wolkabout

Authentication

advanced-rule-engine-api

advanced-rule-engine-api

setTracedUsingPUT

Code samples

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/advancedRules/{ruleId}/traced

setTraced

Permissions:
hasAuthority('RULE_WRITE')

Body parameter

true

Parameters

Parameter In Type Required Description
ruleId path long true ruleId
body body boolean true traced

Example responses

200 Response

Responses

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

getMyPermissionUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

getMyPermission

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

searchGroupsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/advancedRules/{id}/userGroups

searchGroups

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

Property Value
permission VIEW
permission MODIFY

getExecutionLogUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
  method: 'get',

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

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

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

};

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

p JSON.parse(result)

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

r = requests.get('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog', params={

}, headers = headers)

print r.json()

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

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

GET /api/advancedRules/{ruleId}/executionLog

getExecutionLog

Permissions:
hasAnyAuthority('SEMANTIC_READ', 'SEMANTIC_WRITE', 'RULE_WRITE', 'RULE_READ')

Parameters

Parameter In Type Required Description
ruleId path long true ruleId

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 [ExecutionLogDto] false none none
» execution String false none none
» timestamp long false none none

getExecutionLogSliceUsingGET

Code samples

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

GET (PRODUCES: APPLICATION/VND.SLICE+JSON) https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
  method: 'get (produces: application/vnd.slice+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
{
  method: 'GET (PRODUCES: APPLICATION/VND.SLICE+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.slice+json) 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get (produces: application/vnd.slice+json)('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog', params={

}, headers = headers)

print r.json()

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

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

GET (PRODUCES: APPLICATION/VND.SLICE+JSON) /api/advancedRules/{ruleId}/executionLog

getExecutionLogSlice

Permissions:
hasAnyAuthority('SEMANTIC_READ', 'SEMANTIC_WRITE', 'RULE_WRITE', 'RULE_READ')

Parameters

Parameter In Type Required Description
timestamp query undefined false timestamp
ruleId path undefined true ruleId

Responses

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

deleteBulkByCriteriaUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete (produces: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete (produces: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/advancedRules', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

deleteBulkByCriteria

Permissions:
hasAnyAuthority('SEMANTIC_READ', 'SEMANTIC_WRITE', 'RULE_WRITE', 'RULE_READ')

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query

Responses

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

createUsingPOST

Code samples

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

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "name": null,
  "description": null,
  "active": true,
  "traced": true,
  "content": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

POST /api/advancedRules

create

Permissions:
hasAuthority('RULE_WRITE')

Body parameter

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

Parameters

Parameter In Type Required Description
body body AdvancedRuleCreationDto true rule

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

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

page

Permissions:
hasAnyAuthority('RULE_READ', 'RULE_WRITE')

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query

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/advancedRules \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/advancedRules

list

Permissions:
hasAnyAuthority('RULE_READ', 'RULE_WRITE')

Parameters

Parameter In Type Required Description
active query Boolean false active
query query String false query

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 [AdvancedRuleDto] false none none
» executionTracing boolean false none none
» creatorName String false none none
» lastModification long false none none
» name String false none none
» description String false none none
» active boolean false none none
» modifiedBy User false none none
»» firstName String false Size (0, 64) none
»» lastName String false Size (0, 64) none
»» verified boolean false none none
»» id long false none Unique identifier per entity class.
»» email String false Size (6, 128) none
» id long false none none
» creationDate long false none none
» lastExecutionTime Long false none none
» content String false none none

deleteBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

deleteBulk

Permissions:
hasAnyAuthority('SEMANTIC_READ', 'SEMANTIC_WRITE', 'RULE_WRITE', 'RULE_READ')

Parameters

Parameter In Type Required Description
ids query undefined true ids

Responses

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

setTracedBulkByIdsUsingPUT

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/traced',
{
  method: 'PUT (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.put (consumes: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules/traced',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.put (consumes: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/advancedRules/traced', params={
  'ids': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/traced");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT (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("PUT (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/advancedRules/traced", data)
    req.Header = headers

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

PUT (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON) /api/advancedRules/traced

setTracedBulkByIds

Permissions:
hasAuthority('RULE_WRITE')

Parameters

Parameter In Type Required Description
ids query undefined true ids
traced body boolean true traced

Responses

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

setTracedBulkByCriteriaUsingPUT

Code samples

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

PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/traced HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/traced',
  method: 'put (consumes: application/vnd.criteria.operation+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/traced',
{
  method: 'PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.put (consumes: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules/traced',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put (consumes: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/advancedRules/traced', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/advancedRules/traced

setTracedBulkByCriteria

Permissions:
hasAuthority('RULE_WRITE')

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query
traced body boolean true traced

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/advancedRules/{ruleId} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/advancedRules/{ruleId}

read

Permissions:
hasAnyAuthority('SEMANTIC_READ', 'SEMANTIC_WRITE', 'RULE_WRITE', 'RULE_READ')

Parameters

Parameter In Type Required Description
ruleId path long true ruleId

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK AdvancedRuleDto
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/advancedRules/{ruleId} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/advancedRules/{ruleId}

delete

Permissions:
hasAuthority('RULE_WRITE')

Parameters

Parameter In Type Required Description
ruleId path long true ruleId

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Void
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/advancedRules/{ruleId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "name": null,
  "description": null,
  "active": true,
  "traced": true,
  "content": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/advancedRules/{ruleId}

update

Permissions:
hasAuthority('RULE_WRITE')

Body parameter

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

Parameters

Parameter In Type Required Description
ruleId path long true ruleId
body body AdvancedRuleCreationDto true update

Example responses

200 Response

Responses

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

setActiveUsingPUT

Code samples

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/advancedRules/{ruleId}/enabled

setActive

Permissions:
hasAuthority('RULE_WRITE')

Body parameter

true

Parameters

Parameter In Type Required Description
ruleId path long true ruleId
body body boolean true active

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Void
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/advancedRules/{id}/access \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/advancedRules/{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/advancedRules/{id}/access',
  method: 'post',

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

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

};

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

p JSON.parse(result)

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

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

print r.json()

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

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

POST /api/advancedRules/{id}/access

createAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

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

Enumerated Values

Parameter Value
body VIEW
body MODIFY

Example responses

200 Response

Responses

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

pageAccessUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

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

pageAccess

Permissions:
isAuthenticated()

Parameters

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

Responses

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

listAccessUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/advancedRules/{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/advancedRules/{id}/access',
  method: 'get',

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

GET /api/advancedRules/{id}/access

listAccess

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

Property Value
permission VIEW
permission MODIFY

deleteAccessUsingDELETE

Code samples

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

DELETE https://api-demo.wolkabout.com/api/advancedRules/{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/advancedRules/{id}/access',
  method: 'delete',

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

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

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

};

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

p JSON.parse(result)

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

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

print r.json()

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

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

DELETE /api/advancedRules/{id}/access

deleteAccess

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

updateAccessUsingPUT

Code samples

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

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

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

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

};

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

p JSON.parse(result)

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

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

print r.json()

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

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

PUT /api/advancedRules/{id}/access

updateAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

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

Enumerated Values

Parameter Value
body VIEW
body MODIFY

Example responses

200 Response

Responses

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

setActiveBulkByIdsUsingPUT

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/enabled',
{
  method: 'PUT (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.put (consumes: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules/enabled',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.put (consumes: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/advancedRules/enabled', params={
  'ids': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/enabled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT (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("PUT (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/advancedRules/enabled", data)
    req.Header = headers

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

PUT (CONSUMES: APPLICATION/VND.BULK.OPERATION+JSON) /api/advancedRules/enabled

setActiveBulkByIds

Permissions:
hasAuthority('RULE_WRITE')

Parameters

Parameter In Type Required Description
ids query undefined true ids
active body boolean true active

Responses

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

setActiveBulkByCriteriaUsingPUT

Code samples

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

PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/enabled HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/enabled',
  method: 'put (consumes: application/vnd.criteria.operation+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/enabled',
{
  method: 'PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.put (consumes: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules/enabled',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put (consumes: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/advancedRules/enabled', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/advancedRules/enabled

setActiveBulkByCriteria

Permissions:
hasAuthority('RULE_WRITE')

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query
toActive body boolean true toActive

Responses

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

dashboard-api

dashboard-api

duplicateUsingPOST

Code samples

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

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/dashboards/{id}/duplicates

duplicate

Permissions:
hasAuthority('DATA_VISUALISATION_WRITE')

Description:
Creates a copy of an existing dashboard.

Parameters

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

Example responses

200 Response

Responses

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

getMyPermissionUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

getMyPermission

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

createAccessUsingPOST

Code samples

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

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

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

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

};

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

p JSON.parse(result)

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

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

print r.json()

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

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

POST /api/dashboards/{id}/access

createAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

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

Enumerated Values

Parameter Value
body VIEW
body MODIFY

Example responses

200 Response

Responses

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

pageAccessUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

pageAccess

Permissions:
isAuthenticated()

Parameters

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

Responses

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

listAccessUsingGET

Code samples

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

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

GET /api/dashboards/{id}/access

listAccess

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

Property Value
permission VIEW
permission MODIFY

deleteAccessUsingDELETE

Code samples

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

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

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

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

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

};

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

p JSON.parse(result)

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

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

print r.json()

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

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

DELETE /api/dashboards/{id}/access

deleteAccess

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

updateAccessUsingPUT

Code samples

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

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

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

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

};

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

p JSON.parse(result)

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

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

print r.json()

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

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

PUT /api/dashboards/{id}/access

updateAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

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

Enumerated Values

Parameter Value
body VIEW
body MODIFY

Example responses

200 Response

Responses

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

searchGroupsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/dashboards/{id}/userGroups

searchGroups

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

Property Value
permission VIEW
permission MODIFY

availableSlotsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/dashboards/availableSlots

availableSlots

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Example responses

200 Response

Responses

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

createUsingPOST

Code samples

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

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

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

};

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "creator": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "creatorName": null,
  "contextId": null,
  "permission": "VIEW",
  "widgets": {
    "col": null,
    "sizeX": null,
    "mobileReady": true,
    "name": null,
    "extras": null,
    "row": null,
    "id": null,
    "type": null,
    "items": {
      "sourceId": null,
      "position": null,
      "id": null,
      "type": null
    },
    "sizeY": null
  },
  "type": "USER_DEFINED",
  "originType": null,
  "path": null,
  "originId": null,
  "roleName": null,
  "name": null,
  "id": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/dashboards

create

Permissions:
hasAuthority('DATA_VISUALISATION_WRITE')

Body parameter

{
  "creator": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "creatorName": null,
  "contextId": null,
  "permission": "VIEW",
  "widgets": {
    "col": null,
    "sizeX": null,
    "mobileReady": true,
    "name": null,
    "extras": null,
    "row": null,
    "id": null,
    "type": null,
    "items": {
      "sourceId": null,
      "position": null,
      "id": null,
      "type": null
    },
    "sizeY": null
  },
  "type": "USER_DEFINED",
  "originType": null,
  "path": null,
  "originId": null,
  "roleName": null,
  "name": null,
  "id": null
}

Parameters

Parameter In Type Required Description
body body Dashboard true dashboard

Example responses

200 Response

Responses

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

pageUsingGET

Code samples

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

GET (PRODUCES: APPLICATION/VND.PAGE+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.page+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.get (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/dashboards', 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.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/dashboards", data)
    req.Header = headers

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

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

page

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
query query undefined false query

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 (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+JSON) https://api-demo.wolkabout.com/api/dashboards \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+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.projection+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards',
{
  method: 'GET (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+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.projection+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.projection+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.PROJECTION+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.PROJECTION+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.PROJECTION+JSON) /api/dashboards

list

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
query query undefined false query

Responses

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

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

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

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

Permissions:
hasAuthority('DATA_VISUALISATION_WRITE')

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

Permissions:
hasAuthority('DATA_VISUALISATION_WRITE')

Body parameter

null

Parameters

Parameter In Type Required Description
id path long true id
body body String 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

endpoint-api

endpoint-api

createUsingPOST

Code samples

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

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "enabledRule": true,
  "enabledMessage": true,
  "description": null,
  "enabledAsset": true,
  "id": null,
  "type": "SMS",
  "value": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

POST /api/endpoints

create

Permissions:
isAuthenticated()

Body parameter

{
  "enabledRule": true,
  "enabledMessage": true,
  "description": null,
  "enabledAsset": true,
  "id": null,
  "type": "SMS",
  "value": null
}

Parameters

Parameter In Type Required Description
body body Endpoint true endpoint

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/endpoints \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/endpoints

list

Permissions:
isAuthenticated()

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 [Endpoint] false none none
» enabledRule boolean false none none
» enabledMessage boolean false none none
» description String false none none
» enabledAsset boolean false none none
» id long false none Unique identifier per entity class.
» type string true none none
» value String true none none

Enumerated Values

Property Value
type SMS
type EMAIL
type WEB_SOCKET
type ANDROID_DEVICE
type IOS_DEVICE

updateOptionsUsingPUT

Code samples

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/endpoints/{id}/options

updateOptions

Permissions:
isAuthenticated()

Body parameter

true

Parameters

Parameter In Type Required Description
type query string false type
id path long true id
body body boolean true enabled

Enumerated Values

Parameter Value
type ASSET
type MESSAGE
type RULE

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/endpoints/{id}

read

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Endpoint
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/endpoints/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/endpoints/{id}

delete

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK 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/endpoints/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "enabledRule": true,
  "enabledMessage": true,
  "description": null,
  "enabledAsset": true,
  "id": null,
  "type": "SMS",
  "value": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/endpoints/{id}

update

Permissions:
isAuthenticated()

Body parameter

{
  "enabledRule": true,
  "enabledMessage": true,
  "description": null,
  "enabledAsset": true,
  "id": null,
  "type": "SMS",
  "value": null
}

Parameters

Parameter In Type Required Description
id path long true id
body body Endpoint true endpoint

Example responses

200 Response

Responses

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

extendDurationUsingPUT

Code samples

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

PUT https://api-demo.wolkabout.com/api/endpoints/{id}/duration HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

PUT /api/endpoints/{id}/duration

extendDuration

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

message-api

message-api

pageMessagesUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/messages

pageMessages

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
since query Long false since
to query Long false to
type query String false type
query query String false query
read query Boolean false read

Example responses

200 Response

Responses

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

unreadAlarmsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messages',
{
  method: 'GET (PRODUCES: APPLICATION/VND.UNREAD.ALARMS+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.unread.alarms+json) 'https://api-demo.wolkabout.com/api/messages',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET (PRODUCES: APPLICATION/VND.UNREAD.ALARMS+JSON) /api/messages

unreadAlarms

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Responses

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

markAsReadAllUsingPUT

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

PUT /api/messages/markAsReadAll

markAsReadAll

Permissions:
hasAuthority('DATA_VISUALISATION_WRITE')

Description:
This operation will be performed asynchronouslya and the results will not become visible instantly.

Example responses

200 Response

Responses

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

markAsReadByCriteriaUsingPUT

Code samples

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

PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/messages/markAsRead HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messages/markAsRead',
  method: 'put (consumes: application/vnd.criteria.operation+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messages/markAsRead',
{
  method: 'PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

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

require 'rest-client'
require 'json'

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

result = RestClient.put (consumes: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/messages/markAsRead',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put (consumes: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/messages/markAsRead', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT (CONSUMES: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/messages/markAsRead

markAsReadByCriteria

Permissions:
hasAuthority('DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
since query undefined false since
to query undefined false to
type query undefined false type
query query undefined false query
read query undefined false read

Responses

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

markAsReadUsingPUT

Code samples

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/messages/markAsRead

markAsRead

Permissions:
hasAuthority('DATA_VISUALISATION_WRITE')

Body parameter

null

Parameters

Parameter In Type Required Description
body body List true messageKeys

Example responses

200 Response

Responses

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

countUnreadAlarmsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/messages/unreadCount

countUnreadAlarms

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
since query Long false since
to query Long false to
type query String false type
query query String false query

Example responses

200 Response

Responses

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

message-subscription-api

message-subscription-api

levelsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/messageSubscriptions/levels

levels

Permissions:
isAuthenticated()

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 [MessageType] false none none

unsubscribeByCriteriaUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

unsubscribeByCriteria

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
level query undefined false level
query query undefined false query

Responses

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

subscribeUsingPOST

Code samples

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

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "channels": [
    "PUSH_NOTIFICATION"
  ],
  "level": "INFO",
  "recipients": null,
  "scope": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

POST /api/messageSubscriptions

subscribe

Permissions:
isAuthenticated()

Body parameter

{
  "channels": [
    "PUSH_NOTIFICATION"
  ],
  "level": "INFO",
  "recipients": null,
  "scope": null
}

Parameters

Parameter In Type Required Description
body body MessageSubscriptionCreationDto true messageSubscription

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

page

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
level query undefined false level
query query undefined false query

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/messageSubscriptions \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/messageSubscriptions

list

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
level query string false level
query query String false query

Enumerated Values

Parameter Value
level INFO
level WARNING
level ALARM
level OFF

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [MessageSubscription] false none none
» channels [string] false none Internal is always included.
» level string true none none
» recipients UserGroup false none none
»» systemManaged boolean false Access READ_ONLY none
»» name String false Size (0, 256) Name of the entity.
»» description String false Size (0, 255) none
»» contextId Context false none none
»»» generallyAvailable boolean false none none
»»» name String false Size (0, 127) Name of the entity.
»»» active boolean false none none
»»» id long false none Unique identifier per entity class.
»» id long false none Unique identifier per entity class.
» scope String true none none
» context Context false none none
» id long false none Unique identifier per entity class.
» scopeObject MessageSubscriptionScopeDto false none none
»» name String false none none
»» id long false none none
»» type String false none none

Enumerated Values

Property Value
level INFO
level WARNING
level ALARM
level OFF

unsubscribeBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

unsubscribeBulk

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
ids query undefined true ids

Responses

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

channelsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/messageSubscriptions/channels

channels

Permissions:
isAuthenticated()

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 [MessageChannel] false none none

unsubscribeUsingDELETE

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/messageSubscriptions/{id}

unsubscribe

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK 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/messageSubscriptions/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "channels": [
    "PUSH_NOTIFICATION"
  ],
  "level": "INFO",
  "recipients": null,
  "scope": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/messageSubscriptions/{id}

update

Permissions:
isAuthenticated()

Body parameter

{
  "channels": [
    "PUSH_NOTIFICATION"
  ],
  "level": "INFO",
  "recipients": null,
  "scope": null
}

Parameters

Parameter In Type Required Description
id path long true id
body body MessageSubscriptionCreationDto true messageSubscriptionDto

Example responses

200 Response

Responses

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

report-api

report-api

getDataSnapshotForReportUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
  method: 'get (produces: application/vnd.snapshot.with.interval.v2+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
{
  method: 'GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+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.snapshot.with.interval.v2+json) 'https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
  params: {
  'from' => 'undefined',
'to' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.get (produces: application/vnd.snapshot.with.interval.v2+json)('https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo', params={
  'from': undefined,  'to': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+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.SNAPSHOT.WITH.INTERVAL.V2+JSON)", "https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo", data)
    req.Header = headers

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

GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) /api/reports/{reportId}/snapshotFromTo

getDataSnapshotForReport

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
from query undefined true from
to query undefined true to
reportId path undefined true reportId

Responses

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

getHybridAggregationUsingGET

Code samples

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

GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+JSON) https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
  method: 'get (produces: application/vnd.hybridAggregation+json)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
{
  method: 'GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+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.hybridAggregation+json) 'https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
  params: {
  'from' => 'undefined',
'to' => 'undefined',
'aggregationInterval' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.get (produces: application/vnd.hybridAggregation+json)('https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo', params={
  'from': undefined,  'to': undefined,  'aggregationInterval': undefined
}, headers = headers)

print r.json()

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

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

GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+JSON) /api/reports/{reportId}/snapshotFromTo

getHybridAggregation

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
from query undefined true from
to query undefined true to
aggregationInterval query undefined true aggregationInterval
reportId path undefined true reportId

Responses

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

getMyPermissionUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

getMyPermission

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

getLocationSnapshotForReportUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample',
  method: 'get',

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

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

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

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample',
{
  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/reports/{reportId}/locationSample',
  params: {
  'from' => 'Long',
'to' => 'Long'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample', params={
  'from': 'null',  'to': 'null'
}, headers = headers)

print r.json()

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

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

GET /api/reports/{reportId}/locationSample

getLocationSnapshotForReport

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
from query Long true from
to query Long true to
reportId path long true reportId

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 [RawReadingDto] false none none
» readings Reading false none none
»» sourceId Long false none none
»» data String false none none
»» sourceType string false none none
»» time ZonedDateTime false none none
»» timestamp Long false none none
» feedId long false none none

Enumerated Values

Property Value
sourceType FEED
sourceType ACTUATOR
sourceType ALARM

downloadRawDataUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/OCTET-STREAM) https://api-demo.wolkabout.com/api/reports/{reportId}/rawData \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/OCTET-STREAM) https://api-demo.wolkabout.com/api/reports/{reportId}/rawData HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/rawData',
  method: 'get (produces: application/octet-stream)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/rawData',
{
  method: 'GET (PRODUCES: APPLICATION/OCTET-STREAM)',

  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/octet-stream) 'https://api-demo.wolkabout.com/api/reports/{reportId}/rawData',
  params: {
  'from' => 'undefined',
'to' => 'undefined'
}, headers: headers

p JSON.parse(result)

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

r = requests.get (produces: application/octet-stream)('https://api-demo.wolkabout.com/api/reports/{reportId}/rawData', params={
  'from': undefined,  'to': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/rawData");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/OCTET-STREAM)");
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/OCTET-STREAM)", "https://api-demo.wolkabout.com/api/reports/{reportId}/rawData", data)
    req.Header = headers

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

GET (PRODUCES: APPLICATION/OCTET-STREAM) /api/reports/{reportId}/rawData

downloadRawData

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Description:
Using parameter locale, value of column timestamp can be changed. In case it is not present, value will be timestamp. In case it has a valid locale value it will be formatted for that value. Date and time style have effect only in case locale is provided.

Parameters

Parameter In Type Required Description
from query undefined true from
to query undefined true to
locale query undefined false locale
dateStyle query undefined false dateStyle
timeStyle query undefined false timeStyle
reportId path undefined true reportId

Responses

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

availableSlotsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/reports/availableSlots

availableSlots

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Example responses

200 Response

Responses

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

getReportUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/reports/{reportId}

getReport

Permissions:
hasAnyAuthority('DATA_VISUALISATION_READ', 'DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
reportId path long true reportId

Example responses

200 Response

Responses

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

deleteReportUsingDELETE

Code samples

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

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

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

};

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

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/reports/{reportId}

deleteReport

Permissions:
hasAuthority('DATA_VISUALISATION_WRITE')

Parameters

Parameter In Type Required Description
reportId path long true reportId

Example responses

200 Response

Responses

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

updateReportUsingPUT

Code samples

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

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "settings": null,
  "creator": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "defaultFrom": null,
  "reportRange": "TODAY",
  "feedIds": null,
  "creatorName": null,
  "contextId": null,
  "permission": "VIEW",
  "defaultTo": null,
  "readingType": {
    "trending": true,
    "image": null,
    "fileName": null,
    "dataType": "STRING",
    "aggregatable": true,
    "contextId": {
      "generallyAvailable": true,
      "name": null,
      "active": t