WolkAbout IoT Platform API v20.M3

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:

• https://api-demo.wolkabout.com

Email: Wolkabout Web: Wolkabout

Authentication

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

actuator-mapping-api

actuator-mapping-api

createUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/mappings/{mappingId}/actuators

create

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
body	body	ActuatorMappingCreateDto	true	dto

Example responses

200 Response

Responses

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

listUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/mappings/{mappingId}/actuators HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/mappings/{mappingId}/actuators',
  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/mappings/{mappingId}/actuators',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/mappings/{mappingId}/actuators

list

Permissions:
hasAnyAuthority('DEVICE_TEMPLATE_WRITE', 'DEVICE_TEMPLATE_READ') and hasAnyAuthority('SEMANTIC_TEMPLATE_WRITE', 'SEMANTIC_TEMPLATE_READ')

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId

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	[ActuatorMappingListDto]	false	none	none
» mappingId	long	false	none	none
» deviceActuatorId	long	false	none	none
» id	long	false	none	none
» deviceActuatorName	String	false	none	none
» actuatorName	String	false	none	none
» actuatorId	long	false	none	none

deleteBulkUsingDELETE

Code samples

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

DELETE https://api-demo.wolkabout.com/api/mappings/{mappingId}/actuators HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/mappings/{mappingId}/actuators',
  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/mappings/{mappingId}/actuators',
{
  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/mappings/{mappingId}/actuators',
  params: {
  'ids' => 'List'
}, headers: headers

p JSON.parse(result)

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

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

print r.json()

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

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

DELETE /api/mappings/{mappingId}/actuators

deleteBulk

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Parameters

Parameter	In	Type	Required	Description
ids	query	List	true	ids
mappingId	path	Long	true	mappingId

Example responses

200 Response

Responses

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

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

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/mappings/{mappingId}/actuators/{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/mappings/{mappingId}/actuators/{id}',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/mappings/{mappingId}/actuators/{id}

delete

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
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/mappings/{mappingId}/actuators/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/mappings/{mappingId}/actuators/{id}

update

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
id	path	Long	true	id
body	body	ActuatorMappingCreateDto	true	dto

Example responses

200 Response

Responses

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

adm-device-api

adm-device-api

createBulkUsingPOST

Code samples

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

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

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

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

};

fetch('https://api-demo.wolkabout.com/api/advanced/devices',
{
  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/advanced/devices',
  params: {
  'mappingId' => '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/advanced/devices', params={
  'mappingId': 'null'
}, headers = headers)

print r.json()

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

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

POST /api/advanced/devices

createBulk

Permissions:
hasAuthority('DEVICE_WRITE') and hasAuthority('SEMANTIC_WRITE')

Description:
Creates devices, creates points, then binds them using the provided mapping.

Body parameter

null

Parameters

Parameter	In	Type	Required	Description
mappingId	query	Long	true	mappingId
parentId	query	Long	false	parentId
body	body	List	true	newDevices

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	[Device]	false	none	none
» configs	DeviceConfig	false	none	none
»» dataType	string	true	none	none
»» description	String	false	Size (0, 255)	none
»» deviceKey	String	false	Access READ_ONLY	none
»» contextId	long	false	Access READ_ONLY	none
»» deviceName	String	false	Access READ_ONLY	none
»» labels	String	false	Size (0, 255)	none
»» reference	String	true	Size (0, 64)	none
»» connected	boolean	false	none	none
»» originType	String	false	none	none
»» path	String	false	none	none
»» originId	long	false	none	none
»» size	int	true	Min 1 Max 3	none
»» lastUpdate	ZonedDateTime	false	Access READ_ONLY	none
»» name	String	false	Size (0, 127)	Name of the entity.
»» maximum	BigDecimal	false	Integer 10 Fraction 10	none
»» id	long	false	none	Unique identifier per entity class.
»» minimum	BigDecimal	false	Integer 10 Fraction 10	none
»» device	Device	false	none	none
»» value	String	false	Size (0, 2048)	none
»» status	string	false	Access READ_ONLY	none
» activationTimestamp	ZonedDateTime	true	none	Date and time when devices was created.
» serviceStatuses	ServiceStatus	false	none	none
»» extras	String	false	none	none
»» id	long	false	none	Unique identifier per entity class.
»» error	String	false	none	none
»» type	String	true	none	none
»» timestamp	ZonedDateTime	true	none	none
»» status	String	true	none	none
» lastReportTimestamp	ZonedDateTime	false	Access READ_ONLY	Date and time when devices last time recevived any data.
» deviceAlarms	DeviceAlarm	false	none	none
»» description	String	false	Size (0, 255)	none
»» deviceKey	String	false	Access READ_ONLY	none
»» contextId	long	false	Access READ_ONLY	none
»» message	String	false	Size (0, 512)	none
»» deviceName	String	false	Access READ_ONLY	none
»» reference	String	true	Size (0, 64)	none
»» connected	boolean	false	none	none
»» originType	String	false	none	none
»» path	String	false	none	none
»» originId	long	false	none	none
»» lastUpdate	ZonedDateTime	false	Access READ_ONLY	none
»» name	String	false	Size (0, 127)	Name of the entity.
»» id	long	false	none	Unique identifier per entity class.
»» device	Device	false	none	none
»» value	String	false	Size (0, 2048)	none
»» status	string	false	Access READ_ONLY	none
» creatorName	String	false	none	Name of initial asset creator. This field will not change if ownership is changed.
» type	String	true	none	Device type is used when on create and on delete automated actions. Those actions can be defined only in java code.
» path	String	false	none	none
» password	String	false	none	Transient field, used only to provide raw password to used on device create.
» protocol	String	true	Size (0, 64)	Defines what data protocol does this device uses to send and receive data. (defines format of data).
» originId	long	false	none	none
» id	long	false	none	Unique identifier per entity class.
» attributesWithoutReadOnly	DeviceAttribute	false	none	none
»» deviceKey	String	false	Access READ_ONLY	none
»» contextId	long	false	Access READ_ONLY	none
»» readOnly	boolean	false	Access READ_ONLY	none
»» creationDate	ZonedDateTime	false	Access READ_ONLY ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.	none
»» type	string	true	none	none
»» required	boolean	false	none	none
»» originType	String	false	none	none
»» path	String	false	none	none
»» originId	long	false	none	none
»» lastUpdate	ZonedDateTime	false	Access READ_ONLY ZonedDateTimeSerializer will serialize to Unix timestamp (epoch), is milliseconds.	none
»» options	String	false	none	none
»» name	String	false	Size (0, 127)	Name of the entity.
»» id	long	false	none	Unique identifier per entity class.
»» validationRegex	String	false	none	none
»» value	String	false	Size (0, 255)	none
» deviceSensors	DeviceSensor	false	none	none
»» description	String	false	Size (0, 255)	none
»» deviceKey	String	false	Access READ_ONLY	none
»» contextId	long	false	Access READ_ONLY	none
»» readingType	ReadingType	true	none	none
»»» trending	boolean	false	none	none
»»» image	String	false	none	Transient Base64 encoded image.
»»» fileName	String	false	none	Transient file name of the icon file.
»»» dataType	string	true	none	none
»»» aggregatable	boolean	false	none	none
»»» contextId	Context	false	none	none
»»»» 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.
»»» units	Unit	false	none	none
»»»» symbol	String	false	Size (0, 32)	Display symbol for the unit.
»»»» precision	int	false	Min 0 Max 15	How many digits will be in mantissa (digits after the decimal point).
»»»» readingTypeId	long	false	none	ReadingType id that this unit belongs to.
»»»» inUse	boolean	false	none	none
»»»» context	Context	false	none	none
»»»» id	long	false	none	Unique identifier per entity class.
»»»» system	string	true	none	none
»»»» name	String	false	Size (0, 127)	Name of the entity.
»»»» guid	String	false	none	none
»»»» readingTypeName	String	false	none	none
»»» labels	String	false	Size (0, 255)	Labels can be used on UI as unit when size is gt 1. E.g. x,y,z for acceleration. Lat,Long for location. Labels are comma separated.
»»» defaultUnit	Unit	false	none	none
»»» size	int	false	Min 1	How many independent values are in one reading. E.g. for location value 12.88,10,34 size is 2, while for acceleration value 1,-1,0 size is 3.
»»» inUse	boolean	false	none	none
»»» name	String	false	Size (0, 127)	Name of the entity.
»»» id	long	false	none	Unique identifier per entity class.
»» deviceName	String	false	Access READ_ONLY	none
»» reference	String	true	Size (0, 64)	none
»» connected	boolean	false	none	none
»» originType	String	false	none	none
»» path	String	false	none	none
»» unit	Unit	true	none	none
»» originId	long	false	none	none
»» lastUpdate	ZonedDateTime	false	Access READ_ONLY	none
»» name	String	false	Size (0, 127)	Name of the entity.
»» maximum	BigDecimal	false	Integer 16 Fraction 10	none
»» id	long	false	none	Unique identifier per entity class.
»» minimum	BigDecimal	false	Integer 16 Fraction 10	none
»» device	Device	false	none	none
»» value	String	false	Size (0, 2048)	none
» creator	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
» connectionState	string	false	Access READ_ONLY	Holds info about device connection status.
» manifest	DeviceManifest	false	none	none
»» deviceType	String	false	Size (0, 64)	none
»» generallyAvailable	boolean	false	Access READ_ONLY	none
»» configs	ConfigManifest	false	none	none
»»» reference	String	true	Size (0, 64)	none
»»» size	int	false	Min 1 Max 3	none
»»» defaultValue	String	true	Size (0, 255)	none
»»» dataType	string	true	none	none
»»» name	String	false	Size (0, 127)	Name of the entity.
»»» maximum	BigDecimal	false	Integer 10 Fraction 10	none
»»» description	String	false	Size (0, 255)	none
»»» id	long	false	none	Unique identifier per entity class.
»»» minimum	BigDecimal	false	Integer 10 Fraction 10	none
»»» nullValue	String	false	Size (0, 255)	none
»»» labels	String	false	none	none
»» creator	User	false	none	none
»» alarms	AlarmManifest	false	none	none
»»» reference	String	true	Size (0, 64)	none
»»» name	String	false	Size (0, 127)	Name of the entity.
»»» description	String	false	Size (0, 512)	none
»»» id	long	false	none	Unique identifier per entity class.
»»» message	String	false	Size (0, 512)	none
»» creatorName	String	false	none	Name of initial asset creator. This field will not change if ownership is changed.
»» description	String	false	Size (0, 255)	none
»» contextId	long	false	none	Context id that this entity belongs to.
»» permission	string	false	Access READ_ONLY	Permissions for the asset granted to the user making the request.
»» published	boolean	false	none	none
»» originType	String	false	none	none
»» path	String	false	none	none
»» protocol	String	true	Size (0, 64)	none
»» actuators	ActuatorManifest	false	none	none
»»» reference	String	true	Size (0, 64)	none
»»» unit	Unit	true	none	none
»»» name	String	false	Size (0, 127)	Name of the entity.
»»» maximum	BigDecimal	false	Integer 10 Fraction 10	none
»»» description	String	false	Size (0, 255)	none
»»» id	long	false	none	Unique identifier per entity class.
»»» minimum	BigDecimal	false	Integer 10 Fraction 10	none
»»» readingType	ReadingType	false	none	none
»» originId	long	false	none	none
»» inUse	boolean	false	Access READ_ONLY	none
»» roleName	String	false	Access READ_ONLY	Transient and read only role name of the creator.
»» name	String	false	Size (0, 127)	Name of the entity.
»» guid	String	false	none	none
»» feeds	FeedManifest	false	none	none
»»» reference	String	true	Size (0, 64)	none
»»» unit	Unit	true	none	none
»»» name	String	false	Size (0, 127)	Name of the entity.
»»» maximum	BigDecimal	false	Integer 10 Fraction 10	none
»»» description	String	false	Size (0, 255)	none
»»» id	long	false	none	Unique identifier per entity class.
»»» minimum	BigDecimal	false	Integer 10 Fraction 10	none
»»» readingType	ReadingType	false	none	none
»» attributes	AttributeManifest	false	none	none
»»» defaultValue	String	false	Size (0, 255)	none
»»» options	String	false	none	none
»»» name	String	false	Size (0, 127)	Name of the entity.
»»» readOnly	boolean	false	none	none
»»» id	long	false	none	Unique identifier per entity class.
»»» type	string	true	none	none
»»» validationRegex	String	false	none	none
»»» required	boolean	false	none	none
»» id	long	false	none	Unique identifier per entity class.
» deviceKey	String	true	Size (0, 128)	This key is unique in the system and it is used to identify the device.
» contextId	long	false	none	Context id that this entity belongs to.
» permission	string	false	Access READ_ONLY	Permissions for the asset granted to the user making the request.
» originType	String	false	none	none
» roleName	String	false	Access READ_ONLY	Transient and read only role name of the creator.
» name	String	false	Size (0, 127)	Name of the entity.
» deviceActuators	DeviceActuator	false	none	none
»» description	String	false	Size (0, 255)	none
»» deviceKey	String	false	Access READ_ONLY	none
»» contextId	long	false	Access READ_ONLY	none
»» readingType	ReadingType	false	none	none
»» deviceName	String	false	Access READ_ONLY	none
»» reference	String	true	Size (0, 64)	none
»» connected	boolean	false	none	none
»» originType	String	false	none	none
»» path	String	false	none	none
»» unit	Unit	true	none	none
»» originId	long	false	none	none
»» lastUpdate	ZonedDateTime	false	Access READ_ONLY	none
»» name	String	false	Size (0, 127)	Name of the entity.
»» maximum	BigDecimal	false	Integer 10 Fraction 10	none
»» id	long	false	none	Unique identifier per entity class.
»» state	string	false	Access READ_ONLY	none
»» minimum	BigDecimal	false	Integer 10 Fraction 10	none
»» device	Device	false	none	none
»» value	String	false	Size (0, 2048)	none
» attributes	DeviceAttribute	false	none	none
» parameters	DeviceParameter	false	none	none
»» id	long	false	none	Unique identifier per entity class.
»» type	String	true	none	none
»» value	String	false	Size (0, 255)	none
»» key	String	true	Size (0, 127)	none

Enumerated Values

Property	Value
dataType	STRING
dataType	NUMERIC
dataType	INTEGER
dataType	BOOLEAN
dataType	LOCATION
dataType	HEXADECIMAL
dataType	ENUM
status	READY
status	COMMANDED
status	BUSY
status	ERROR
status	NORMAL
status	ALARM
type	STRING
type	NUMERIC
type	INTEGER
type	BOOLEAN
type	LOCATION
type	HEXADECIMAL
type	ENUM
dataType	STRING
dataType	NUMERIC
dataType	INTEGER
dataType	BOOLEAN
dataType	LOCATION
dataType	HEXADECIMAL
dataType	ENUM
system	SI
system	NON_SI
system	CUSTOM
connectionState	CONNECTED
connectionState	OFFLINE
connectionState	DEACTIVATED
connectionState	SERVICE_MODE
connectionState	SLEEP
dataType	STRING
dataType	NUMERIC
dataType	INTEGER
dataType	BOOLEAN
dataType	LOCATION
dataType	HEXADECIMAL
dataType	ENUM
permission	VIEW
permission	MODIFY
type	STRING
type	NUMERIC
type	INTEGER
type	BOOLEAN
type	LOCATION
type	HEXADECIMAL
type	ENUM
permission	VIEW
permission	MODIFY
state	READY
state	COMMANDED
state	BUSY
state	ERROR

advanced-device-api

advanced-device-api

bindToPointUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/devices/{deviceId}/bindings

bindToPoint

Permissions:
hasAuthority('DEVICE_WRITE')

Description:
Links the device to a point using the specified mapping.

Body parameter

{
  "mappingId": null,
  "pointId": null
}

Parameters

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

Example responses

200 Response

Responses

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

advanced-rule-engine-api

advanced-rule-engine-api

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

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

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

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

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

subscribeUsingPOST

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/advancedRules/{id}/messageSubscriptions

subscribe

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

Parameters

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

Enumerated Values

Parameter	Value
messageType	INFO
messageType	WARNING
messageType	ALARM
messageType	OFF

Example responses

200 Response

Responses

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

pageSubscriptionsUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

pageSubscriptions

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

Parameters

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

Responses

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

listSubscriptionsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/advancedRules/{id}/messageSubscriptions

listSubscriptions

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

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

Property	Value
messageType	INFO
messageType	WARNING
messageType	ALARM
messageType	OFF

unsubscribeBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

unsubscribeBulk

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

Parameters

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

Responses

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

unsubscribeUsingDELETE

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

unsubscribe

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

Parameters

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

Example responses

200 Response

Responses

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

updateSubscriptionUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

updateSubscription

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

Body parameter

"INFO"

Parameters

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

Enumerated Values

Parameter	Value
body	INFO
body	WARNING
body	ALARM
body	OFF

Example responses

200 Response

Responses

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

searchGroupsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/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

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

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

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

alarm-mapping-api

alarm-mapping-api

createUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/mappings/{mappingId}/alarms

create

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
body	body	AlarmMappingCreateDto	true	dto

Example responses

200 Response

Responses

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

listUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/mappings/{mappingId}/alarms HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/mappings/{mappingId}/alarms',
  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/mappings/{mappingId}/alarms',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/mappings/{mappingId}/alarms

list

Permissions:
hasAnyAuthority('DEVICE_TEMPLATE_WRITE', 'DEVICE_TEMPLATE_READ') and hasAnyAuthority('SEMANTIC_TEMPLATE_WRITE', 'SEMANTIC_TEMPLATE_READ')

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId

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	[AlarmMappingListDto]	false	none	none
» mappingId	long	false	none	none
» alarmId	long	false	none	none
» alarmName	String	false	none	none
» id	long	false	none	none
» deviceAlarmName	String	false	none	none
» deviceAlarmId	long	false	none	none

deleteBulkUsingDELETE

Code samples

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

DELETE https://api-demo.wolkabout.com/api/mappings/{mappingId}/alarms HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/mappings/{mappingId}/alarms',
  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/mappings/{mappingId}/alarms',
{
  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/mappings/{mappingId}/alarms',
  params: {
  'ids' => 'List'
}, headers: headers

p JSON.parse(result)

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

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

print r.json()

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

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

DELETE /api/mappings/{mappingId}/alarms

deleteBulk

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Parameters

Parameter	In	Type	Required	Description
ids	query	List	true	ids
mappingId	path	Long	true	mappingId

Example responses

200 Response

Responses

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

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

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/mappings/{mappingId}/alarms/{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/mappings/{mappingId}/alarms/{id}',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/mappings/{mappingId}/alarms/{id}

delete

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
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/mappings/{mappingId}/alarms/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/mappings/{mappingId}/alarms/{id}

update

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
id	path	Long	true	id
body	body	AlarmMappingCreateDto	true	dto

Example responses

200 Response

Responses

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

asset-api

asset-api

listUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/assets

list

Permissions:
isAuthenticated()

Body parameter

null

Parameters

Parameter	In	Type	Required	Description
body	body	List	true	assets

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

attribute-mapping-api

attribute-mapping-api

createUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes 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/mappings/{mappingId}/attributes',
  method: 'post',

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

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

};

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

}, headers = headers)

print r.json()

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

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

POST /api/mappings/{mappingId}/attributes

create

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
body	body	AttributeMappingCreateDto	true	dto

Example responses

200 Response

Responses

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

listUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

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

p JSON.parse(result)

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

r = requests.get('https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes', params={

}, headers = headers)

print r.json()

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

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

GET /api/mappings/{mappingId}/attributes

list

Permissions:
hasAnyAuthority('DEVICE_TEMPLATE_WRITE', 'DEVICE_TEMPLATE_READ') and hasAnyAuthority('SEMANTIC_TEMPLATE_WRITE', 'SEMANTIC_TEMPLATE_READ')

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId

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	[AttributeMappingListDto]	false	none	none
» mappingId	long	false	none	none
» attributeId	long	false	none	none
» deviceAttributeName	String	false	none	none
» deviceAttributeId	long	false	none	none
» attributeName	String	false	none	none
» id	long	false	none	none

deleteBulkUsingDELETE

Code samples

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

DELETE https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes',
  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/mappings/{mappingId}/attributes',
{
  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/mappings/{mappingId}/attributes',
  params: {
  'ids' => 'List'
}, headers: headers

p JSON.parse(result)

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

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

print r.json()

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

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

DELETE /api/mappings/{mappingId}/attributes

deleteBulk

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Parameters

Parameter	In	Type	Required	Description
ids	query	List	true	ids
mappingId	path	Long	true	mappingId

Example responses

200 Response

Responses

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/mappings/{mappingId}/attributes/{id}

delete

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
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/mappings/{mappingId}/attributes/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/mappings/{mappingId}/attributes/{id}

update

Permissions:
hasAuthority('DEVICE_TEMPLATE_WRITE') and hasAuthority('SEMANTIC_TEMPLATE_WRITE')

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
mappingId	path	Long	true	mappingId
id	path	Long	true	id
body	body	AttributeMappingCreateDto	true	dto

Example responses

200 Response

Responses

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

audit-log-api

audit-log-api

pageUsingGET

Code samples

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

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

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/auditLog',
  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/auditLog',
{
  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/auditLog',
  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/auditLog', params={
  'from': 'null',  'to': 'null'
}, headers = headers)

print r.json()

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

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

GET /api/auditLog

page

Permissions:
hasAuthority('AUDIT_LOG')

Description:
Retrieve pages of audit log.
sort - (optional, defaults to timestamp,desc) timestamp,asc or timestamp,desc
from - (required) filter logs after this timestamp
to - (required) filter logs before this timestamp
query (optional) - search query string. It is possible to use advanced and regex search. For more details see:
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html

Parameters

Parameter	In	Type	Required	Description
query	query	String	false	query
from	query	Long	true	from
to	query	Long	true	to

Example responses

200 Response

Responses

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

authentication-api

authentication-api

accountActivationWithTwoPasswordsUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api-demo.wolkabout.com/api/accountActivation',
  params: {
  'code' => 'String'
}, headers: headers

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/accountActivation

accountActivationWithTwoPasswords

Permissions:

Body parameter

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

Parameters

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

Example responses

200 Response

Responses

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

emailRegistrationUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/emailRegistration

emailRegistration

Permissions:

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
body	body	SignUpByEmailRequest	true	request

Example responses

200 Response

Responses

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

emailSignInUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/emailSignIn

emailSignIn

Permissions:

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
body	body	SignInRequest	true	request

Example responses

200 Response

Responses

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

verifyEmailUsingPOST

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/emailVerification

verifyEmail

Permissions:

Parameters

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

Example responses

200 Response

Responses

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

initiateDeletionUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/initiateDeletion

initiateDeletion

Permissions:

Body parameter

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

Parameters

Parameter	In	Type	Required	Description
body	body	SignInRequest	true	request

Example responses

200 Response

Responses

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

accountActivationInvitedUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api-demo.wolkabout.com/api/invitations',
  params: {
  'code' => 'String'
}, headers: headers

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/invitations

accountActivationInvited

Permissions:

Body parameter

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

Parameters

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

Example responses

200 Response

Responses

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

passwordResetUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/passwordReset

passwordReset

Permissions:

Body parameter

null

Parameters

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

Example responses

200 Response

Responses

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

refreshTokenUsingPUT

Code samples

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

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

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

};

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

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

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

};

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