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

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

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

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

Base URLs:

Email: Wolkabout Web: Wolkabout

Authentication

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

alarm-mapping-api

alarm-mapping-api

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

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

attribute-mapping-api

attribute-mapping-api

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

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

batch-channel-api

batch-channel-api

listChannelTypesUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/channels/types

listChannelTypes

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT')

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ChannelType] false none none
» name String false none none
» properties ChannelTypeProperty false none none
»» regex String false none none
»» name String false none none
»» required boolean false none none

createUsingPOST

Code samples

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

POST /api/channels

create

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT')

Body parameter

{
  "name": null,
  "description": null,
  "id": null,
  "type": null,
  "parameters": null
}

Parameters

Parameter In Type Required Description
body body Channel2 true channel

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/channels',
  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/channels',
{
  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/channels',
  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/channels', params={

}, headers = headers)

print r.json()

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

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

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

page

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT')

Parameters

Parameter In Type Required Description
type query undefined false type
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/channels \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/channels

list

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT')

Parameters

Parameter In Type Required Description
type query String false type
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 [Channel] false none none
» name String false Size (0, 127) Name of the entity.
» description String false none none
» id long false none Unique identifier per entity class.
» type String true Size (0, 64) none
» parameters Map false none none

deleteBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

print r.json()

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

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

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

deleteBulk

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT')

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

readUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/channels/{id}

read

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT')

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

deleteSingleUsingDELETE

Code samples

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/channels/{id}

deleteSingle

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT')

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

updateUsingPUT

Code samples

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/channels/{id}

update

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT')

Body parameter

{
  "name": null,
  "description": null,
  "id": null,
  "type": null,
  "parameters": null
}

Parameters

Parameter In Type Required Description
id path long true id
body body Channel true update

Example responses

200 Response

Responses

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

batch-job-api

batch-job-api

getResultOfLastRunUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/OCTET-STREAM) https://api-demo.wolkabout.com/api/jobs/{id}/lastRun \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/OCTET-STREAM) https://api-demo.wolkabout.com/api/jobs/{id}/lastRun HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/jobs/{id}/lastRun',
  method: 'get (produces: application/octet-stream)',

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

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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/jobs/{id}/lastRun',
{
  method: 'GET (PRODUCES: APPLICATION/OCTET-STREAM)',

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

require 'rest-client'
require 'json'

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

result = RestClient.get (produces: application/octet-stream) 'https://api-demo.wolkabout.com/api/jobs/{id}/lastRun',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get (produces: application/octet-stream)('https://api-demo.wolkabout.com/api/jobs/{id}/lastRun', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/OCTET-STREAM) /api/jobs/{id}/lastRun

getResultOfLastRun

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

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

cancelJobUsingPOST

Code samples

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/jobs/{id}/cancellations

cancelJob

Permissions:

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

resetJobUsingPOST

Code samples

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/jobs/{id}/resets

resetJob

Permissions:

Parameters

Parameter In Type Required Description
id path Long true id

Example responses

200 Response

Responses

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

runManuallyUsingPOST

Code samples

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

POST /api/jobs/{id}/runs

runManually

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Parameters

Parameter In Type Required Description
id path Long true id

Example responses

200 Response

Responses

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

readUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/jobs/{id}

read

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

deleteSingleUsingDELETE

Code samples

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/jobs/{id}

deleteSingle

Permissions:
hasAuthority('TENANT_EDIT')

Parameters

Parameter In Type Required Description
id path long true id

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

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "cron": null,
  "lastExecutedBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "lastRun": null,
  "endDate": null,
  "channel": {
    "name": null,
    "description": null,
    "id": null,
    "type": null,
    "parameters": null
  },
  "description": null,
  "creationDate": null,
  "type": null,
  "lastSuccess": null,
  "nextRun": null,
  "originType": null,
  "path": null,
  "originId": null,
  "createdBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "lastUpdate": null,
  "repeatInterval": null,
  "name": null,
  "id": null,
  "startDate": null,
  "status": "NEVER_RAN"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/jobs/{id}

update

Permissions:
hasAuthority('TENANT_EDIT')

Body parameter

{
  "cron": null,
  "lastExecutedBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "lastRun": null,
  "endDate": null,
  "channel": {
    "name": null,
    "description": null,
    "id": null,
    "type": null,
    "parameters": null
  },
  "description": null,
  "creationDate": null,
  "type": null,
  "lastSuccess": null,
  "nextRun": null,
  "originType": null,
  "path": null,
  "originId": null,
  "createdBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "lastUpdate": null,
  "repeatInterval": null,
  "name": null,
  "id": null,
  "startDate": null,
  "status": "NEVER_RAN"
}

Parameters

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

createUsingPOST

Code samples

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

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "cron": null,
  "lastExecutedBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "lastRun": null,
  "endDate": null,
  "channel": {
    "name": null,
    "description": null,
    "id": null,
    "type": null,
    "parameters": null
  },
  "description": null,
  "creationDate": null,
  "type": null,
  "lastSuccess": null,
  "nextRun": null,
  "originType": null,
  "path": null,
  "originId": null,
  "createdBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "lastUpdate": null,
  "repeatInterval": null,
  "name": null,
  "id": null,
  "startDate": null,
  "status": "NEVER_RAN"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

POST /api/jobs

create

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Body parameter

{
  "cron": null,
  "lastExecutedBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "lastRun": null,
  "endDate": null,
  "channel": {
    "name": null,
    "description": null,
    "id": null,
    "type": null,
    "parameters": null
  },
  "description": null,
  "creationDate": null,
  "type": null,
  "lastSuccess": null,
  "nextRun": null,
  "originType": null,
  "path": null,
  "originId": null,
  "createdBy": {
    "firstName": null,
    "lastName": null,
    "verified": true,
    "id": null,
    "email": null
  },
  "lastUpdate": null,
  "repeatInterval": null,
  "name": null,
  "id": null,
  "startDate": null,
  "status": "NEVER_RAN"
}

Parameters

Parameter In Type Required Description
body body Job true job

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/jobs',
  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/jobs',
{
  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/jobs',
  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/jobs', params={

}, headers = headers)

print r.json()

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

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

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

page

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Parameters

Parameter In Type Required Description
channelId query undefined false channelId
jobStatus query undefined false jobStatus
query query undefined false query
type query undefined false type
lastRun query undefined false lastRun

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/jobs

list

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Parameters

Parameter In Type Required Description
channelId query Long false channelId
jobStatus query string false jobStatus
query query String false query
type query String false type
lastRun query Long false lastRun

Enumerated Values

Parameter Value
jobStatus NEVER_RAN
jobStatus RUNNING
jobStatus COMPLETED
jobStatus FAILED
jobStatus CANCELLED
jobStatus SCHEDULED_FOR_IMMEDIATE_EXECUTION

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 [Job] false none none
» cron String false Size (0, 64) none
» lastExecutedBy 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
» lastRun Instant false Access READ_ONLY
InstantSerializer will serialize to Unix timestamp (epoch), is milliseconds.
none
» endDate Instant false InstantSerializer will serialize to Unix timestamp (epoch), is milliseconds.
InstantDeserializer
none
» channel Channel false none none
»» name String false Size (0, 127) Name of the entity.
»» description String false none none
»» id long false none Unique identifier per entity class.
»» type String true Size (0, 64) none
»» parameters Map false none none
» description String false Size (0, 255) none
» creationDate Instant false Access READ_ONLY
InstantSerializer will serialize to Unix timestamp (epoch), is milliseconds.
none
» type String false Access READ_ONLY none
» lastSuccess Instant false Access READ_ONLY
InstantSerializer will serialize to Unix timestamp (epoch), is milliseconds.
none
» nextRun Instant false none none
» originType String false none none
» path String false none none
» originId long false none none
» createdBy User false none none
» lastUpdate Instant false Access READ_ONLY
InstantSerializer will serialize to Unix timestamp (epoch), is milliseconds.
none
» repeatInterval Integer false none none
» name String false Size (0, 127) Name of the entity.
» id long false none Unique identifier per entity class.
» startDate Instant false InstantSerializer will serialize to Unix timestamp (epoch), is milliseconds.
InstantDeserializer
none
» status string false Access READ_ONLY none

