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

WolkAbout IoT Platform API Data Management v21.GA

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

deleteBulkUsingDELETE

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)


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

r = requests.DELETE('https://api-demo.wolkabout.com/api/mappings/{mappingId}/actuators', params={
  'ids': undefined
}, 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{
        "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:
isAuthenticated()

Description:
Deletes multiple actuator mappings from the template mapping by ids.

Parameters

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

Responses

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

createUsingPOST

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/mappings/{mappingId}/actuators',
{
  method: 'POST',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new actuator mapping on the template mapping.

Parameters

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

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/mappings/{mappingId}/actuators \
  -H 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Returns a list of actuator mappings on the mapping.

Parameters

Parameter In Type Required Description
mappingId path undefined true mappingId

Responses

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

deleteUsingDELETE

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes an actuator mapping from the template mapping.

Parameters

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

Responses

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

updateUsingPUT

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/mappings/{mappingId}/actuators/{id}',
{
  method: 'PUT',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates the actuator mapping.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

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


require 'rest-client'
require 'json'

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

result = RestClient.POST 'https://api-demo.wolkabout.com/api/advanced/devices',
  params: {
  'mappingId' => 'undefined'
}, headers: headers

p JSON.parse(result)


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

r = requests.POST('https://api-demo.wolkabout.com/api/advanced/devices', params={
  'mappingId': undefined
}, 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{
        "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:
isAuthenticated()

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

Parameters

Parameter In Type Required Description
mappingId query undefined true mappingId
parentId query undefined false parentId
newDevices body array[DeviceCreationDto] true newDevices

Responses

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

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 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes one alarm mapping from the template mapping.

Parameters

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

Responses

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

updateUsingPUT

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/mappings/{mappingId}/alarms/{id}',
{
  method: 'PUT',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates the alarm mapping on the template mapping.

Parameters

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

Responses

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

deleteBulkUsingDELETE

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)


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

r = requests.DELETE('https://api-demo.wolkabout.com/api/mappings/{mappingId}/alarms', params={
  'ids': undefined
}, 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{
        "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:
isAuthenticated()

Description:
Deletes multiple alarm mappings from the template mapping.

Parameters

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

Responses

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

createUsingPOST

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/mappings/{mappingId}/alarms',
{
  method: 'POST',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new alarm mapping on the template mapping.

Parameters

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

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/mappings/{mappingId}/alarms \
  -H 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Returns a list of alarm mappings on the template mapping.

Parameters

Parameter In Type Required Description
mappingId path undefined true mappingId

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes on attribute mapping from the template mapping.

Parameters

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

Responses

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

updateUsingPUT

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes/{id}',
{
  method: 'PUT',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates the attribute mapping on the template mapping.

Parameters

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

Responses

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

deleteBulkUsingDELETE

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)


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

r = requests.DELETE('https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes', params={
  'ids': undefined
}, 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{
        "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:
isAuthenticated()

Description:
Deletes multiple attribute mappings from the template mapping.

Parameters

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

Responses

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

createUsingPOST

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/mappings/{mappingId}/attributes',
{
  method: 'POST',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new attribute mapping on the template mapping.

Parameters

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

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/mappings/{mappingId}/attributes \
  -H 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Returns a list of attribute mappings on the template mapping.

Parameters

Parameter In Type Required Description
mappingId path undefined true mappingId

Responses

Status Meaning Description Schema
200 OK OK None
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


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



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

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


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

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

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


require 'rest-client'
require 'json'

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

p JSON.parse(result)


import requests

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

)

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() {

    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:
isAuthenticated()

Description:
Returns a list all channel types.

Responses

Status Meaning Description Schema
200 OK OK None
404 Not Found Not Found 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:
isAuthenticated()

Description:
Deletes multiple channels by ids.

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

createUsingPOST

Code samples

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


POST 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: 'POST',

  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: 'POST',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new channel.

Parameters

Parameter In Type Required Description
channel body Channel true channel

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 'Authorization: API_KEY'


GET 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',

  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',

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Returns a filtered list of channels.

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

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:
isAuthenticated()

Description:
Returns a filtered and paged list of channels.

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

deleteSingleUsingDELETE

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes the channel.

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

readUsingGET

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Returns the channel by id.

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

updateUsingPUT

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates the channel.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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:
isAuthenticated()

Description:
Return the result of the last run.

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 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Cancels the job specified by id.

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

resetJobUsingPOST

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Resets job.

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

runManuallyUsingPOST

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Manually runs the job.

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

deleteSingleUsingDELETE

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes the single specified job.

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

readUsingGET

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Reads information of the job specified by id.

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

updateUsingPUT

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates job.

Parameters

Parameter In Type Required Description
id path undefined true id
update body Job true update

Responses

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

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:
isAuthenticated()

Description:
Deletes jobs based on ids.

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

createUsingPOST

Code samples

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


POST 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: 'POST',

  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: 'POST',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates new job.

Parameters

Parameter In Type Required Description
job body Job true job

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 'Authorization: API_KEY'


GET 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',

  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',

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Return filtered list of jobs.

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

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:
isAuthenticated()

Description:
Return filtered and paged list of jobs.

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

batch-task-api

batch-task-api

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:
isAuthenticated()

Description:
Deletes multiple tasks by ids.

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

listUsingGET

Code samples

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


GET 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',

  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',

  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 '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('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{
        "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:
isAuthenticated()

Description:
Returns list of tasks that are part of the job.

Parameters

Parameter In Type Required Description
type query undefined false type
jobId path undefined true jobId

Responses

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

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/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:
isAuthenticated()

Description:
Returns paged list of tasks that are part of the job.

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

singleDeleteUsingDELETE

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes specified task.

Parameters

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

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 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Returns the specified task.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'


POST https://api-demo.wolkabout.com/api/calculations/validate HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Validates calculation.

Parameters

Parameter In Type Required Description
dto body FormulaDto true dto

Responses

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

listUsingGET

Code samples

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


GET 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',

  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',

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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()

Description:
Returns filtered list of calculations.

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

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/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()

Description:
Returns filtered and paged list of calculations.

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

data-export-channel-api

data-export-channel-api

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:
isAuthenticated()

Description:
Deletes multiple channels by ids.

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

createUsingPOST

Code samples

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


POST 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: 'POST',

  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: 'POST',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new channel.

Parameters

Parameter In Type Required Description
channel body Channel true channel

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 'Authorization: API_KEY'


GET 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',

  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',

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Returns a filtered list of channels.

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

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:
isAuthenticated()

Description:
Returns a filtered and paged list of channels.

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

listChannelTypesUsingGET

Code samples

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


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



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

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


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

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

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


require 'rest-client'
require 'json'

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

p JSON.parse(result)


import requests

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

)

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() {

    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:
isAuthenticated()

Description:
Returns a list all channel types.

Responses

Status Meaning Description Schema
200 OK OK 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 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Deletes the channel.

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

readUsingGET

Code samples

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


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


var headers = {
  '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 = {
  '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 = {
  'Authorization' => 'API_KEY'
}

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Returns the channel by id.

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

updateUsingPUT

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

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

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates the channel.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'


POST https://api-demo.wolkabout.com/api/jobs/{jobId}/exportTasks HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/jobs/{jobId}/exportTasks',
{
  method: 'POST',

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


require 'rest-client'
require 'json'

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

result = RestClient.POST 'https://api-demo.wolkabout.com/api/jobs/{jobId}/exportTasks',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Creates a new data export task on the job.

Parameters

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

Responses

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

updateUsingPUT

Code samples

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


PUT https://api-demo.wolkabout.com/api/jobs/{jobId}/exportTasks/{taskId} HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/jobs/{jobId}/exportTasks/{taskId}',
{
  method: 'PUT',

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


require 'rest-client'
require 'json'

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

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/jobs/{jobId}/exportTasks/{taskId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  '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{
        "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:
isAuthenticated()

Description:
Updates data export task.

Parameters

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

Responses

Status Meaning Description Schema
200 OK OK None
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 'Authorization: API_KEY'


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


var headers = {
  '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 = {
  '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 = {
  '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 = {
  '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{
        "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:
isAuthenticated()

Description:
Returns the list of state ranges of the feed.

Parameters

Parameter In Type Required Description
feedId path undefined true feedId

Responses

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

updateUsingPUT

Code samples

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


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


var headers = {
  '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 headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/feeds/{feedId}/thresholds',
{
  method: 'PUT',

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


require 'rest-client'
require 'json'

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

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/feeds/{feedId}/thresholds',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.PUT('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("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{
        "Authorization": []string{"API_KEY"},

    }

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

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

PUT /api/feeds/{feedId}/thresholds

update

Permissions:
isAuthenticated()

Description:
Updates the feed state ranges of the feed.

Parameters

Parameter In Type Required Description
feedId path undefined true feedId
ranges body array[Range] true ranges

Responses

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

geo-fence-api

geo-fence-api

createWithPolygonUsingPOST

Code samples

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


POST (CONTENT-TYPE: APPLICATION/VND.POLYGON+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'POST (Content-Type: application/vnd.polygon+json)',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'POST (CONTENT-TYPE: APPLICATION/VND.POLYGON+JSON)',

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


require 'rest-client'
require 'json'

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

result = RestClient.POST (Content-Type: application/vnd.polygon+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.POST (Content-Type: application/vnd.polygon+json)('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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


package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST (CONTENT-TYPE: APPLICATION/VND.POLYGON+JSON) /api/points/{pointId}/geofences

createWithPolygon

Permissions:
isAuthenticated()

Description:
Creates a new geoFence for the point with a polygon.

Parameters

Parameter In Type Required Description
pointId path undefined true pointId
dto body GeoFencePolygonDto true dto

Responses

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

updateGeoFenceWithBoundingBoxUsingPUT

Code samples

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


PUT (CONTENT-TYPE: APPLICATION/VND.BOUNDINGBOX+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'PUT (Content-Type: application/vnd.boundingbox+json)',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'PUT (CONTENT-TYPE: APPLICATION/VND.BOUNDINGBOX+JSON)',

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


require 'rest-client'
require 'json'

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

result = RestClient.PUT (Content-Type: application/vnd.boundingbox+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.PUT (Content-Type: application/vnd.boundingbox+json)('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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


package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT (CONTENT-TYPE: APPLICATION/VND.BOUNDINGBOX+JSON) /api/points/{pointId}/geofences

updateGeoFenceWithBoundingBox

Permissions:
isAuthenticated()

Description:
Updates the geoFence with a new fence area through a bounding box.

Parameters

Parameter In Type Required Description
pointId path undefined true pointId
dto body GeoHashDto true dto

Responses

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

deleteGeoFenceForPointUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/points/{pointId}/geofences \
  -H 'Authorization: API_KEY'


DELETE https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'DELETE',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'DELETE',

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

p JSON.parse(result)


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

r = requests.DELETE('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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

    }

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

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

DELETE /api/points/{pointId}/geofences

deleteGeoFenceForPoint

Permissions:
isAuthenticated()

Description:
Deletes the geoFence from the point.

Parameters

Parameter In Type Required Description
pointId path undefined true pointId

Responses

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

updateWithPolygonUsingPUT

Code samples

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


PUT (CONTENT-TYPE: APPLICATION/VND.POLYGON+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'PUT (Content-Type: application/vnd.polygon+json)',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'PUT (CONTENT-TYPE: APPLICATION/VND.POLYGON+JSON)',

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


require 'rest-client'
require 'json'

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

result = RestClient.PUT (Content-Type: application/vnd.polygon+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.PUT (Content-Type: application/vnd.polygon+json)('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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


package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

PUT (CONTENT-TYPE: APPLICATION/VND.POLYGON+JSON) /api/points/{pointId}/geofences

updateWithPolygon

Permissions:
isAuthenticated()

Description:
Updates the geoFence with a new fence area through a polygon.

Parameters

Parameter In Type Required Description
pointId path undefined true pointId
dto body GeoFencePolygonDto true dto

Responses

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

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/points/{pointId}/geofences \
  -H 'Authorization: API_KEY'


POST https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'POST',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'POST',

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


require 'rest-client'
require 'json'

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

result = RestClient.POST 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.POST('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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

    }

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

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

POST /api/points/{pointId}/geofences

create

Permissions:
isAuthenticated()

Description:
Creates a new geoFence for the point.

Parameters

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

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/points/{pointId}/geofences \
  -H 'Authorization: API_KEY'


GET https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'GET',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'GET',

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

p JSON.parse(result)


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

r = requests.GET('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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

    }

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

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

GET /api/points/{pointId}/geofences

list

Permissions:
isAuthenticated()

Description:
Returns the list of geo fences of the point.

Parameters

Parameter In Type Required Description
pointId path undefined true pointId

Responses

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

createWithBoundingBoxUsingPOST

Code samples

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


POST (CONTENT-TYPE: APPLICATION/VND.BOUNDINGBOX+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'POST (Content-Type: application/vnd.boundingbox+json)',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'POST (CONTENT-TYPE: APPLICATION/VND.BOUNDINGBOX+JSON)',

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


require 'rest-client'
require 'json'

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

result = RestClient.POST (Content-Type: application/vnd.boundingbox+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.POST (Content-Type: application/vnd.boundingbox+json)('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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


package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    }

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

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

POST (CONTENT-TYPE: APPLICATION/VND.BOUNDINGBOX+JSON) /api/points/{pointId}/geofences

createWithBoundingBox

Permissions:
isAuthenticated()

Description:
Creates a new geoFence for the point with a bounding box.

Parameters

Parameter In Type Required Description
pointId path undefined true pointId
dto body GeoHashDto true dto

Responses

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

listWithPointUsingGET

Code samples

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


GET (PRODUCES: APPLICATION/VND.GEOFENCE.WITH.POINT+JSON) https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'GET (produces: application/vnd.geofence.with.point+json)',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'GET (PRODUCES: APPLICATION/VND.GEOFENCE.WITH.POINT+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.geofence.with.point+json) 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.GET (produces: application/vnd.geofence.with.point+json)('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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

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

GET (PRODUCES: APPLICATION/VND.GEOFENCE.WITH.POINT+JSON) /api/points/{pointId}/geofences

listWithPoint

Permissions:
isAuthenticated()

Description:
Returns the list of geo fences with point of the point.

Parameters

Parameter In Type Required Description
pointId path undefined true pointId

Responses

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

updateGeoFenceUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/points/{pointId}/geofences \
  -H 'Authorization: API_KEY'


PUT https://api-demo.wolkabout.com/api/points/{pointId}/geofences HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  method: 'PUT',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
{
  method: 'PUT',

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


require 'rest-client'
require 'json'

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

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.PUT('https://api-demo.wolkabout.com/api/points/{pointId}/geofences', params={

}, headers = headers)

print r.json()


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

    }

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

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

PUT /api/points/{pointId}/geofences

updateGeoFence

Permissions:
isAuthenticated()

Description:
Updates the geoFence with a new fence area.

Parameters

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

Responses

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

rebuildUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/points/{pointId}/geofences/rebuildings \
  -H 'Authorization: API_KEY'


POST https://api-demo.wolkabout.com/api/points/{pointId}/geofences/rebuildings HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences/rebuildings',
  method: 'POST',

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


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

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/points/{pointId}/geofences/rebuildings',
{
  method: 'POST',

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


require 'rest-client'
require 'json'

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

result = RestClient.POST 'https://api-demo.wolkabout.com/api/points/{pointId}/geofences/rebuildings',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.POST('https://api-demo.wolkabout.com/api/points/{pointId}/geofences/rebuildings', params={

}, headers = headers)

print r.json()


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

    }

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

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

POST /api/points/{pointId}/geofences/rebuildings

rebuild

Permissions:
isAuthenticated()

Description:
Creates polygon points for fences that are created without.

Responses

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

geo-fence-base-api

geo-fence-base-api

listUsingGET

Code samples

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


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


var headers = {
  'Authorization':'API_KEY'

};

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

  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/geofences',
{
  method: 'GET',

  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 'https://api-demo.wolkabout.com/api/geofences',
  params: {
  'latitude' => 'undefined',
'longitude' => 'undefined'
}, headers: headers

p JSON.parse(result)


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

r = requests.GET('https://api-demo.wolkabout.com/api/geofences', params={
  'latitude': undefined,  'longitude': undefined
}, headers = headers)

print r.json()


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

    }

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

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

GET /api/geofences

list

Permissions:
isAuthenticated()

Description:
Returns a list of geoFences that contain the location defined by latitude and longitude.

Parameters

Parameter In Type Required Description
latitude query undefined true latitude
longitude query undefined true longitude
fenceArea query undefined false fenceArea

Responses

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

geo-fence-config-api

geo-fence-config-api

createUsingPOST

Code samples

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


POST https://api-demo.wolkabout.com/api/geofenceConfigs HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

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

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

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


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

    }

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

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

POST /api/geofenceConfigs

create

Permissions:
isAuthenticated()

Description:
Creates a new geoFence configuration.

Parameters

Parameter In Type Required Description
config body GeoFenceConfig true config

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


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


var headers = {
  'Authorization':'API_KEY'

};

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

  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/geofenceConfigs',
{
  method: 'GET',

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

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


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

    }

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

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

GET /api/geofenceConfigs

list

Permissions:
isAuthenticated()

Description:
Returns a list of geoFence configurations.

Responses

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

pageUsingGET

Code samples

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


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


var headers = {
  'Authorization':'API_KEY'

};

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

}, headers = headers)

print r.json()


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

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

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

page

Permissions:
isAuthenticated()

Description:
Returns a paged list of geoFence configurations.

Responses

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

deleteUsingDELETE

Code samples

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


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


var headers = {
  'Authorization':'API_KEY'

};

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

  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/geofenceConfigs/{id}',
{
  method: 'DELETE',

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

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


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

    }

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

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

DELETE /api/geofenceConfigs/{id}

delete

Permissions:
isAuthenticated()

Description:
Deletes the geoFence configuration.

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

readUsingGET

Code samples

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


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


var headers = {
  'Authorization':'API_KEY'

};

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

  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/geofenceConfigs/{id}',
{
  method: 'GET',

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

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


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

    }

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

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

GET /api/geofenceConfigs/{id}

read

Permissions:
isAuthenticated()

Description:
Returns the geoFence configuration by id.

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

updateUsingPUT

Code samples

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


PUT https://api-demo.wolkabout.com/api/geofenceConfigs/{id} HTTP/1.1
Host: api-demo.wolkabout.com


var headers = {
  'Authorization':'API_KEY'

};

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

  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/geofenceConfigs/{id}',
{
  method: 'PUT',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


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

    }

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

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

PUT /api/geofenceConfigs/{id}

update

Permissions:
isAuthenticated()

Description:
Updates the geoFence configuration.

Parameters

Parameter In Type Required Description
id path undefined true id
dto body GeoFenceConfig true dto

Responses

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

legacy-data-export-job-api

legacy-data-export-job-api

getFormattersUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/exportJobs/formatters


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



$.ajax({
  url: 'https://api-demo.wolkabout.com/api/exportJobs/formatters',
  method: 'GET',

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


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

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

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