Geobrugg Data-API (0.1.0)

Download OpenAPI specification:Download

A convenient API to retrieve data regarding your GUARD-devices, Protections-Systems and Alerts

login

Return JWT for authentication/authorization

Request Body schema: application/json

username	string user email
password	string user password

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

200
401

Content type

application/json

{"token": "string",
"refreshToken": "string"
}

getAssets

Returns customer assets and devices

header Parameters

X-Authorization

required

string

Json web token retrieved from the login-endpoint

Responses

Response samples

200
400
401
403
404

Content type

application/json

[{"assetId": "string",
"assetName": "string",
"attributes": {"latitude": 0,
"longitude": 0,
"Manufacturer": "string",
"systemtype": "string"
},
"devices": [{"deviceName": "string",
"deviceLabel": "string",
"attributes": {"DateFieldInstallation": 0,
"POS-Diameter": 0,
"POS-Rope": "string",
"latitude": 0,
"longitude": 0,
"POS-Position": "string",
"POS-Field": 0,
"lastActivityTime": 0
}
}
]
}
]

getTimeseries

Returns telemetry data of a specified device

query Parameters

required	integer or integer or string start timestamp
	integer or integer or string Default: "current timestamp" end timestamp
device required	string device name (smbx-Id)
keys required	string Example: keys=Temperature,Humidity comma-seperated list of keys, referring to the desired telemetry data

header Parameters

X-Authorization

required

string

Json web token retrieved from the login-endpoint

Responses

Response samples

200
400
401
403
404

Content type

application/json

[{"deviceName": "string",
"telemetry": {"Temperature": [{"ts": 1646541423000,
"value": "21.144"
},
{"ts": 1646541424000,
"value": "22.012"
}
],
"Humidity": [{"ts": 1646541423000,
"value": "20.011"
},
{"ts": 1646541424000,
"value": "22.781"
}
]
},
"latestValue": {"Temperature": {"ts": 1646541424000,
"value": "22.012"
},
"Humidity": {"ts": 1646541424000,
"value": "22.781"
}
}
}
]

getTimeseriesKeys

Returns list of valid telemetry keys

header Parameters

X-Authorization

required

string

Json web token retrieved from the login-endpoint

Responses

Response samples

200
400
401
403
404

Content type

application/json

["string"
]

getAlerts

Returns list of alerts

query Parameters

required	integer or integer or string start timestamp
	integer or integer or string Default: "current timestamp" end timestamp
device	string optional device name (smbx-Id) if you need alerts of only one specific device
type	string Example: type=Peak Type of alert. Valid alert-types are returned by 'getAlertTypes'

header Parameters

X-Authorization

required

string

Json web token retrieved from the login-endpoint

Responses

Response samples

200
400
401
403
404

Content type

application/json

[{"alertId": "string",
"deviceName": "string",
"alertData": {"type": "string",
"startTime": 0,
"alertDetails": { }
}
}
]

getAlertTypes

Returns list of valid alert types

header Parameters

X-Authorization

required

string

Json web token retrieved from the login-endpoint

Responses

Response samples

200
400
401
403
404

Content type

application/json

["string"
]