Beispiele

Im folgenden Beispiel wird ein Licht über die REST API geschaltet.

Zunächst müssen die erforderlichen Schritte zur Authentifizierung durchgeführt werden (siehe Abschnitte „Vorbereitung“ und „Authentifizierung“). Mit dem dabei erhaltenen Token können anschließend die erforderlichen Anfragen und Befehle gesendet werden.

Zuerst wird eine GET-Anfrage an "http://[Smart_Building_Automation_IP]/api/instances" gesendet. Als Antwort wird eine Liste aller aktuell im Smart Building Automation System vorhandenen Instanzen zurückgegeben.

{
  "statusCode": 200,
  "statusText": "success",
  "data": [
    {
      "ID": "SC1_M04.Light1",
      "ClassName": "SmartCOM.Light.Light",
      "Name": "Arbeitslicht",
      "Group": "AreaOutdoor"
    },
    ...
  ]
}

Da ein Licht geschaltet werden soll, wird hier das „Arbeitslicht“ ausgewählt. Über den „ClassName“ „SmartCOM.Light.Light“ kann anschließend eine GET-Anfrage an "http://[Smart_Building_Automation_IP]/api/apps/SmartCOM.Light.Light" gesendet werden, um die verfügbaren Methoden und Eigenschaften abzurufen.

{
  "statusCode": 200,
  "statusText": "success",
  "data": {
    "methods": [
      {
        "parameter": [],
        "name": "SwitchOn",
        "type": 0,
        "derived": false,
        "tags": [
          "linkable"
        ],
        "returnType": "void",
        "description": "Einschalten",
        "isStatic": false
      },
      ...
    ],
    "properties": [
      {
        "name": "IsOn",
        "type": "boolean",
        "remark": "Licht eingeschaltet",
        "declaration": "2",
        "derived": true,
        "parameter": false,
        "tags": [
          "linkable"
        ],
        "isStatic": false
      },
      ...
    ],
    "fullName": "SmartCOM.Light.Light",
    "displayName": "Licht",
    "autoStart": false
  }
}

Anschließend wird eine POST-Anfrage an "http://[Smart_Building_Automation_IP]/api/instances/SC1_M04.Light1/SwitchOn" mit folgenden Parametern im Header gesendet:

• instanceId: SC1_M04.Light1
• action: SwitchOn
• body: [ ]

Dadurch wird die entsprechende Methode des Lichts aufgerufen und das Licht eingeschaltet. Der aktuelle Status kann über eine GET-Anfrage an "http://[Smart_Building_Automation_IP]/api/instances/SC1_M04.Light1/IsOn" abgefragt werden. Als Antwort wird der aktuelle Status zurückgegeben, in diesem Fall 'true'.

{
  "statusCode": 200,
  "statusText": "success",
  "data": true
}