Enumerated Values

Property Value
status NEVER_RAN
status RUNNING
status COMPLETED
status FAILED
status CANCELLED
status SCHEDULED_FOR_IMMEDIATE_EXECUTION

deleteBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

print r.json()

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

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

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

deleteBulk

Permissions:
hasAuthority('TENANT_EDIT')

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

batch-task-api

batch-task-api

pageUsingGET

Code samples

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

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks',
  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/jobs/{jobId}/tasks',
{
  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/jobs/{jobId}/tasks',
  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/jobs/{jobId}/tasks', params={

}, headers = headers)

print r.json()

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

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

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/jobs/{jobId}/tasks

page

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Parameters

Parameter In Type Required Description
jobId path undefined true jobId

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/jobs/{jobId}/tasks \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

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

p JSON.parse(result)

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

r = requests.get('https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks', params={

}, headers = headers)

print r.json()

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

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

GET /api/jobs/{jobId}/tasks

list

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Parameters

Parameter In Type Required Description
type query String false type
jobId path long true jobId

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 [Task] false none none
» subType String false Size (0, 128) none
» id long false none Unique identifier per entity class.
» type String true Size (0, 64) none
» parameters TaskParameters false none none
»» taskType String false none none
»» taskSubType String false none none

bulkDeleteUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks',
  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/jobs/{jobId}/tasks',
{
  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/jobs/{jobId}/tasks',
  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/jobs/{jobId}/tasks', params={
  'ids': undefined
}, headers = headers)

print r.json()

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

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

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) /api/jobs/{jobId}/tasks

bulkDelete

Permissions:
hasAuthority('TENANT_EDIT')

Parameters

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

Responses

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

readUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks/{taskId} HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks/{taskId}',
  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/jobs/{jobId}/tasks/{taskId}',
{
  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/jobs/{jobId}/tasks/{taskId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks/{taskId}', params={

}, headers = headers)

print r.json()

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

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

GET /api/jobs/{jobId}/tasks/{taskId}

read

Permissions:
hasAnyAuthority('TENANT_MANAGEMENT', 'TENANT_EDIT')

Parameters

Parameter In Type Required Description
jobId path long true jobId
taskId path Long true taskId

Example responses

200 Response

Responses

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

singleDeleteUsingDELETE

Code samples

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

DELETE https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks/{taskId} HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks/{taskId}',
  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/jobs/{jobId}/tasks/{taskId}',
{
  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/jobs/{jobId}/tasks/{taskId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('https://api-demo.wolkabout.com/api/jobs/{jobId}/tasks/{taskId}', params={

}, headers = headers)

print r.json()

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

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

DELETE /api/jobs/{jobId}/tasks/{taskId}

singleDelete

Permissions:
hasAuthority('TENANT_EDIT')

Parameters

Parameter In Type Required Description
jobId path long true jobId
taskId path long true taskId

Example responses

200 Response

Responses

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

calculation-api

calculation-api

validateUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/calculations/validate

validate

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

Body parameter

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

Parameters

Parameter In Type Required Description
body body FormulaDto true dto

Example responses

200 Response

Responses

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

getMyPermissionUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

getMyPermission

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

createAccessUsingPOST

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST /api/calculations/{id}/access

createAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

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

Enumerated Values

Parameter Value
body VIEW
body MODIFY

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/calculations/{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/calculations/{id}/access \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/calculations/{id}/access

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

DELETE /api/calculations/{id}/access

deleteAccess

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

updateAccessUsingPUT

Code samples

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

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

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

};

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

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

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

};

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT /api/calculations/{id}/access

updateAccess

Permissions:
isAuthenticated()

Body parameter

"VIEW"

Parameters

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

Enumerated Values

Parameter Value
body VIEW
body MODIFY

Example responses

200 Response

Responses

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

searchGroupsUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/calculations/{id}/userGroups

searchGroups

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ResourceAccess] false none none
» permission string true none none
» id long false none Unique identifier per entity class.
» userGroup UserGroup true none none
»» systemManaged boolean false Access READ_ONLY none
»» name String 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

