Leverege Api v1.0.0

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

The Leverege API is a collection of endpoints used to interface with the api-server. This includes commands to manipulate Projects, Systems, and Devices, as well as all the supporting features used to bring implement your business logic such as Reason Scripts, Templates, Message Routing, and more.

Email: Leverege Support Web: Leverege Support License: LICENSE.md

Authentication

• HTTP Authentication, scheme: bearer Uses a JWT token passed in the request header under Authorization in the format Bearer {token}

• HTTP Authentication, scheme: bearer Uses a OAuth 1 two-legged passport Authorization scheme. This is meant for server to server communications.

Project

Project requests

Get all Projects

Code samples

# You can also use wget
curl -X GET /v1/project \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of projects	ProjectList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Project

Code samples

# You can also use wget
curl -X POST /v1/project/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "name": "My Project",
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "active": true,
  "created": 1542662533210,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/

Body parameter

{
  "name": "My Project",
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "active": true,
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
body	body	Project	false	The data for the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The project that was created	Project
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Verify the user login

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/verify \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/verify',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/verify', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/verify',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/verify

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The project	Project
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The project	Project
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The project that was updated	Project
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Project
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Access

Create a undefined login

Code samples

# You can also use wget
curl -X POST /v1/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/login',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/login', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/login',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/login

Body parameter

{
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	The data for the undefined
» name	body	string	false	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	The undefined that was created	None
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Get a undefined view resetPassword

Code samples

# You can also use wget
curl -X GET /v1/view/resetPassword \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/view/resetPassword',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/view/resetPassword', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/view/resetPassword',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/view/resetPassword

Example responses

403 Response

Responses

Status	Meaning	Description	Schema
200	OK	The undefined	None
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Get a undefined view error

Code samples

# You can also use wget
curl -X GET /v1/view/error \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/view/error',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/view/error', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/view/error',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/view/error

Example responses

403 Response

Responses

Status	Meaning	Description	Schema
200	OK	The undefined	None
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Get a undefined view activateAccount

Code samples

# You can also use wget
curl -X GET /v1/view/activateAccount \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/view/activateAccount',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/view/activateAccount', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/view/activateAccount',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/view/activateAccount

Example responses

403 Response

Responses

Status	Meaning	Description	Schema
200	OK	The undefined	None
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Verify the user login

Code samples

# You can also use wget
curl -X GET /v1/verify \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/verify',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/verify', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/verify',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/verify

Example responses

403 Response

Responses

Status	Meaning	Description	Schema
200	OK	The undefined	None
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Get a undefined register

Code samples

# You can also use wget
curl -X GET /v1/register \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/register',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/register', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/register',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/register

Example responses

403 Response

Responses

Status	Meaning	Description	Schema
200	OK	The undefined	None
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

User

Send user a forgotPassword email

Code samples

# You can also use wget
curl -X POST /v1/user/forgotPassword \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user/forgotPassword',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/user/forgotPassword', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/user/forgotPassword',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/user/forgotPassword

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
body	body	User	false	The data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a User resetPassword

Code samples

# You can also use wget
curl -X POST /v1/user/resetPassword \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user/resetPassword',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/user/resetPassword', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/user/resetPassword',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/user/resetPassword

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
body	body	User	false	The data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Users from the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/user \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/user',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/user', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/user',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/user

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of users	UserList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a User in the System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/user \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/user',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/user', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/user',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/user

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
body	body	User	false	The data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a User in the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/user/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/user/{userId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/user/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a User in the System

Code samples

# You can also use wget
curl -X PATCH /v1/system/{systemId}/user/{userId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/user/{userId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/system/{systemId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/system/{systemId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/system/{systemId}/user/{userId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was updated	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a User from the System

Code samples

# You can also use wget
curl -X DELETE /v1/system/{systemId}/user/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/user/{userId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/system/{systemId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/system/{systemId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/system/{systemId}/user/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Users from the Device

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId}/user \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/user',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}/user', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}/user',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}/user

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of users	UserList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a User in the Device

Code samples

# You can also use wget
curl -X POST /v1/device/{deviceId}/user \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/user',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/device/{deviceId}/user', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/device/{deviceId}/user',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/device/{deviceId}/user

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	User	false	The data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Users from the Device and the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId}/user \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/user',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}/user', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}/user',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}/user

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of users	UserList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a User in the Device and System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/device/{deviceId}/user \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/user',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/device/{deviceId}/user', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/device/{deviceId}/user',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/device/{deviceId}/user

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	User	false	The data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a User in the Device

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId}/user/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/user/{userId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}/user/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a User in the Device

Code samples

# You can also use wget
curl -X PATCH /v1/device/{deviceId}/user/{userId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/user/{userId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/device/{deviceId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/device/{deviceId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/device/{deviceId}/user/{userId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
deviceId	path	string	true	The id of the Device
body	body	PatchOps	false	The update data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was updated	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a User from the Device

Code samples

# You can also use wget
curl -X DELETE /v1/device/{deviceId}/user/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/user/{userId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/device/{deviceId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/device/{deviceId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/device/{deviceId}/user/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets the User in the Device and System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId}/user/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/user/{userId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}/user/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a User in the Device and System

Code samples

# You can also use wget
curl -X PATCH /v1/system/{systemId}/device/{deviceId}/user/{userId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/user/{userId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/system/{systemId}/device/{deviceId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/system/{systemId}/device/{deviceId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/system/{systemId}/device/{deviceId}/user/{userId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was updated	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a User from the Device and System

Code samples

# You can also use wget
curl -X DELETE /v1/system/{systemId}/device/{deviceId}/user/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/user/{userId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/system/{systemId}/device/{deviceId}/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/system/{systemId}/device/{deviceId}/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/system/{systemId}/device/{deviceId}/user/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get all Users

Code samples

# You can also use wget
curl -X GET /v1/user \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/user', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/user',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/user

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of users	UserList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a User

Code samples

# You can also use wget
curl -X POST /v1/user \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/user', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/user',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/user

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
body	body	User	false	The data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a User

Code samples

# You can also use wget
curl -X GET /v1/user/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user/{userId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/user/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a User

Code samples

# You can also use wget
curl -X PATCH /v1/user/{userId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user/{userId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/user/{userId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
body	body	PatchOps	false	The update data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was updated	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a User

Code samples

# You can also use wget
curl -X DELETE /v1/user/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user/{userId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/user/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/user/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Username

Code samples

# You can also use wget
curl -X GET /v1/username/{name} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/username/{name}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/username/{name}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/username/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/username/{name}

Parameters

Name	In	Type	Required	Description
name	path	string	true	The id of the Username

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The username	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Username in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/username/{name} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/username/{name}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/username/{name}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/username/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/username/{name}

Parameters

Name	In	Type	Required	Description
name	path	string	true	The id of the Username
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The username	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Change the password

Code samples

# You can also use wget
curl -X POST /v1/user/{userId}/changePassword \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user/{userId}/changePassword',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/user/{userId}/changePassword', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/user/{userId}/changePassword',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/user/{userId}/changePassword

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User
body	body	User	false	The data for the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The user that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Member

Gets all Members from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/member \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/member',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/member', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/member',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/member

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of members	UserList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Member in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/member \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/member',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/member', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/member',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/member

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	User	false	The data for the Member

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The member that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Member in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/member/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/member/{userId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/member/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/member/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/member/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the Member
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The member	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Member in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/member/{userId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/member/{userId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/member/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/member/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/member/{userId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the Member
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Member

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The member that was updated	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Member from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/member/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/member/{userId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/member/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/member/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/member/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the Member
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Events

Gets all Eventss from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{myProjectId}/events \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{myProjectId}/events',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{myProjectId}/events', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{myProjectId}/events',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{myProjectId}/events

Parameters

Name	In	Type	Required	Description
myProjectId	path	string	true	The id of the Project

Example responses

403 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of eventss	None
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Gets all Eventss from the Device and the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId}/events \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/events',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}/events', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}/events',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}/events

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

403 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of eventss	None
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Create a Events in the Device and System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/device/{deviceId}/events \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = 'false';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/events',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/device/{deviceId}/events', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/device/{deviceId}/events',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/device/{deviceId}/events

Body parameter

false

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	The events that was created	None
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Gets all Eventss from the Device

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId}/events \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/events',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}/events', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}/events',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}/events

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

403 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of eventss	None
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Create a Events in the Device

Code samples

# You can also use wget
curl -X POST /v1/device/{deviceId}/events \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = 'false';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/events',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/device/{deviceId}/events', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/device/{deviceId}/events',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/device/{deviceId}/events

Body parameter

false

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	The events that was created	None
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Create a Events in the Device and System ack

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/device/{deviceId}/events/{eventId}/ack \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = 'false';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/events/{eventId}/ack',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/device/{deviceId}/events/{eventId}/ack', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/device/{deviceId}/events/{eventId}/ack',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/device/{deviceId}/events/{eventId}/ack

Body parameter

false

Parameters

Name	In	Type	Required	Description
eventId	path	string	true	The id of the Events
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	The events that was created	None
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Create a Events in the Device ack

Code samples

# You can also use wget
curl -X POST /v1/device/{deviceId}/events/{eventId}/ack \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = 'false';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/events/{eventId}/ack',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/device/{deviceId}/events/{eventId}/ack', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/device/{deviceId}/events/{eventId}/ack',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/device/{deviceId}/events/{eventId}/ack

Body parameter

false

Parameters

Name	In	Type	Required	Description
eventId	path	string	true	The id of the Events
deviceId	path	string	true	The id of the Device

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	The events that was created	None
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Response Schema

Device

Get history through the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/device/history \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/device/history',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/device/history', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/device/history',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/device/history

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of devices	DeviceList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get Events through the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/device/events \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/device/events',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/device/events', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/device/events',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/device/events

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of devices	DeviceList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Devices from the System and the Project history

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/system/{systemId}/device/history \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/system/{systemId}/device/history',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/system/{systemId}/device/history', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/system/{systemId}/device/history',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/system/{systemId}/device/history

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of devices	DeviceList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get history through the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId}/history \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/history',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}/history', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}/history',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}/history

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Devices from the System and the Project events

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/system/{systemId}/device/events \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/system/{systemId}/device/events',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/system/{systemId}/device/events', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/system/{systemId}/device/events',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/system/{systemId}/device/events

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of devices	DeviceList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get Events through the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/events \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/events',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/events', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/events',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/events

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of devices	DeviceList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Devices from the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of devices	DeviceList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Device in the System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/device \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/device', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/device',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/device

Body parameter

{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
body	body	Device	false	The data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was created	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Device in the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Device in the System

Code samples

# You can also use wget
curl -X PATCH /v1/system/{systemId}/device/{deviceId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/system/{systemId}/device/{deviceId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/system/{systemId}/device/{deviceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/system/{systemId}/device/{deviceId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Device from the System

Code samples

# You can also use wget
curl -X DELETE /v1/system/{systemId}/device/{deviceId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/system/{systemId}/device/{deviceId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/system/{systemId}/device/{deviceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/system/{systemId}/device/{deviceId}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Device

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Device

Code samples

# You can also use wget
curl -X PATCH /v1/device/{deviceId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/device/{deviceId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/device/{deviceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/device/{deviceId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Device

Code samples

# You can also use wget
curl -X DELETE /v1/device/{deviceId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/device/{deviceId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/device/{deviceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/device/{deviceId}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Send a message to the Device via the System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/device/{deviceId}/sendMessage \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/sendMessage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/device/{deviceId}/sendMessage', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/device/{deviceId}/sendMessage',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/device/{deviceId}/sendMessage

Body parameter

{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	Device	false	The data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was created	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Send a message to the Device

Code samples

# You can also use wget
curl -X POST /v1/device/{deviceId}/sendMessage \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/sendMessage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/device/{deviceId}/sendMessage', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/device/{deviceId}/sendMessage',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/device/{deviceId}/sendMessage

Body parameter

{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	Device	false	The data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was created	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Start a scenario on the Device via the System

Code samples

# You can also use wget
curl -X PUT /v1/system/{systemId}/device/{deviceId}/start \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/start',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/system/{systemId}/device/{deviceId}/start', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/system/{systemId}/device/{deviceId}/start',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/system/{systemId}/device/{deviceId}/start

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Start a scenario on the Device

Code samples

# You can also use wget
curl -X PUT /v1/device/{deviceId}/start \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/start',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/device/{deviceId}/start', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/device/{deviceId}/start',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/device/{deviceId}/start

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Pause a scenario on the Device via the System

Code samples

# You can also use wget
curl -X PUT /v1/system/{systemId}/device/{deviceId}/pause \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/pause',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/system/{systemId}/device/{deviceId}/pause', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/system/{systemId}/device/{deviceId}/pause',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/system/{systemId}/device/{deviceId}/pause

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Pause a scenario on the Device

Code samples

# You can also use wget
curl -X PUT /v1/device/{deviceId}/pause \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/pause',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/device/{deviceId}/pause', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/device/{deviceId}/pause',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/device/{deviceId}/pause

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Reset a scenario on the Device via the System

Code samples

# You can also use wget
curl -X PUT /v1/system/{systemId}/device/{deviceId}/reset \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/reset',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/system/{systemId}/device/{deviceId}/reset', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/system/{systemId}/device/{deviceId}/reset',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/system/{systemId}/device/{deviceId}/reset

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Reset a scenario on the Device

Code samples

# You can also use wget
curl -X PUT /v1/device/{deviceId}/reset \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/reset',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/device/{deviceId}/reset', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/device/{deviceId}/reset',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/device/{deviceId}/reset

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Device in the System updater

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId}/updater \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/updater',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}/updater', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}/updater',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}/updater

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Replace a Device's data in the System updater

Code samples

# You can also use wget
curl -X PUT /v1/system/{systemId}/device/{deviceId}/updater \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/updater',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/system/{systemId}/device/{deviceId}/updater', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/system/{systemId}/device/{deviceId}/updater',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/system/{systemId}/device/{deviceId}/updater

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Device updater

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId}/updater \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/updater',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}/updater', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}/updater',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}/updater

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Replace the data of a Device updater

Code samples

# You can also use wget
curl -X PUT /v1/device/{deviceId}/updater \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/updater',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/device/{deviceId}/updater', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/device/{deviceId}/updater',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/device/{deviceId}/updater

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Set a value on the Device via the System

Code samples

# You can also use wget
curl -X PUT /v1/system/{systemId}/device/{deviceId}/setValue \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/setValue',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/system/{systemId}/device/{deviceId}/setValue', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/system/{systemId}/device/{deviceId}/setValue',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/system/{systemId}/device/{deviceId}/setValue

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Set a value on the Device

Code samples

# You can also use wget
curl -X PUT /v1/device/{deviceId}/setValue \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/setValue',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/device/{deviceId}/setValue', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/device/{deviceId}/setValue',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/device/{deviceId}/setValue

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	PatchOps	false	The update data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was updated	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get history through the System (deprecated)

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId}/historical \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/historical',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}/historical', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}/historical',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}/historical

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get history (deprecated)

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId}/historical \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/historical',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}/historical', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}/historical',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}/historical

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get history

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId}/history \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/history',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}/history', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}/history',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}/history

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Verify the user login for the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId}/verify \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/verify',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}/verify', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}/verify',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}/verify

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Verify the user login

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId}/verify \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/verify',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}/verify', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}/verify',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}/verify

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device	Device
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a user for the Device

Code samples

# You can also use wget
curl -X POST /v1/device/{deviceId}/createUser \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/createUser',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/device/{deviceId}/createUser', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/device/{deviceId}/createUser',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/device/{deviceId}/createUser

Body parameter

{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
body	body	Device	false	The data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was created	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a user for the Device via the System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/device/{deviceId}/createUser \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/createUser',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/device/{deviceId}/createUser', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/device/{deviceId}/createUser',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/device/{deviceId}/createUser

Body parameter

{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	Device	false	The data for the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The device that was created	Device
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Devices from the User

Code samples

# You can also use wget
curl -X GET /v1/user/{userId}/device \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user/{userId}/device',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/user/{userId}/device', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/user/{userId}/device',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/user/{userId}/device

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of devices	DeviceList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Blueprint

Gets all Blueprints from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/blueprint \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/blueprint', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/blueprint',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/blueprint

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of blueprints	BlueprintList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Blueprint in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/blueprint \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "01NKW8H2w0vrgIAxfWDW12",
  "name": "Ship",
  "alias": "ship",
  "projectId": "Jn123HasdnNA900cdFG1AX",
  "purpose": "device",
  "created": 1542662533210,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/blueprint', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/blueprint',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/blueprint

Body parameter

{
  "id": "01NKW8H2w0vrgIAxfWDW12",
  "name": "Ship",
  "alias": "ship",
  "projectId": "Jn123HasdnNA900cdFG1AX",
  "purpose": "device",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	Blueprint	false	The data for the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The blueprint that was created	Blueprint
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Blueprint

Code samples

# You can also use wget
curl -X GET /v1/blueprint/{blueprintId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/blueprint/{blueprintId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/blueprint/{blueprintId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/blueprint/{blueprintId}

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The blueprint	Blueprint
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Blueprint

Code samples

# You can also use wget
curl -X PATCH /v1/blueprint/{blueprintId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/blueprint/{blueprintId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/blueprint/{blueprintId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/blueprint/{blueprintId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
body	body	PatchOps	false	The update data for the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The blueprint that was updated	Blueprint
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Blueprint

Code samples

# You can also use wget
curl -X DELETE /v1/blueprint/{blueprintId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/blueprint/{blueprintId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/blueprint/{blueprintId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/blueprint/{blueprintId}

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Blueprint
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Blueprint in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/blueprint/{blueprintId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/blueprint/{blueprintId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/blueprint/{blueprintId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/blueprint/{blueprintId}

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The blueprint	Blueprint
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Blueprint in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/blueprint/{blueprintId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/blueprint/{blueprintId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/blueprint/{blueprintId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/blueprint/{blueprintId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The blueprint that was updated	Blueprint
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Blueprint from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/blueprint/{blueprintId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/blueprint/{blueprintId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/blueprint/{blueprintId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/blueprint/{blueprintId}

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Blueprint
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Simulate a blueprint

Code samples

# You can also use wget
curl -X POST /v1/blueprint/{blueprintId}/simulate \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "01NKW8H2w0vrgIAxfWDW12",
  "name": "Ship",
  "alias": "ship",
  "projectId": "Jn123HasdnNA900cdFG1AX",
  "purpose": "device",
  "created": 1542662533210,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}/simulate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/blueprint/{blueprintId}/simulate', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/blueprint/{blueprintId}/simulate',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/blueprint/{blueprintId}/simulate

Body parameter

{
  "id": "01NKW8H2w0vrgIAxfWDW12",
  "name": "Ship",
  "alias": "ship",
  "projectId": "Jn123HasdnNA900cdFG1AX",
  "purpose": "device",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
body	body	Blueprint	false	The data for the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The blueprint that was created	Blueprint
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Simulate a blueprint via the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/blueprint/{blueprintId}/simulate \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "01NKW8H2w0vrgIAxfWDW12",
  "name": "Ship",
  "alias": "ship",
  "projectId": "Jn123HasdnNA900cdFG1AX",
  "purpose": "device",
  "created": 1542662533210,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}/simulate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/blueprint/{blueprintId}/simulate', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/blueprint/{blueprintId}/simulate',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/blueprint/{blueprintId}/simulate

Body parameter

{
  "id": "01NKW8H2w0vrgIAxfWDW12",
  "name": "Ship",
  "alias": "ship",
  "projectId": "Jn123HasdnNA900cdFG1AX",
  "purpose": "device",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project
body	body	Blueprint	false	The data for the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The blueprint that was created	Blueprint
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Blueprint attributes

Code samples

# You can also use wget
curl -X DELETE /v1/blueprint/{blueprintId}/attributes \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}/attributes',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/blueprint/{blueprintId}/attributes', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/blueprint/{blueprintId}/attributes',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/blueprint/{blueprintId}/attributes

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Blueprint
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Blueprint from the Project attributes

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/blueprint/{blueprintId}/attributes \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}/attributes',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/blueprint/{blueprintId}/attributes', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/blueprint/{blueprintId}/attributes',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/blueprint/{blueprintId}/attributes

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Blueprint
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Attribute

Gets all Attributes from the Blueprint

Code samples

# You can also use wget
curl -X GET /v1/blueprint/{blueprintId}/attribute \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}/attribute',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/blueprint/{blueprintId}/attribute', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/blueprint/{blueprintId}/attribute',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/blueprint/{blueprintId}/attribute

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of attributes	AttributeList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Attribute in the Blueprint

Code samples

# You can also use wget
curl -X POST /v1/blueprint/{blueprintId}/attribute \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "name": "Latitude",
  "type": "number",
  "path": "position/lat",
  "source": "device",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "created": 1542662533210,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}/attribute',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/blueprint/{blueprintId}/attribute', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/blueprint/{blueprintId}/attribute',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/blueprint/{blueprintId}/attribute

Body parameter

{
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "name": "Latitude",
  "type": "number",
  "path": "position/lat",
  "source": "device",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
body	body	Attribute	false	The data for the Attribute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The attribute that was created	Attribute
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Attributes from the Blueprint and the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/blueprint/{blueprintId}/attribute \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}/attribute',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/blueprint/{blueprintId}/attribute', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/blueprint/{blueprintId}/attribute',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/blueprint/{blueprintId}/attribute

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of attributes	AttributeList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Attribute in the Blueprint and Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/blueprint/{blueprintId}/attribute \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "name": "Latitude",
  "type": "number",
  "path": "position/lat",
  "source": "device",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "created": 1542662533210,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}/attribute',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/blueprint/{blueprintId}/attribute', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/blueprint/{blueprintId}/attribute',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/blueprint/{blueprintId}/attribute

Body parameter

{
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "name": "Latitude",
  "type": "number",
  "path": "position/lat",
  "source": "device",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project
body	body	Attribute	false	The data for the Attribute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The attribute that was created	Attribute
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Attribute

Code samples

# You can also use wget
curl -X GET /v1/attribute/{attributeId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/attribute/{attributeId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/attribute/{attributeId}

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The attribute	Attribute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Attribute

Code samples

# You can also use wget
curl -X PATCH /v1/attribute/{attributeId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/attribute/{attributeId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/attribute/{attributeId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute
body	body	PatchOps	false	The update data for the Attribute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The attribute that was updated	Attribute
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Attribute

Code samples

# You can also use wget
curl -X DELETE /v1/attribute/{attributeId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/attribute/{attributeId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/attribute/{attributeId}

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Attribute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Attribute in the Blueprint

Code samples

# You can also use wget
curl -X GET /v1/blueprint/{blueprintId}/attribute/{attributeId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}/attribute/{attributeId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/blueprint/{blueprintId}/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/blueprint/{blueprintId}/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/blueprint/{blueprintId}/attribute/{attributeId}

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute
blueprintId	path	string	true	The id of the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The attribute	Attribute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Attribute in the Blueprint

Code samples

# You can also use wget
curl -X PATCH /v1/blueprint/{blueprintId}/attribute/{attributeId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}/attribute/{attributeId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/blueprint/{blueprintId}/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/blueprint/{blueprintId}/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/blueprint/{blueprintId}/attribute/{attributeId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute
blueprintId	path	string	true	The id of the Blueprint
body	body	PatchOps	false	The update data for the Attribute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The attribute that was updated	Attribute
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Attribute from the Blueprint

Code samples

# You can also use wget
curl -X DELETE /v1/blueprint/{blueprintId}/attribute/{attributeId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/blueprint/{blueprintId}/attribute/{attributeId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/blueprint/{blueprintId}/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/blueprint/{blueprintId}/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/blueprint/{blueprintId}/attribute/{attributeId}

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute
blueprintId	path	string	true	The id of the Blueprint

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Attribute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets the Attribute in the Blueprint and Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The attribute	Attribute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Attribute in the Blueprint and Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Attribute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The attribute that was updated	Attribute
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Attribute from the Blueprint and Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/blueprint/{blueprintId}/attribute/{attributeId}

Parameters

Name	In	Type	Required	Description
attributeId	path	string	true	The id of the Attribute
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Attribute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

System

Gets all Systems from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/system \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/system',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/system', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/system',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/system

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of systems	SystemList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a System in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/system \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "07B66DZJBAZ4kdtOWolT7C",
  "projectId": "5qTlcWjEz7qkKac52Kc1Ll",
  "name": "Test System",
  "created": 1542662767139,
  "lastModified": 1542662767139
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/system',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/system', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/system',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/system

Body parameter

{
  "id": "07B66DZJBAZ4kdtOWolT7C",
  "projectId": "5qTlcWjEz7qkKac52Kc1Ll",
  "name": "Test System",
  "created": 1542662767139,
  "lastModified": 1542662767139
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	System	false	The data for the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The system that was created	System
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Verify the user login for the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/system/{systemId}/verify \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/system/{systemId}/verify',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/system/{systemId}/verify', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/system/{systemId}/verify',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/system/{systemId}/verify

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The system	System
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Verify the user login

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/verify \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/verify',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/verify', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/verify',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/verify

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The system	System
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The system	System
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a System

Code samples

# You can also use wget
curl -X PATCH /v1/system/{systemId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/system/{systemId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/system/{systemId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/system/{systemId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The system that was updated	System
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a System

Code samples

# You can also use wget
curl -X DELETE /v1/system/{systemId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/system/{systemId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/system/{systemId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/system/{systemId}

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	System
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a System from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/system/{systemId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/system/{systemId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/system/{systemId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/system/{systemId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/system/{systemId}

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	System
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a user for the System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/createUser \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "07B66DZJBAZ4kdtOWolT7C",
  "projectId": "5qTlcWjEz7qkKac52Kc1Ll",
  "name": "Test System",
  "created": 1542662767139,
  "lastModified": 1542662767139
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/createUser',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/createUser', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/createUser',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/createUser

Body parameter

{
  "id": "07B66DZJBAZ4kdtOWolT7C",
  "projectId": "5qTlcWjEz7qkKac52Kc1Ll",
  "name": "Test System",
  "created": 1542662767139,
  "lastModified": 1542662767139
}

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
body	body	System	false	The data for the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The system that was created	System
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a System userDevice

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/userDevice \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/userDevice',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/userDevice', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/userDevice',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/userDevice

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The system	System
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Systems from the User

Code samples

# You can also use wget
curl -X GET /v1/user/{userId}/system \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/user/{userId}/system',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/user/{userId}/system', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/user/{userId}/system',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/user/{userId}/system

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the User

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of systems	SystemList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

MessageRoute

Gets all MessageRoutes from the Device and the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/device/{deviceId}/messageRoute \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/messageRoute',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/device/{deviceId}/messageRoute', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/device/{deviceId}/messageRoute',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/device/{deviceId}/messageRoute

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of messageRoutes	MessageRouteList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all MessageRoutes from the Device

Code samples

# You can also use wget
curl -X GET /v1/device/{deviceId}/messageRoute \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/device/{deviceId}/messageRoute',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/device/{deviceId}/messageRoute', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/device/{deviceId}/messageRoute',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/device/{deviceId}/messageRoute

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of messageRoutes	MessageRouteList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all MessageRoutes from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/messageRoute \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/messageRoute',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/messageRoute', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/messageRoute',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/messageRoute

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of messageRoutes	MessageRouteList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a MessageRoute in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/messageRoute \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "66PdsJg2NeIP4UF6M08krh",
  "projectId": "2gPhr582lIQed2cIZczr2Y",
  "name": "My Message Route",
  "routes": {
    "deviceDataEventMsg": [
      "writer",
      "cacheClearTest"
    ]
  },
  "created": 1548429946278,
  "lastModified": 1548430653786
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/messageRoute',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/messageRoute', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/messageRoute',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/messageRoute

Body parameter

{
  "id": "66PdsJg2NeIP4UF6M08krh",
  "projectId": "2gPhr582lIQed2cIZczr2Y",
  "name": "My Message Route",
  "routes": {
    "deviceDataEventMsg": [
      "writer",
      "cacheClearTest"
    ]
  },
  "created": 1548429946278,
  "lastModified": 1548430653786
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	MessageRoute	false	The data for the MessageRoute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The messageRoute that was created	MessageRoute
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a MessageRoute

Code samples

# You can also use wget
curl -X GET /v1/messageRoute/{messageRouteId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/messageRoute/{messageRouteId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/messageRoute/{messageRouteId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/messageRoute/{messageRouteId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/messageRoute/{messageRouteId}

Parameters

Name	In	Type	Required	Description
messageRouteId	path	string	true	The id of the MessageRoute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The messageRoute	MessageRoute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a MessageRoute

Code samples

# You can also use wget
curl -X PATCH /v1/messageRoute/{messageRouteId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/messageRoute/{messageRouteId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/messageRoute/{messageRouteId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/messageRoute/{messageRouteId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/messageRoute/{messageRouteId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
messageRouteId	path	string	true	The id of the MessageRoute
body	body	PatchOps	false	The update data for the MessageRoute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The messageRoute that was updated	MessageRoute
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a MessageRoute

Code samples

# You can also use wget
curl -X DELETE /v1/messageRoute/{messageRouteId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/messageRoute/{messageRouteId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/messageRoute/{messageRouteId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/messageRoute/{messageRouteId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/messageRoute/{messageRouteId}

Parameters

Name	In	Type	Required	Description
messageRouteId	path	string	true	The id of the MessageRoute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	MessageRoute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a MessageRoute in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/messageRoute/{messageRouteId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/messageRoute/{messageRouteId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/messageRoute/{messageRouteId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/messageRoute/{messageRouteId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/messageRoute/{messageRouteId}

Parameters

Name	In	Type	Required	Description
messageRouteId	path	string	true	The id of the MessageRoute
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The messageRoute	MessageRoute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a MessageRoute in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/messageRoute/{messageRouteId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/messageRoute/{messageRouteId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/messageRoute/{messageRouteId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/messageRoute/{messageRouteId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/messageRoute/{messageRouteId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
messageRouteId	path	string	true	The id of the MessageRoute
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the MessageRoute

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The messageRoute that was updated	MessageRoute
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a MessageRoute from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/messageRoute/{messageRouteId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/messageRoute/{messageRouteId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/messageRoute/{messageRouteId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/messageRoute/{messageRouteId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/messageRoute/{messageRouteId}

Parameters

Name	In	Type	Required	Description
messageRouteId	path	string	true	The id of the MessageRoute
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	MessageRoute
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Timer

Gets all Timers from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/timer \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/timer',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/timer', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/timer',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/timer

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of timers	TimerList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Timer in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/timer \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "4Xq90wJpvfinPuaZS3UHrE",
  "projectId": "3hmJaHtyUQA3jbGo2xhoz4",
  "name": "My Timer",
  "timer": {
    "delay": 1000,
    "type": "once"
  },
  "action": {
    "message": {
      "message": {
        "type": "reasonRunScript"
      },
      "options": {
        "reasoner": {
          "foo": "bar",
          "id": "6Nl60VvupiwNORIWfOF0e1"
        }
      },
      "type": "routeMsg"
    },
    "topic": "reason",
    "type": "publishTopic"
  },
  "created": 1528203289607,
  "lastModified": 1528204061858
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/timer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/timer', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/timer',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/timer

Body parameter

{
  "id": "4Xq90wJpvfinPuaZS3UHrE",
  "projectId": "3hmJaHtyUQA3jbGo2xhoz4",
  "name": "My Timer",
  "timer": {
    "delay": 1000,
    "type": "once"
  },
  "action": {
    "message": {
      "message": {
        "type": "reasonRunScript"
      },
      "options": {
        "reasoner": {
          "foo": "bar",
          "id": "6Nl60VvupiwNORIWfOF0e1"
        }
      },
      "type": "routeMsg"
    },
    "topic": "reason",
    "type": "publishTopic"
  },
  "created": 1528203289607,
  "lastModified": 1528204061858
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	Timer	false	The data for the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer that was created	Timer
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Timer

Code samples

# You can also use wget
curl -X GET /v1/timer/{timerId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/timer/{timerId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/timer/{timerId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/timer/{timerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/timer/{timerId}

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer	Timer
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Timer

Code samples

# You can also use wget
curl -X PATCH /v1/timer/{timerId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/timer/{timerId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/timer/{timerId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/timer/{timerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/timer/{timerId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer
body	body	PatchOps	false	The update data for the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer that was updated	Timer
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Timer

Code samples

# You can also use wget
curl -X DELETE /v1/timer/{timerId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/timer/{timerId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/timer/{timerId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/timer/{timerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/timer/{timerId}

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Timer
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Timer in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/timer/{timerId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/timer/{timerId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/timer/{timerId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/timer/{timerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/timer/{timerId}

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer	Timer
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Timer in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/timer/{timerId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/timer/{timerId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/timer/{timerId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/timer/{timerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/timer/{timerId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer that was updated	Timer
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Timer from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/timer/{timerId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/timer/{timerId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/timer/{timerId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/timer/{timerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/timer/{timerId}

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Timer
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Start a scenario on the Timer

Code samples

# You can also use wget
curl -X PUT /v1/timer/{timerId}/start \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/timer/{timerId}/start',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/timer/{timerId}/start', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/timer/{timerId}/start',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/timer/{timerId}/start

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer
body	body	PatchOps	false	The update data for the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer that was updated	Timer
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Start a scenario on the Timer via the Project

Code samples

# You can also use wget
curl -X PUT /v1/project/{projectId}/timer/{timerId}/start \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/timer/{timerId}/start',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/project/{projectId}/timer/{timerId}/start', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/project/{projectId}/timer/{timerId}/start',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/project/{projectId}/timer/{timerId}/start

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer that was updated	Timer
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Stop a scenario on the Timer

Code samples

# You can also use wget
curl -X PUT /v1/timer/{timerId}/stop \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/timer/{timerId}/stop',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/timer/{timerId}/stop', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/timer/{timerId}/stop',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/timer/{timerId}/stop

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer
body	body	PatchOps	false	The update data for the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer that was updated	Timer
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Stop a scenario on the Timer via the Project

Code samples

# You can also use wget
curl -X PUT /v1/project/{projectId}/timer/{timerId}/stop \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/timer/{timerId}/stop',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/project/{projectId}/timer/{timerId}/stop', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/project/{projectId}/timer/{timerId}/stop',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/project/{projectId}/timer/{timerId}/stop

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
timerId	path	string	true	The id of the Timer
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Timer

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The timer that was updated	Timer
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Scenario

Gets all Scenarios from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/scenario \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/scenario',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/scenario', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/scenario',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/scenario

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of scenarios	ScenarioList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Scenario in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/scenario \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
  "projectId": "2gPhr582lIQed2cIZczr2Y",
  "name": "My Scenario",
  "blueprintId": "2Y0I4HYXcoNPapqmM0HJZ5",
  "scenarioData": {
    "behavior": {
      "type": "pass"
    },
    "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "scenarioId": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "updaters": [
      {
        "attributeId": "7GWFOnUVAfWBCR9vSI93Y6",
        "attributeType": "number",
        "path": "val"
      },
      {
        "attributeId": "2erCl7FJzJ1rs9f1KtaGda",
        "attributeType": "speed",
        "keyframes": [
          {
            "id": "ac3d6e11-622b-4e8f-86d9-b87f460478f7",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 0,
            "value": 10
          },
          {
            "id": "41a31aae-7a4d-40ee-b5bf-e6fab732925d",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 4000,
            "value": 20
          }
        ],
        "path": "speed"
      }
    ]
  },
  "created": 1550090306908,
  "lastModified": 1550090320009
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/scenario',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/scenario', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/scenario',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/scenario

Body parameter

{
  "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
  "projectId": "2gPhr582lIQed2cIZczr2Y",
  "name": "My Scenario",
  "blueprintId": "2Y0I4HYXcoNPapqmM0HJZ5",
  "scenarioData": {
    "behavior": {
      "type": "pass"
    },
    "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "scenarioId": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "updaters": [
      {
        "attributeId": "7GWFOnUVAfWBCR9vSI93Y6",
        "attributeType": "number",
        "path": "val"
      },
      {
        "attributeId": "2erCl7FJzJ1rs9f1KtaGda",
        "attributeType": "speed",
        "keyframes": [
          {
            "id": "ac3d6e11-622b-4e8f-86d9-b87f460478f7",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 0,
            "value": 10
          },
          {
            "id": "41a31aae-7a4d-40ee-b5bf-e6fab732925d",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 4000,
            "value": 20
          }
        ],
        "path": "speed"
      }
    ]
  },
  "created": 1550090306908,
  "lastModified": 1550090320009
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	Scenario	false	The data for the Scenario

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The scenario that was created	Scenario
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Gets all Scenarios from the Blueprint and the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/blueprint/{blueprintId}/scenario \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/blueprint/{blueprintId}/scenario',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/blueprint/{blueprintId}/scenario', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/blueprint/{blueprintId}/scenario',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/blueprint/{blueprintId}/scenario

Parameters

Name	In	Type	Required	Description
blueprintId	path	string	true	The id of the Blueprint
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of scenarios	ScenarioList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Scenario

Code samples

# You can also use wget
curl -X GET /v1/scenario/{scenarioId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/scenario/{scenarioId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/scenario/{scenarioId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/scenario/{scenarioId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/scenario/{scenarioId}

Parameters

Name	In	Type	Required	Description
scenarioId	path	string	true	The id of the Scenario

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The scenario	Scenario
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Replace the data of a Scenario

Code samples

# You can also use wget
curl -X PUT /v1/scenario/{scenarioId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/scenario/{scenarioId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/scenario/{scenarioId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/scenario/{scenarioId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/scenario/{scenarioId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
scenarioId	path	string	true	The id of the Scenario
body	body	PatchOps	false	The update data for the Scenario

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The scenario that was updated	Scenario
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Scenario

Code samples

# You can also use wget
curl -X DELETE /v1/scenario/{scenarioId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/scenario/{scenarioId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/scenario/{scenarioId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/scenario/{scenarioId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/scenario/{scenarioId}

Parameters

Name	In	Type	Required	Description
scenarioId	path	string	true	The id of the Scenario

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Scenario
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Scenario in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/scenario/{scenarioId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/scenario/{scenarioId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/scenario/{scenarioId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/scenario/{scenarioId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/scenario/{scenarioId}

Parameters

Name	In	Type	Required	Description
scenarioId	path	string	true	The id of the Scenario
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The scenario	Scenario
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Replace a Scenario's data in the Project

Code samples

# You can also use wget
curl -X PUT /v1/project/{projectId}/scenario/{scenarioId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/scenario/{scenarioId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/v1/project/{projectId}/scenario/{scenarioId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/v1/project/{projectId}/scenario/{scenarioId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /v1/project/{projectId}/scenario/{scenarioId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
scenarioId	path	string	true	The id of the Scenario
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Scenario

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The scenario that was updated	Scenario
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Scenario from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/scenario/{scenarioId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/scenario/{scenarioId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/scenario/{scenarioId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/scenario/{scenarioId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/scenario/{scenarioId}

Parameters

Name	In	Type	Required	Description
scenarioId	path	string	true	The id of the Scenario
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Scenario
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Scenario in the Device and System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/device/{deviceId}/scenario \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
  "projectId": "2gPhr582lIQed2cIZczr2Y",
  "name": "My Scenario",
  "blueprintId": "2Y0I4HYXcoNPapqmM0HJZ5",
  "scenarioData": {
    "behavior": {
      "type": "pass"
    },
    "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "scenarioId": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "updaters": [
      {
        "attributeId": "7GWFOnUVAfWBCR9vSI93Y6",
        "attributeType": "number",
        "path": "val"
      },
      {
        "attributeId": "2erCl7FJzJ1rs9f1KtaGda",
        "attributeType": "speed",
        "keyframes": [
          {
            "id": "ac3d6e11-622b-4e8f-86d9-b87f460478f7",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 0,
            "value": 10
          },
          {
            "id": "41a31aae-7a4d-40ee-b5bf-e6fab732925d",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 4000,
            "value": 20
          }
        ],
        "path": "speed"
      }
    ]
  },
  "created": 1550090306908,
  "lastModified": 1550090320009
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/scenario',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/device/{deviceId}/scenario', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/device/{deviceId}/scenario',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/device/{deviceId}/scenario

Body parameter

{
  "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
  "projectId": "2gPhr582lIQed2cIZczr2Y",
  "name": "My Scenario",
  "blueprintId": "2Y0I4HYXcoNPapqmM0HJZ5",
  "scenarioData": {
    "behavior": {
      "type": "pass"
    },
    "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "scenarioId": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "updaters": [
      {
        "attributeId": "7GWFOnUVAfWBCR9vSI93Y6",
        "attributeType": "number",
        "path": "val"
      },
      {
        "attributeId": "2erCl7FJzJ1rs9f1KtaGda",
        "attributeType": "speed",
        "keyframes": [
          {
            "id": "ac3d6e11-622b-4e8f-86d9-b87f460478f7",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 0,
            "value": 10
          },
          {
            "id": "41a31aae-7a4d-40ee-b5bf-e6fab732925d",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 4000,
            "value": 20
          }
        ],
        "path": "speed"
      }
    ]
  },
  "created": 1550090306908,
  "lastModified": 1550090320009
}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System
body	body	Scenario	false	The data for the Scenario

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The scenario that was created	Scenario
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Scenario from the Device and System

Code samples

# You can also use wget
curl -X DELETE /v1/system/{systemId}/device/{deviceId}/scenario \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/device/{deviceId}/scenario',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/system/{systemId}/device/{deviceId}/scenario', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/system/{systemId}/device/{deviceId}/scenario',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/system/{systemId}/device/{deviceId}/scenario

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	The id of the Device
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Scenario
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Contact

Gets all Contacts from the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/contact \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/contact',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/contact', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/contact',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/contact

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of contacts	ContactList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Contact in the System

Code samples

# You can also use wget
curl -X POST /v1/system/{systemId}/contact \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "7nxupz4tECkADx7a05tzan",
  "systemId": "7nxupz4tECkADx7a05tzan",
  "name": "Stephen Jones",
  "email": "[email protected]",
  "phone": "5551234567",
  "created": 1542662533210,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/contact',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/system/{systemId}/contact', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/system/{systemId}/contact',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/system/{systemId}/contact

Body parameter

{
  "id": "7nxupz4tECkADx7a05tzan",
  "systemId": "7nxupz4tECkADx7a05tzan",
  "name": "Stephen Jones",
  "email": "[email protected]",
  "phone": "5551234567",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
systemId	path	string	true	The id of the System
body	body	Contact	false	The data for the Contact

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The contact that was created	Contact
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Contact

Code samples

# You can also use wget
curl -X GET /v1/contact/{contactId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/contact/{contactId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/contact/{contactId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/contact/{contactId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/contact/{contactId}

Parameters

Name	In	Type	Required	Description
contactId	path	string	true	The id of the Contact

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The contact	Contact
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Contact in the System

Code samples

# You can also use wget
curl -X GET /v1/system/{systemId}/contact/{contactId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/contact/{contactId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/system/{systemId}/contact/{contactId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/system/{systemId}/contact/{contactId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/system/{systemId}/contact/{contactId}

Parameters

Name	In	Type	Required	Description
contactId	path	string	true	The id of the Contact
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The contact	Contact
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Contact in the System

Code samples

# You can also use wget
curl -X PATCH /v1/system/{systemId}/contact/{contactId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/contact/{contactId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/system/{systemId}/contact/{contactId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/system/{systemId}/contact/{contactId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/system/{systemId}/contact/{contactId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
contactId	path	string	true	The id of the Contact
systemId	path	string	true	The id of the System
body	body	PatchOps	false	The update data for the Contact

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The contact that was updated	Contact
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Contact from the System

Code samples

# You can also use wget
curl -X DELETE /v1/system/{systemId}/contact/{contactId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/system/{systemId}/contact/{contactId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/system/{systemId}/contact/{contactId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/system/{systemId}/contact/{contactId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/system/{systemId}/contact/{contactId}

Parameters

Name	In	Type	Required	Description
contactId	path	string	true	The id of the Contact
systemId	path	string	true	The id of the System

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Contact
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Network

Gets all Networks from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/network \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/network',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/network', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/network',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/network

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of networks	NetworkList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Network in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/network \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "my-net-1fe",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "name": "Ny Network",
  "type": "custom",
  "aliasKeys": "deveui,esn",
  "subtype": "my-net",
  "created": 1525397963752,
  "lastModified": 1525397963752
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/network',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/network', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/network',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/network

Body parameter

{
  "id": "my-net-1fe",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "name": "Ny Network",
  "type": "custom",
  "aliasKeys": "deveui,esn",
  "subtype": "my-net",
  "created": 1525397963752,
  "lastModified": 1525397963752
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	Network	false	The data for the Network

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The network that was created	Network
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Network

Code samples

# You can also use wget
curl -X GET /v1/network/{network} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/network/{network}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/network/{network}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/network/{network}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/network/{network}

Parameters

Name	In	Type	Required	Description
network	path	string	true	The id of the Network

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The network	Network
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Network

Code samples

# You can also use wget
curl -X PATCH /v1/network/{network} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/network/{network}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/network/{network}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/network/{network}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/network/{network}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
network	path	string	true	The id of the Network
body	body	PatchOps	false	The update data for the Network

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The network that was updated	Network
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Network

Code samples

# You can also use wget
curl -X DELETE /v1/network/{network} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/network/{network}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/network/{network}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/network/{network}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/network/{network}

Parameters

Name	In	Type	Required	Description
network	path	string	true	The id of the Network

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Network
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Network in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/network/{network} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/network/{network}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/network/{network}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/network/{network}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/network/{network}

Parameters

Name	In	Type	Required	Description
network	path	string	true	The id of the Network
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The network	Network
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Network in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/network/{network} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/network/{network}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/network/{network}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/network/{network}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/network/{network}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
network	path	string	true	The id of the Network
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Network

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The network that was updated	Network
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Network from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/network/{network} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/network/{network}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/network/{network}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/network/{network}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/network/{network}

Parameters

Name	In	Type	Required	Description
network	path	string	true	The id of the Network
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Network
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

SharedNetwork

Get a SharedNetwork

Code samples

# You can also use wget
curl -X GET /v1/sharedNetwork/{nid} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/sharedNetwork/{nid}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/sharedNetwork/{nid}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/sharedNetwork/{nid}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/sharedNetwork/{nid}

Parameters

Name	In	Type	Required	Description
nid	path	string	true	The id of the SharedNetwork

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The sharedNetwork	Network
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get all SharedNetworks

Code samples

# You can also use wget
curl -X GET /v1/sharedNetwork \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/sharedNetwork',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/sharedNetwork', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/sharedNetwork',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/sharedNetwork

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of sharedNetworks	NetworkList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

ApiAccess

Gets all ApiAccesss from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/apiAccess \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/apiAccess',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/apiAccess', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/apiAccess',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/apiAccess

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of apiAccesss	ApiAccessList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a ApiAccess in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/apiAccess \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "name": "My ApiAccess",
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "secret": "7psUiRQbCblsKj32S9ci4B0PsYeeukwfUBKIJGFuJTvF693yMlXHsMaJeY8mkDIhiv3RIN5IrqrTCqyRa73L7qA6",
  "active": true,
  "permissions": {
    "role": "creator"
  },
  "created": 1542662533210,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/apiAccess',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/apiAccess', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/apiAccess',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/apiAccess

Body parameter

{
  "name": "My ApiAccess",
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "secret": "7psUiRQbCblsKj32S9ci4B0PsYeeukwfUBKIJGFuJTvF693yMlXHsMaJeY8mkDIhiv3RIN5IrqrTCqyRa73L7qA6",
  "active": true,
  "permissions": {
    "role": "creator"
  },
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	ApiAccess	false	The data for the ApiAccess

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The apiAccess that was created	ApiAccess
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a ApiAccess

Code samples

# You can also use wget
curl -X GET /v1/apiAccess/{apiAccess} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/apiAccess/{apiAccess}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/apiAccess/{apiAccess}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/apiAccess/{apiAccess}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/apiAccess/{apiAccess}

Parameters

Name	In	Type	Required	Description
apiAccess	path	string	true	The id of the ApiAccess

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The apiAccess	ApiAccess
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a ApiAccess

Code samples

# You can also use wget
curl -X PATCH /v1/apiAccess/{apiAccess} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/apiAccess/{apiAccess}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/apiAccess/{apiAccess}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/apiAccess/{apiAccess}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/apiAccess/{apiAccess}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
apiAccess	path	string	true	The id of the ApiAccess
body	body	PatchOps	false	The update data for the ApiAccess

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The apiAccess that was updated	ApiAccess
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a ApiAccess

Code samples

# You can also use wget
curl -X DELETE /v1/apiAccess/{apiAccess} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/apiAccess/{apiAccess}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/apiAccess/{apiAccess}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/apiAccess/{apiAccess}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/apiAccess/{apiAccess}

Parameters

Name	In	Type	Required	Description
apiAccess	path	string	true	The id of the ApiAccess

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	ApiAccess
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a ApiAccess in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/apiAccess/{apiAccess} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/apiAccess/{apiAccess}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/apiAccess/{apiAccess}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/apiAccess/{apiAccess}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/apiAccess/{apiAccess}

Parameters

Name	In	Type	Required	Description
apiAccess	path	string	true	The id of the ApiAccess
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The apiAccess	ApiAccess
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a ApiAccess in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/apiAccess/{apiAccess} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/apiAccess/{apiAccess}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/apiAccess/{apiAccess}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/apiAccess/{apiAccess}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/apiAccess/{apiAccess}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
apiAccess	path	string	true	The id of the ApiAccess
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the ApiAccess

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The apiAccess that was updated	ApiAccess
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a ApiAccess from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/apiAccess/{apiAccess} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/apiAccess/{apiAccess}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/apiAccess/{apiAccess}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/apiAccess/{apiAccess}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/apiAccess/{apiAccess}

Parameters

Name	In	Type	Required	Description
apiAccess	path	string	true	The id of the ApiAccess
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	ApiAccess
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Account

Gets all Accounts from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/account \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/account',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/account', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/account',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/account

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of accounts	UserList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Account in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/account \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/account',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/account', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/account',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/account

Body parameter

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	User	false	The data for the Account

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The account that was created	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Account in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/account/{accountUserId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/account/{accountUserId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/account/{accountUserId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/account/{accountUserId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/account/{accountUserId}

Parameters

Name	In	Type	Required	Description
accountUserId	path	string	true	The id of the Account
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The account	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Account in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/account/{userId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/account/{userId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/account/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/account/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/account/{userId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the Account
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Account

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The account that was updated	User
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Account from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/account/{userId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/account/{userId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/account/{userId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/account/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/account/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The id of the Account
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	User
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Script

Gets all Scripts from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/script \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/script',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/script', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/script',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/script

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of scripts	ScriptList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Script in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/script \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "5mNm2KqshYTvIxmp7RPu82",
  "projectId": "1mv1p0fy5Om7J1oS1DiDxq",
  "name": "Test Script",
  "description": "Script to calculate alert",
  "scriptData": {
    "type": "javascript",
    "code": "/* ...code... */"
  },
  "lastModified": 1542662638709,
  "created": 1542662638431
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/script',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/script', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/script',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/script

Body parameter

{
  "id": "5mNm2KqshYTvIxmp7RPu82",
  "projectId": "1mv1p0fy5Om7J1oS1DiDxq",
  "name": "Test Script",
  "description": "Script to calculate alert",
  "scriptData": {
    "type": "javascript",
    "code": "/* ...code... */"
  },
  "lastModified": 1542662638709,
  "created": 1542662638431
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	Script	false	The data for the Script

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script that was created	Script
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Script logs

Code samples

# You can also use wget
curl -X GET /v1/script/{scriptId}/logs \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/script/{scriptId}/logs',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/script/{scriptId}/logs', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/script/{scriptId}/logs',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/script/{scriptId}/logs

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Script in the Project logs

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/script/{scriptId}/logs \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/script/{scriptId}/logs',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/script/{scriptId}/logs', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/script/{scriptId}/logs',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/script/{scriptId}/logs

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get the metrics for Script

Code samples

# You can also use wget
curl -X GET /v1/script/{scriptId}/metrics \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/script/{scriptId}/metrics',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/script/{scriptId}/metrics', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/script/{scriptId}/metrics',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/script/{scriptId}/metrics

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get the metrics for Script via the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/script/{scriptId}/metrics \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/script/{scriptId}/metrics',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/script/{scriptId}/metrics', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/script/{scriptId}/metrics',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/script/{scriptId}/metrics

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Script

Code samples

# You can also use wget
curl -X GET /v1/script/{scriptId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/script/{scriptId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/script/{scriptId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/script/{scriptId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/script/{scriptId}

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Script

Code samples

# You can also use wget
curl -X PATCH /v1/script/{scriptId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/script/{scriptId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/script/{scriptId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/script/{scriptId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/script/{scriptId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script
body	body	PatchOps	false	The update data for the Script

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script that was updated	Script
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Script

Code samples

# You can also use wget
curl -X DELETE /v1/script/{scriptId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/script/{scriptId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/script/{scriptId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/script/{scriptId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/script/{scriptId}

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Script in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/script/{scriptId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/script/{scriptId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/script/{scriptId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/script/{scriptId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/script/{scriptId}

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Script in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/script/{scriptId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/script/{scriptId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/script/{scriptId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/script/{scriptId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/script/{scriptId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Script

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The script that was updated	Script
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Script from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/script/{scriptId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/script/{scriptId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/script/{scriptId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/script/{scriptId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/script/{scriptId}

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Deploy the Script

Code samples

# You can also use wget
curl -X DELETE /v1/script/{scriptId}/deploy \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/script/{scriptId}/deploy',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/script/{scriptId}/deploy', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/script/{scriptId}/deploy',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/script/{scriptId}/deploy

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Deploy the Script via the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/script/{scriptId}/deploy \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/script/{scriptId}/deploy',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/script/{scriptId}/deploy', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/script/{scriptId}/deploy',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/script/{scriptId}/deploy

Parameters

Name	In	Type	Required	Description
scriptId	path	string	true	The id of the Script
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Script
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Template

Gets all Templates from the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/template \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/template',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/template', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/template',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/template

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The list of templates	TemplateList
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Create a Template in the Project

Code samples

# You can also use wget
curl -X POST /v1/project/{projectId}/template \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '{
  "id": "5mNm2KqshYTvIxmp7RPu82",
  "projectId": "1mv1p0fy5Om7J1oS1DiDxq",
  "name": "Test Template",
  "description": "Template for an alert",
  "templateData": {
    "intents": {
      "email": {
        "dataType": "hbs",
        "data": "Hello, {username}. An alert was detected",
        "subject": "Hello",
        "limitOptions": {
          "count": 10,
          "period": 30000,
          "duration": 180000
        }
      },
      "sms": {
        "dataType": "hbs",
        "data": "Alert detected",
        "limitOptions": {
          "count": 10,
          "period": 30000,
          "duration": 180000
        }
      }
    }
  },
  "lastModified": 1542662638709,
  "created": 1542662638431
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/template',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/v1/project/{projectId}/template', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/v1/project/{projectId}/template',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /v1/project/{projectId}/template

Body parameter

{
  "id": "5mNm2KqshYTvIxmp7RPu82",
  "projectId": "1mv1p0fy5Om7J1oS1DiDxq",
  "name": "Test Template",
  "description": "Template for an alert",
  "templateData": {
    "intents": {
      "email": {
        "dataType": "hbs",
        "data": "Hello, {username}. An alert was detected",
        "subject": "Hello",
        "limitOptions": {
          "count": 10,
          "period": 30000,
          "duration": 180000
        }
      },
      "sms": {
        "dataType": "hbs",
        "data": "Alert detected",
        "limitOptions": {
          "count": 10,
          "period": 30000,
          "duration": 180000
        }
      }
    }
  },
  "lastModified": 1542662638709,
  "created": 1542662638431
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The id of the Project
body	body	Template	false	The data for the Template

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The template that was created	Template
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Template

Code samples

# You can also use wget
curl -X GET /v1/template/{templateId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/template/{templateId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/template/{templateId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/template/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/template/{templateId}

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The id of the Template

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The template	Template
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Template

Code samples

# You can also use wget
curl -X PATCH /v1/template/{templateId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/template/{templateId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/template/{templateId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/template/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/template/{templateId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The id of the Template
body	body	PatchOps	false	The update data for the Template

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The template that was updated	Template
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Template

Code samples

# You can also use wget
curl -X DELETE /v1/template/{templateId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/template/{templateId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/template/{templateId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/template/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/template/{templateId}

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The id of the Template

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Template
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Get a Template in the Project

Code samples

# You can also use wget
curl -X GET /v1/project/{projectId}/template/{templateId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/template/{templateId}',
{
  method: 'GET',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/v1/project/{projectId}/template/{templateId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/v1/project/{projectId}/template/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/project/{projectId}/template/{templateId}

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The id of the Template
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The template	Template
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Update a Template in the Project

Code samples

# You can also use wget
curl -X PATCH /v1/project/{projectId}/template/{templateId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

const fetch = require('node-fetch');
const inputBody = '[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/template/{templateId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/v1/project/{projectId}/template/{templateId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/v1/project/{projectId}/template/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /v1/project/{projectId}/template/{templateId}

Body parameter

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The id of the Template
projectId	path	string	true	The id of the Project
body	body	PatchOps	false	The update data for the Template

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The template that was updated	Template
400	Bad Request	The request was invalid	ApiError
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Delete a Template from the Project

Code samples

# You can also use wget
curl -X DELETE /v1/project/{projectId}/template/{templateId} \
  -H 'Accept: appliction/json' \
  -H 'Authorization: Bearer {access-token}'

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

const headers = {
  'Accept':'appliction/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/v1/project/{projectId}/template/{templateId}',
{
  method: 'DELETE',

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

import requests
headers = {
  'Accept': 'appliction/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/v1/project/{projectId}/template/{templateId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'appliction/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/v1/project/{projectId}/template/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /v1/project/{projectId}/template/{templateId}

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The id of the Template
projectId	path	string	true	The id of the Project

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	The delete confirmation	Template
403	Forbidden	The user is forbidden	ApiError
404	Not Found	The object is not found	ApiError
default	Default	The server had an internal error handling the request	ApiError

Schemas

ApiError

{
  "forbidden": {
    "status": 403,
    "message": "The user is forbidden"
  },
  "internal": {
    "status": 500,
    "message": "An internal error occurred"
  }
}

Properties

Name	Type	Required	Restrictions	Description
status	integer	false	none	The http status code of the error
message	string	false	none	A message indicating what error occurred

PatchOps

[
  {
    "path": "name",
    "value": "Texels"
  },
  {
    "path": "age",
    "value": "24"
  }
]

An array of path/value objects specifying which properties to modify

Properties

Name	Type	Required	Restrictions	Description
path	string	false	none	none
value	any	false	none	none
op	string|null	false	none	none

Enumerated Values

Property	Value
op	replace
op	add
op	remove

Project

{
  "name": "My Project",
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "active": true,
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Project
name	string	false	none	The name of the Project
active	boolean	false	none	The active state of the project
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

User

{
  "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
  "name": "texels",
  "email": "[email protected]",
  "projectId": "2JM2L3Niq5K939jB5ECMQC",
  "permissions": {
    "role": "user"
  },
  "activated": true,
  "created": 1542662267501,
  "lastModified": 1542662533210
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the User
projectId	string	false	read-only	The id of the Project that owns this User
username	string	false	none	The name of the user
email	string(email)	false	none	The User's email address
activate	boolean	false	none	True if the user activated their account
activatedDate	number	false	none	The unix time of activation
lastProject	string	false	none	The id of the last project viewed
permissions	object	false	none	none
» role	string	false	none	The role of this user. A value of "user" means that this user is a Project user
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

Enumerated Values

Property	Value
role	admin
role	creator
role	user

System

{
  "id": "07B66DZJBAZ4kdtOWolT7C",
  "projectId": "5qTlcWjEz7qkKac52Kc1Ll",
  "name": "Test System",
  "created": 1542662767139,
  "lastModified": 1542662767139
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the System
projectId	string	false	read-only	The id of the Project that owns this System
name	string	false	none	The name of the System
metadata	object	false	none	User defined metadata about Device
» additionalProperties	any	false	none	none
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

Device

{
  "name": "My Device",
  "id": "0Ml6RFtMiGiy5zu0lpEY86",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "systemId": "48ZXwC058DMBjurH4CpOu7",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "networkId": "my-net",
  "networkAliases": {
    "my-net": {
      "deveui": "AX-BA-30-12"
    }
  },
  "purpose": "device",
  "simulated": false,
  "metadata": {
    "extraValue": 12
  },
  "created": 1525398286228,
  "lastModified": 1525402000646
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Device
blueprintId	string	false	none	The id of the Blueprint that describes this device
systemId	string	false	read-only	The id of the System that owns this Device
projectId	string	false	read-only	The id of the Project that owns this Device
name	string	false	none	The name of the Device
purpose	string	false	none	none
networkId	string	false	read-only	The id of the Network that this Device is receiving data on
networkAliases	object	false	none	The external identities (Network/Key/Values triples) of this Device
» additionalProperties	any	false	none	none
metadata	object	false	none	User defined metadata about Device
» additionalProperties	any	false	none	none
simulated	boolean	false	none	none
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created.
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed.

Enumerated Values

Property	Value
purpose	device
purpose	organization

Blueprint

{
  "id": "01NKW8H2w0vrgIAxfWDW12",
  "name": "Ship",
  "alias": "ship",
  "projectId": "Jn123HasdnNA900cdFG1AX",
  "purpose": "device",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Blueprint
projectId	string	false	read-only	The id of the Project that owns this Blueprint
name	string	false	none	The name of the Blueprint object
alias	string	false	none	The project level unique human readable name for this Blueprint
purpose	string	false	none	The purpose of the device, either to represent a sensor(s) or a structure
permission	object	false	none	none
» anonymous	object	false	none	none
»» access	string	false	none	If "r", this devices of this type will be publically readable
» created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
» lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

Enumerated Values

Property	Value
purpose	device
purpose	organization

Attribute

{
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "name": "Latitude",
  "type": "number",
  "path": "position/lat",
  "source": "device",
  "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Attribute
blueprintId	string	false	read-only	The id of the blueprint that owns this Attribute
name	string	false	none	The name of the Attribute
desc	string	false	none	A description about this attribute
path	string	false	none	A "/" separated list indicating where in the data object the attribute's value can be found
type	string	false	none	The kind of value that this attribute represents
targetBlueprintId	string	false	none	The id of the relationship's blueprint. Only used when type id "relationship"
relationshipType	string	false	none	The type of relationship. Only used when type id "relationship"
source	string	false	none	Where does the value come from
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

Enumerated Values

Property	Value
type	boolean
type	int
type	number
type	percent
type	string
type	timestamp
type	relationship
type	angle
type	length
type	surface
type	volume
type	substanceAmount
type	speed
type	acceleration
type	temperature
type	force
type	mass
type	pressure
type	time
type	frequency
type	energy
type	power
type	current
type	luminousIntensity
type	electricCharge
type	electricCapacitance
type	electricPotential
type	electricResistance
type	electricInductance
type	electricConductance
type	magneticFlux
type	magneticFluxDensity
type	bit
relationshipType	oneToOne
relationshipType	oneToMany
relationshipType	manyToMany
source	device
source	calculated
source	user

Network

{
  "id": "my-net-1fe",
  "projectId": "0oTNqwApTanxLZqVpPjxjc",
  "name": "Ny Network",
  "type": "custom",
  "aliasKeys": "deveui,esn",
  "subtype": "my-net",
  "created": 1525397963752,
  "lastModified": 1525397963752
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The unique id of the Network.
projectId	string	false	read-only	The id of the Project that owns this Network
name	string	false	none	The name of the Network
aliasKeys	any	false	none	The set of identifier names that the Network uses (deveui, uuid, id, esn...)

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	A comma separated list of keys

xor

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	An array of keys

continued

Name	Type	Required	Restrictions	Description
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created.
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed.

ApiAccess

{
  "name": "My ApiAccess",
  "id": "01NKW8H2w0vrgIAxfWDW47",
  "secret": "7psUiRQbCblsKj32S9ci4B0PsYeeukwfUBKIJGFuJTvF693yMlXHsMaJeY8mkDIhiv3RIN5IrqrTCqyRa73L7qA6",
  "active": true,
  "permissions": {
    "role": "creator"
  },
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the ApiAcess object
projectId	string	false	read-only	The id of the project that owns this ApiAccess object
name	string	false	none	The user defined name of the ApiAccess object
secret	string	false	read-only	The secret, used to encrypt/decrypt the authentication token.
active	boolean	false	none	If false, authentication using this ApiAccess object will be denied
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created.
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed.

Timer

{
  "id": "4Xq90wJpvfinPuaZS3UHrE",
  "projectId": "3hmJaHtyUQA3jbGo2xhoz4",
  "name": "My Timer",
  "timer": {
    "delay": 1000,
    "type": "once"
  },
  "action": {
    "message": {
      "message": {
        "type": "reasonRunScript"
      },
      "options": {
        "reasoner": {
          "foo": "bar",
          "id": "6Nl60VvupiwNORIWfOF0e1"
        }
      },
      "type": "routeMsg"
    },
    "topic": "reason",
    "type": "publishTopic"
  },
  "created": 1528203289607,
  "lastModified": 1528204061858
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Template
projectId	string	false	read-only	The id of the Project that owns this Template
name	string	false	none	The name of the Template
timer	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	OnceTimer	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	RepeatingTimer	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	ScheduledTimer	false	none	none

continued

Name	Type	Required	Restrictions	Description
action	object	false	none	The action to execute when the timer fires
» additionalProperties	any	false	none	none
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

Script

{
  "id": "5mNm2KqshYTvIxmp7RPu82",
  "projectId": "1mv1p0fy5Om7J1oS1DiDxq",
  "name": "Test Script",
  "description": "Script to calculate alert",
  "scriptData": {
    "type": "javascript",
    "code": "/* ...code... */"
  },
  "lastModified": 1542662638709,
  "created": 1542662638431
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Script
projectId	string	false	read-only	The id of the Project that owns this Script
name	string	false	none	The name of the Script
description	string	false	none	A description about this Script
scriptData	object	false	none	The actual data of the Script
» type	string	false	none	The type of script: javascript, python
» code	string	false	none	The code
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

Template

{
  "id": "5mNm2KqshYTvIxmp7RPu82",
  "projectId": "1mv1p0fy5Om7J1oS1DiDxq",
  "name": "Test Template",
  "description": "Template for an alert",
  "templateData": {
    "intents": {
      "email": {
        "dataType": "hbs",
        "data": "Hello, {username}. An alert was detected",
        "subject": "Hello",
        "limitOptions": {
          "count": 10,
          "period": 30000,
          "duration": 180000
        }
      },
      "sms": {
        "dataType": "hbs",
        "data": "Alert detected",
        "limitOptions": {
          "count": 10,
          "period": 30000,
          "duration": 180000
        }
      }
    }
  },
  "lastModified": 1542662638709,
  "created": 1542662638431
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Template
projectId	string	false	read-only	The id of the Project that owns this Template
name	string	false	none	The name of the Template
description	string	false	none	A description about this Template
alias	string	false	none	The project level unique human readable name for this Template
templateData	object	false	none	The actual data of the Template
» intents	object	false	none	none
»» email	TemplateIntent	false	none	none
»» sms	TemplateIntent	false	none	none
» created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
» lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

MessageRoute

{
  "id": "66PdsJg2NeIP4UF6M08krh",
  "projectId": "2gPhr582lIQed2cIZczr2Y",
  "name": "My Message Route",
  "routes": {
    "deviceDataEventMsg": [
      "writer",
      "cacheClearTest"
    ]
  },
  "created": 1548429946278,
  "lastModified": 1548430653786
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the MessageRoute
projectId	string	false	read-only	The id of the Project that owns this MessageRoute
name	string	false	none	The name of the MessageRoute object
routes	object	false	none	none
» deviceDataEventMsg	any	false	none	The message routing for the a message of type deviceDataEventMsg
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

Contact

{
  "id": "7nxupz4tECkADx7a05tzan",
  "systemId": "7nxupz4tECkADx7a05tzan",
  "name": "Stephen Jones",
  "email": "[email protected]",
  "phone": "5551234567",
  "created": 1542662533210,
  "lastModified": 1542662533210
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Contact
systemId	string	false	read-only	The id of the system that owns this Contact
name	string	false	none	The name of the contact
email	string(email)	false	none	The contact's email address
phone	string	false	none	The contact's phone number
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created.
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed.

Scenario

{
  "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
  "projectId": "2gPhr582lIQed2cIZczr2Y",
  "name": "My Scenario",
  "blueprintId": "2Y0I4HYXcoNPapqmM0HJZ5",
  "scenarioData": {
    "behavior": {
      "type": "pass"
    },
    "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "scenarioId": "5ZEn1EDh3fkaG4uuI4N0VQ",
    "updaters": [
      {
        "attributeId": "7GWFOnUVAfWBCR9vSI93Y6",
        "attributeType": "number",
        "path": "val"
      },
      {
        "attributeId": "2erCl7FJzJ1rs9f1KtaGda",
        "attributeType": "speed",
        "keyframes": [
          {
            "id": "ac3d6e11-622b-4e8f-86d9-b87f460478f7",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 0,
            "value": 10
          },
          {
            "id": "41a31aae-7a4d-40ee-b5bf-e6fab732925d",
            "interpolator": {
              "addNoise": false,
              "range1": 0.1,
              "range2": -0.1,
              "type": "linear",
              "update": 30000
            },
            "time": 4000,
            "value": 20
          }
        ],
        "path": "speed"
      }
    ]
  },
  "created": 1550090306908,
  "lastModified": 1550090320009
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The unique id of the Scenario
projectId	string	false	read-only	The id of the Project that owns this Scenario
blueprintId	string	false	read-only	The id of the Blueprint that this Scenario can be used with
name	string	false	none	The name of the Scenario
description	string	false	none	A description of the Scenario
scenarioData	object	false	none	The actual data of the Scenario
» additionalProperties	any	false	none	none
created	number	false	read-only	The time, in milliseconds second epoch, at which this object was created
lastModified	number	false	read-only	The time, in milliseconds second epoch, that this object was last changed

ProjectList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "name": "My Project",
      "id": "01NKW8H2w0vrgIAxfWDW47",
      "active": true,
      "created": 1542662533210,
      "lastModified": 1542662533210
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Project]	false	none	none

UserList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "blue|2vDcC9wYkbI6TXMxRKvnkX",
      "name": "texels",
      "email": "[email protected]",
      "projectId": "2JM2L3Niq5K939jB5ECMQC",
      "permissions": {
        "role": "user"
      },
      "activated": true,
      "created": 1542662267501,
      "lastModified": 1542662533210
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[User]	false	none	none

SystemList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "07B66DZJBAZ4kdtOWolT7C",
      "projectId": "5qTlcWjEz7qkKac52Kc1Ll",
      "name": "Test System",
      "created": 1542662767139,
      "lastModified": 1542662767139
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[System]	false	none	none

DeviceList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "name": "My Device",
      "id": "0Ml6RFtMiGiy5zu0lpEY86",
      "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
      "systemId": "48ZXwC058DMBjurH4CpOu7",
      "projectId": "0oTNqwApTanxLZqVpPjxjc",
      "networkId": "my-net",
      "networkAliases": {
        "my-net": {
          "deveui": "AX-BA-30-12"
        }
      },
      "purpose": "device",
      "simulated": false,
      "metadata": {
        "extraValue": 12
      },
      "created": 1525398286228,
      "lastModified": 1525402000646
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Device]	false	none	none

BlueprintList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "01NKW8H2w0vrgIAxfWDW12",
      "name": "Ship",
      "alias": "ship",
      "projectId": "Jn123HasdnNA900cdFG1AX",
      "purpose": "device",
      "created": 1542662533210,
      "lastModified": 1542662533210
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Blueprint]	false	none	none

AttributeList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "01NKW8H2w0vrgIAxfWDW47",
      "name": "Latitude",
      "type": "number",
      "path": "position/lat",
      "source": "device",
      "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
      "created": 1542662533210,
      "lastModified": 1542662533210
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Attribute]	false	none	none

NetworkList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "my-net-1fe",
      "projectId": "0oTNqwApTanxLZqVpPjxjc",
      "name": "Ny Network",
      "type": "custom",
      "aliasKeys": "deveui,esn",
      "subtype": "my-net",
      "created": 1525397963752,
      "lastModified": 1525397963752
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Network]	false	none	none

ApiAccessList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "name": "My ApiAccess",
      "id": "01NKW8H2w0vrgIAxfWDW47",
      "secret": "7psUiRQbCblsKj32S9ci4B0PsYeeukwfUBKIJGFuJTvF693yMlXHsMaJeY8mkDIhiv3RIN5IrqrTCqyRa73L7qA6",
      "active": true,
      "permissions": {
        "role": "creator"
      },
      "created": 1542662533210,
      "lastModified": 1542662533210
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[ApiAccess]	false	none	none

TimerList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "4Xq90wJpvfinPuaZS3UHrE",
      "projectId": "3hmJaHtyUQA3jbGo2xhoz4",
      "name": "My Timer",
      "timer": {
        "delay": 1000,
        "type": "once"
      },
      "action": {
        "message": {
          "message": {
            "type": "reasonRunScript"
          },
          "options": {
            "reasoner": {
              "foo": "bar",
              "id": "6Nl60VvupiwNORIWfOF0e1"
            }
          },
          "type": "routeMsg"
        },
        "topic": "reason",
        "type": "publishTopic"
      },
      "created": 1528203289607,
      "lastModified": 1528204061858
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Timer]	false	none	none

ScriptList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "5mNm2KqshYTvIxmp7RPu82",
      "projectId": "1mv1p0fy5Om7J1oS1DiDxq",
      "name": "Test Script",
      "description": "Script to calculate alert",
      "scriptData": {
        "type": "javascript",
        "code": "/* ...code... */"
      },
      "lastModified": 1542662638709,
      "created": 1542662638431
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Script]	false	none	none

TemplateList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "5mNm2KqshYTvIxmp7RPu82",
      "projectId": "1mv1p0fy5Om7J1oS1DiDxq",
      "name": "Test Template",
      "description": "Template for an alert",
      "templateData": {
        "intents": {
          "email": {
            "dataType": "hbs",
            "data": "Hello, {username}. An alert was detected",
            "subject": "Hello",
            "limitOptions": {
              "count": 10,
              "period": 30000,
              "duration": 180000
            }
          },
          "sms": {
            "dataType": "hbs",
            "data": "Alert detected",
            "limitOptions": {
              "count": 10,
              "period": 30000,
              "duration": 180000
            }
          }
        }
      },
      "lastModified": 1542662638709,
      "created": 1542662638431
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Template]	false	none	none

MessageRouteList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "66PdsJg2NeIP4UF6M08krh",
      "projectId": "2gPhr582lIQed2cIZczr2Y",
      "name": "My Message Route",
      "routes": {
        "deviceDataEventMsg": [
          "writer",
          "cacheClearTest"
        ]
      },
      "created": 1548429946278,
      "lastModified": 1548430653786
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[MessageRoute]	false	none	none

ContactList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "7nxupz4tECkADx7a05tzan",
      "systemId": "7nxupz4tECkADx7a05tzan",
      "name": "Stephen Jones",
      "email": "[email protected]",
      "phone": "5551234567",
      "created": 1542662533210,
      "lastModified": 1542662533210
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Contact]	false	none	none

ScenarioList

{
  "count": 0,
  "total": 0,
  "perPage": 0,
  "startIndex": 0,
  "search": "string",
  "items": [
    {
      "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
      "projectId": "2gPhr582lIQed2cIZczr2Y",
      "name": "My Scenario",
      "blueprintId": "2Y0I4HYXcoNPapqmM0HJZ5",
      "scenarioData": {
        "behavior": {
          "type": "pass"
        },
        "id": "5ZEn1EDh3fkaG4uuI4N0VQ",
        "scenarioId": "5ZEn1EDh3fkaG4uuI4N0VQ",
        "updaters": [
          {
            "attributeId": "7GWFOnUVAfWBCR9vSI93Y6",
            "attributeType": "number",
            "path": "val"
          },
          {
            "attributeId": "2erCl7FJzJ1rs9f1KtaGda",
            "attributeType": "speed",
            "keyframes": [
              {
                "id": "ac3d6e11-622b-4e8f-86d9-b87f460478f7",
                "interpolator": {
                  "addNoise": false,
                  "range1": 0.1,
                  "range2": -0.1,
                  "type": "linear",
                  "update": 30000
                },
                "time": 0,
                "value": 10
              },
              {
                "id": "41a31aae-7a4d-40ee-b5bf-e6fab732925d",
                "interpolator": {
                  "addNoise": false,
                  "range1": 0.1,
                  "range2": -0.1,
                  "type": "linear",
                  "update": 30000
                },
                "time": 4000,
                "value": 20
              }
            ],
            "path": "speed"
          }
        ]
      },
      "created": 1550090306908,
      "lastModified": 1550090320009
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer	false	none	The number of items returned
total	integer	false	none	The total number of items
perPage	integer	false	none	The number of items perPage
startIndex	integer	false	none	The index relative to the total list of the first item in the items list
search	string	false	none	The search string
items	[Scenario]	false	none	none

TemplateIntent

{
  "dataType": "hbs",
  "data": "Hello, {username}",
  "limitOptions": {
    "count": 10,
    "period": 30000,
    "duration": 180000
  }
}

Properties

Name	Type	Required	Restrictions	Description
dataType	string	false	none	The format of the data template (ex: 'hbs')
data	string	false	none	The template data (ie, the handlebar template)
subject	string	false	none	The subject of the template (for email)
limitOptions	object	false	none	none
» count	number	false	none	The max number of messages allowed in the period
» period	number	false	none	The period, in milliseconds
» duration	number	false	none	The time in milliseconds to limit sending data for.

OnceTimer

{
  "type": "once",
  "delay": 3600000
}

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	once
delay	number	false	none	The delay in milliseconds before firing the timer
when	number	false	none	The date/time in milliseconds of when the timer should fire

RepeatingTimer

{
  "type": "once",
  "delay": 360000,
  "runImmediately": true
}

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	repeating
delay	number	false	none	The delay in milliseconds before firing the timer
runImmediately	boolean	false	none	If true, the first timer fire will occur immediately. Otherwise, it will occur "delay" milliseconds after the timer starts

ScheduledTimer

{
  "type": "scheduled",
  "cron": "* * 0 * * *",
  "timezone": "Europe/Athens"
}

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	scheduled
cron	string	false	none	The cron formatted schedule for the timer
timezone	string	false	none	The timezone in which the timer should operate