Zugriff via REST-API

Verwalten von Schlüsseln

Schlüssel für den Abruf von Daten können unter im Menü unter Einstellungen / Keys eingesehen werden. Falls ein Verdacht besteht, ein Schlüssel ist in ungewollte Hände gekommen, kann hier ebenfalls der Schlüssel für eine Instanz zurückgesetzt werden.

Abfrage von Messwerten

Messwerte können mit Hilfe eines POST-Statements abgerufen werden. Hierzu wird der Servername und ein Schlüssel benötigt.

POST http://datenberg-server/data-get/?_key=key

Als Optionen stehen dabei zur Verfügung:

{
columns: [],
metadata: [],
filters: [],
limit: 1
}

• Columns: Liste der abzurufenden Messmerkmale. Es muss mindestens eine Spalte angegeben werden.
• Metadata: Optional; Liste der abzurufenden Metadaten
• Filter: Optional; Liste von Filtern; Hierbei können Wertfilter oder Bereichsfilter verwendet werden
• Limit: Optional:; Maximale Anzahl abzurufender Zeilen. Wird kein Limit abgegeben, wird eine Zeile abgerufen.

Beispiele für Filter

Mit einem Wertfilter kann nach spezifischen Werten gefilter werden. Zum Beispiel nur Daten für einen Fertigungsauftrag.

{
   id: "",
   values: []
}

id: Messmerkmal oder Metadaten
values: Liste von Werten

Mit einem Bereichsfilter kann ein Bereich von Daten ausgewählt werden. Zum Beispiel alle Fertigungsaufträge mit Nummern von 1000 bis 1050. Dieser Filtertyp kann nicht auf Text angewandt werden.

{
   id: "",
   min: 0,
   max: 0
}

id: Messmerkmal oder Metadaten (außer Text)
min: Minimaler Wert
max: Maximaler Wert

Beispiel

Anfrage POST-Statement

import requests

myobj = {
   columns: ["c199283", "c853fe6", "cde71a7"],
   metadata: ["m66f36a"],
   filters: [
   {
      id: "m736ee2",
      values: ["Line 1"]
   }
   ],
   limit: 50
}

x = requests.post(http://datenberg-server/data-get/?_key=key, json = myobj) 

print(x.text)

Antwort bei Erfolg

Eine Antwort enthält eine Liste aller Zeilen, die den Filtern entsprechen. In jeder Zeile sind dieangefragten Messmerkmale und Metadaten enthalten.

{
   success: true,
   data: [
   {
      column: data,
      ...
   },
   ...
   ]
}

Antwort bei Fehler

Wurde ein ungültiger API-Key angegeben oder ist die Anfrage ungültig, wird eine Fehlermeldung zurückgegeben.

{
   success: false,
   error: "Fehlermeldung"
}