pageUsingGET

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

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

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

const headers = {
  'Authorization':'API_KEY'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

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

page

Permissions:
isAuthenticated()

Parameters

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

Responses

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

listUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/calculations

list

Permissions:
isAuthenticated()

Parameters

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

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

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

Enumerated Values

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

data-export-channel-api

data-export-channel-api

createUsingPOST

Code samples

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

POST /api/exportChannels

create

Permissions:
hasAnyAuthority('EXPORT_JOB_WRITE', 'EXPORT_JOB_READ')

Body parameter

{
  "name": null,
  "description": null,
  "id": null,
  "type": null,
  "parameters": null
}

Parameters

Parameter In Type Required Description
body body Channel2 true channel

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

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

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/exportChannels',
  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/exportChannels',
{
  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/exportChannels',
  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/exportChannels', params={

}, headers = headers)

print r.json()

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

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

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

page

Permissions:
hasAnyAuthority('EXPORT_JOB_WRITE', 'EXPORT_JOB_READ')

Parameters

Parameter In Type Required Description
type query undefined false type
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/exportChannels \
  -H 'Accept: */*' \
  -H 'Authorization: API_KEY'

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

GET /api/exportChannels

list

Permissions:
hasAnyAuthority('EXPORT_JOB_WRITE', 'EXPORT_JOB_READ')

Parameters

Parameter In Type Required Description
type query String false type
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 [Channel] false none none
» name String false Size (0, 127) Name of the entity.
» description String false none none
» id long false none Unique identifier per entity class.
» type String true Size (0, 64) none
» parameters Map false none none

deleteBulkUsingDELETE

Code samples

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

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

var headers = {
  'Authorization':'API_KEY'

};

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

print r.json()

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

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

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

deleteBulk

Permissions:
hasAnyAuthority('EXPORT_JOB_WRITE', 'EXPORT_JOB_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

listChannelTypesUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/exportChannels/types

listChannelTypes

Permissions:
hasAnyAuthority('EXPORT_JOB_WRITE', 'EXPORT_JOB_READ')

Example responses

200 Response

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ChannelType] false none none
» name String false none none
» properties ChannelTypeProperty false none none
»» regex String false none none
»» name String false none none
»» required boolean false none none

readUsingGET

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

GET /api/exportChannels/{id}

read

Permissions:
hasAnyAuthority('EXPORT_JOB_WRITE', 'EXPORT_JOB_READ')

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

deleteSingleUsingDELETE

Code samples

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

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

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

};

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

DELETE /api/exportChannels/{id}

deleteSingle

Permissions:
hasAnyAuthority('EXPORT_JOB_WRITE', 'EXPORT_JOB_READ')

Parameters

Parameter In Type Required Description
id path long true id

Example responses

200 Response

Responses

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

updateUsingPUT

Code samples

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

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

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

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

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/exportChannels/{id}

update

Permissions:
hasAnyAuthority('EXPORT_JOB_WRITE', 'EXPORT_JOB_READ')

Body parameter

{
  "name": null,
  "description": null,
  "id": null,
  "type": null,
  "parameters": null
}

Parameters

Parameter In Type Required Description
id path long true id
body body Channel true update

Example responses

200 Response

Responses

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

data-export-task-api

data-export-task-api

createUsingPOST

Code samples

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

