Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DescriptionMethodHeaderURLURL Path ParamsURL Query ParamsRequest PayloadReturn
Downlink creationPOST
  • Authorization with org-admin or device-admin token (see Access Tokens)
/api/devices/{devId}/downlikdownlink
  • devId: Database ID of the device

The Body contains the downlink content.

See also: Downlinks

  • 200 ok
    • Body: Empty
  • error status code
    • Body: information about the error
Device creationPOST
  • Authorization with org-admin or device-admin token (see Access Tokens)
/api/devices--

deviceInput as JSON

{

"name": "Gateway_1",

"addr": "FFFFFFFFFFFFFFFF",

"description": "3.OG Wohnung Müller", 

"deviceTypeId": 2,

"initialConfig": null,

"location": null,

"serial": "1337",

"tags": ["Müller", "MbusGw", "3.OG"],

"certEnforcesDtls": false

}

  • 200 ok
    • Body: Device as JSON
  • error status code
    • Body: information about the error
User creationPOST
  • Authorization with org-admin token (see Access Tokens)
/api/organisation/user--

userInput as JSON :
{
"name": "Eample Test",
"email": "e.test@test.com",
"password": "s0meSecur3Pw",
"roles": ["org-admin","device-admin"]
}

  • 200 ok
    • Body: User Json
    • {"data":{"id":17,"createdAt":"2022-07-04T10:59:41.975812+02:00","updatedAt":"2022-07-04T10:59:41.975812+02:00","login":"e.test@test.com","name":"Eample Test","email":"e.test@test.com","organisationId":1,"roles":["device-admin"]}}
  • error status code
    • Body: information about the error



...