Get a digital twin document

GET

/digitaltwins

Retrieve a digital twin document for a specific sensor.

Query Parameters

sensor_idstringrequired
Description
ID of the sensor for which the digital twin shall be retrieved.

Header Parameters

Authorizationstringrequired
Example
```
{
  "Authorization": "Bearer {jwt token}"
}
```
Description
Auth header

Responses

200OK

object

sensor_idstring

ten_secobject

Example

{
  "p_l1": 0,
  "p_l2": 0,
  "p_l3": 0,
  "q_l1": 0,
  "q_l2": 0,
  "q_l3": 0,
  "last_upd": "2023-02-21T15:15:50.000Z"
}

opmobject

Example

{
  "value": 1,
  "last_updt": "2023-02-21T15:15:50.000Z"
}

one_minobject
load_mgmtobject

400Bad Request

object
- namestring
  Example
  BadRequest
  Description
  Error name
- messagestring
  Example
  Data does not match schema
  Description
  Error message
- codenumber
  Example
  400
  Description
  HTTP status code
- classNamestring
  Example
  bad-request
  Description
  Error class name
- datastring
  Description
  Error data
- errorsobject[]
  Example
```
[
  "detailed description of error"
]
```
  Description
  Description of errors

401Unauthorized

object
- namestring
  Example
  NotAuthenticated
  Description
  Error name
- messagestring
  Example
  Not authenticated
  Description
  Error message
- codenumber
  Example
  401
  Description
  HTTP status code
- classNamestring
  Example
  not-authenticated
  Description
  Error class name
- errorsobject
  Description
  Description of errors

403Forbidden

object
- namestring
  Example
  Forbidden
  Description
  Error name
- messagestring
  Example
  Access Forbidden
  Description
  Error message
- codenumber
  Example
  403
  Description
  HTTP status code
- classNamestring
  Example
  forbidden
  Description
  Error class name
- errorsobject
  Description
  Description of errors

curl

curl --request GET \
     --url '/digitaltwins?sensor_id=string' \
     --header 'accept: application/json' \
     --header 'authorization: {"Authorization":"Bearer {jwt token}"}'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("authorization", "{\"Authorization\":\"Bearer {jwt token}\"}");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/digitaltwins?sensor_id=string", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/digitaltwins?sensor_id=string")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["authorization"] = "{\"Authorization\":\"Bearer {jwt token}\"}"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/digitaltwins?sensor_id=string"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'authorization': '{"Authorization":"Bearer {jwt token}"}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "sensor_id": "",
  "ten_sec": {},
  "opm": {},
  "one_min": {},
  "load_mgmt": {}
}

400

// Bad Request
{
  "name": "BadRequest",
  "message": "Data does not match schema",
  "code": 400,
  "className": "bad-request",
  "data": "",
  "errors": [
    {}
  ]
}

401

// Unauthorized
{
  "name": "NotAuthenticated",
  "message": "Not authenticated",
  "code": 401,
  "className": "not-authenticated",
  "errors": {}
}

403

// Forbidden
{
  "name": "Forbidden",
  "message": "Access Forbidden",
  "code": 403,
  "className": "forbidden",
  "errors": {}
}

Retrieve a digital twin document for a specific sensor.