POST https://api-demo.wolkabout.com/api/jobs/{jobId}/exportTasks 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/jobs/{jobId}/exportTasks',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "taskType": null,
  "factExportPeriodStart": null,
  "dimensionExportType": "ALL",
  "factExportPeriodEnd": null,
  "dataFormat": null,
  "factExportPeriod": null,
  "factExportType": "SNAPSHOT_ALL",
  "locale": null,
  "tasks": {
    "whatIsKnown": {
      "idPath": null,
      "attributeValues": null,
      "id": null
    },
    "id": null,
    "type": null,
    "whatIsNeeded": {
      "feedNames": null,
      "attributes": null,
      "eventTypes": null
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

POST /api/jobs/{jobId}/exportTasks

create

Permissions:
hasAuthority('EXPORT_JOB_WRITE')

Body parameter

{
  "taskType": null,
  "factExportPeriodStart": null,
  "dimensionExportType": "ALL",
  "factExportPeriodEnd": null,
  "dataFormat": null,
  "factExportPeriod": null,
  "factExportType": "SNAPSHOT_ALL",
  "locale": null,
  "tasks": {
    "whatIsKnown": {
      "idPath": null,
      "attributeValues": null,
      "id": null
    },
    "id": null,
    "type": null,
    "whatIsNeeded": {
      "feedNames": null,
      "attributes": null,
      "eventTypes": null
    }
  }
}

Parameters

Parameter In Type Required Description
jobId path long true jobId
body body DataExportParameters true parameters

Example responses

200 Response

Responses

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

PUT https://api-demo.wolkabout.com/api/jobs/{jobId}/exportTasks/{taskId} 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/jobs/{jobId}/exportTasks/{taskId}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "taskType": null,
  "factExportPeriodStart": null,
  "dimensionExportType": "ALL",
  "factExportPeriodEnd": null,
  "dataFormat": null,
  "factExportPeriod": null,
  "factExportType": "SNAPSHOT_ALL",
  "locale": null,
  "tasks": {
    "whatIsKnown": {
      "idPath": null,
      "attributeValues": null,
      "id": null
    },
    "id": null,
    "type": null,
    "whatIsNeeded": {
      "feedNames": null,
      "attributes": null,
      "eventTypes": null
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()

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

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

PUT /api/jobs/{jobId}/exportTasks/{taskId}

update

Permissions:
hasAuthority('EXPORT_JOB_WRITE')

Body parameter

{
  "taskType": null,
  "factExportPeriodStart": null,
  "dimensionExportType": "ALL",
  "factExportPeriodEnd": null,
  "dataFormat": null,
  "factExportPeriod": null,
  "factExportType": "SNAPSHOT_ALL",
  "locale": null,
  "tasks": {
    "whatIsKnown": {
      "idPath": null,
      "attributeValues": null,
      "id": null
    },
    "id": null,
    "type": null,
    "whatIsNeeded": {
      "feedNames": null,
      "attributes": null,
      "eventTypes": null
    }
  }
}

Parameters

Parameter In Type Required Description
jobId path long true jobId
taskId path Long true taskId
body body DataExportParameters true update

Example responses

200 Response

Responses

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

feed-state-range-api

feed-state-range-api

readUsingGET

Code samples

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

GET https://api-demo.wolkabout.com/api/feeds/{feedId}/thresholds HTTP/1.1
Host: api-demo.wolkabout.com
Accept: */*

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

};

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

p JSON.parse(result)

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

r = requests.get('https://api-demo.wolkabout.com/api/feeds/{feedId}/thresholds', params={

}, headers = headers)

print r.json()

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

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

GET /api/feeds/{feedId}/thresholds

read

Permissions:

Parameters

Parameter In Type Required Description
feedId path long true feedId

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 [Range] false none none
» start BigDecimal false none none
» end BigDecimal false none none
» state string false none none
» message String false none none

Enumerated Values

Property Value
state ERROR
state WARNING
state NORMAL

updateUsingPUT

Code samples

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

PUT https://api-demo.wolkabout.com/api/feeds/{feedId}/thresholds 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/feeds/{feedId}/thresholds',
  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':'*/*'