Über API aktualisieren, löschen und ausführen
 |
Die Beispiele in diesem Thema setzen voraus, dass Sie mit dem Ausführen von HTTP-POSTS in der Webentwicklungsumgebung oder -anwendung vertraut sind.
|
Die folgenden Regeln helfen, zu verstehen, was basierend auf dem Typ der ausgegebenen Anforderung erforderlich ist.
|
Hinweise
|
Beispiel-URL
|
HTTP-Aktion
|
Inhaltstyp
|
|||
|---|---|---|---|---|---|---|
|
UPDATE
|
Aktualisierungen erfordern auch die Angabe des Entitätsteils.
|
http://host/Thingworx/Things/thing_name
|
PUT
|
application/json oder text/xml
|
||
|
DELETE
|
Löschvorgänge erfordern auch die Angabe des Entitätsteils.
|
http://host/Thingworx/Things/thing_name
|
DELETE
|
N/A
|
||
|
INVOKING SERVICES
|
Das Aufrufen eines Dienstes erfordert die Angabe der kompletten URL, einschließlich des spezifischen Merkmals.
|
http://host/Thingworx/Things/MyThing/Services/myService
|
POST
|
application/json
|
HTTP-Anforderungen ausführen
Wenn Sie HTTP-Anforderungen ausführen, verwenden Sie die UTF-8-Kodierung, und geben Sie den optionalen Portwert an (falls erforderlich).
 |
Es wird empfohlen, HTTPS in der Produktion zu verwenden oder immer dann, wenn die Netzwerkintegrität fraglich ist.
|
HTTP-Antwortcodes verarbeiten
In den meisten Fällen sollte Inhalt oder der Statuscode 200 zurückgegeben werden. Dies ist OK. Im Falle eines Fehlers erhalten Sie eine Fehlermeldung.
Mit HTTP-Inhalt arbeiten
Wenn Sie HTTP-Inhalt (JSON, XML, HTML (nur für Antworten)) senden oder empfangen, legen Sie die Inhaltstyp-Kopfzeile der Anforderung auf den entsprechenden Wert basierend auf dem gesendeten HTTP-Inhalt fest.
|
Methoden
|
|
|---|---|
|
GET
|
Rufen Sie einen Wert ab.
|
|
PUT
|
Schreiben Sie einen Wert, oder erstellen Sie neue Dinge oder Eigenschaften.
|
|
POST
|
Führen Sie einen Dienst aus.
|
|
DELETE
|
Löschen Sie ein Ding oder eine Eigenschaft.
|
|
Accept-Kopfzeilenwerte
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
|
HTML
|
text/html (oder Accept-Kopfzeile auslassen)
|
|
CSV
|
text/csv
|
|
Inhaltstyp-Kopfzeilenwerte
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
Metadaten
Sie können Metadaten aller Dinge, Dingvorlagen oder Formen anzeigen, die Sie erstellen, indem Sie folgende URL in einem Web-Browser öffnen: NameoftheThing/Metadata
|
|
Um diese Informationen anzuzeigen, müssen sie als JSON angezeigt werden.
|
Authentifizierung mit REST-API-Aufruf übergeben
Die empfohlene optimale Vorgehensweise besteht darin, einen Anwendungsschlüssel zu verwenden. Generieren Sie den Anwendungsschlüssel in ThingWorx. Anschließend können Sie ihn mit dem REST-Aufruf in Form einer HTTP-Kopfzeile übergeben.
Ersetzen Sie den Kopfzeilenwert durch den Anwendungsschlüssel, der für die ThingWorx Instanz gültig ist, die Sie verbinden möchten.
|
Kopfzeilenschlüssel
|
Beispiel für Kopfzeilenwert
|
|---|---|
|
appKey
|
1x9256cf-9fe9-434e-adbe-9772c0c40261
|
Die ThingWorx REST-API unterstützt zwei andere Authentifizierungsmethoden:
• Die Standardauthentifizierung ermöglicht es Ihnen, sich mit Ihrem Benutzernamen und Passwort zu authentifizieren.
• Übergabe des Anwendungsschlüssels als URL-Parameter. Diese Methode wird aus Sicherheitsgründen nicht empfohlen und ist in einer zukünftigen Version veraltet.
Verwandte Links