Extended Server API - SINTEF-9012/ThingModel GitHub Wiki

Websocket server commands

• live
• load :timestamp:
• play
• pause

Websocket server answers

• live
• pause
• :timestamp:
• error message

REST API

• /channels
• /:endpoint/create?name&description
• /:endpoint/update?name&description
• Update the name and the description
• /:endpoint?timestamp
• /:endpoint/infos
• /:endpoint/timeline?precision
• /:endpoint/clear
• /:endoint/load/:timestamp
• /:endpoint/delete
• Hide the channel from the list, and it will not be loaded after the next server restart (doesn't really delete it instantly)
• Create it again to cancel:-)

Websocket connection options

• ?readonly=true
• ?writeonly=true

Security

{
  "/" : {
    "32dd3d39210122dc979d45ebd93cafc56c6375a8": "readonly",
    "plain_text_key": "readwrite"
  },
  "/lapin": {
    "cc8f1787c96c81ed1470e79bc457b8a6e9259a67": "readonly",
    "iVBORw0KGgoAAAANSUhEUgAAAAQAAAAECAIAAAAmkwkpAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3wIGCikBTsEiTQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAG0lEQVQI12NgQAb///+HM5iQhaAcRkZGBgYGAPiYCP/Wd5e9AAAAAElFTkSuQmCC": "writeonly",
    "^ is a base64 png key picture": "readonly"
   },
   "/canard": {
     "32dd3d39210122dc979d45ebd93cafc56c6375a8": "readonly"
   }
}

• ?key
• Set the required key
  • Read access is required for timeline, infos, json output
  • write access is required for load, clear, create, update and delete
• /:endpoint/securityreload
• Reload the authentication file