Documentatie

Eingehender Hook, um eine Ressource zu erstellen oder zu aktualisieren.

POST hook/resource/

Verwendet für

Eingehender Hook, um eine Ressource zu erstellen oder zu aktualisieren.
Eine Ressource kann ein Standort, Personal oder ein Standardtyp sein.

Authentifizierung

Der Benutzer muss auf Administratorebene angemeldet sein.

Parameter

Diese Tabelle zeigt einige der Kernvariablen.

Parameter Beschreibung Erforderlich Ort Beispiel
id Ressourcen-ID Nein* Body
external_id Falls angegeben, wird eine Ressource mit dieser externen ID gesucht Nein* Body
desc Die Beschreibung Nein Body
long_desc Die ausführliche Beschreibung Nein Body
type 1=Standort, 2=Personal, 3=Standard Nein Body
before Zeit davor in Minuten Nein Body
after Zeit danach in Minuten Nein Body
amount Anzahl, Standard 1 Nein Body

* Keine der Variablen ist primär erforderlich. Eine korrekte Kombination von Variablen ist jedoch erforderlich und bestimmt die auszuführende Aktion.

  • Wenn "id" angegeben ist, wird die Ressource mit den angegebenen Feldern aktualisiert.
  • Wenn "id" nicht angegeben ist, aber "external_id" schon, wird die Ressource mit dieser external_id aktualisiert.
  • Wenn "id" und "external_id" nicht angegeben sind oder angegeben sind, aber nicht gefunden werden können, wird eine neue Ressource erstellt.

Beispiel

Ressource "BAAN1" erstellen.

POST api/rest/hook/resource/ 
Request
{
  "external_id": "3114hqq4rqsvlhgr8s66msvju9",
  "type": "3",
  "name": "BAAN1",
  "desc": "Tennis baan 1"
}
Response: 
{
            "ownerid": "10",
            "name": "BAAN1",
            "desc": "Tennis baan 1",
            "long_desc": "",
            "type": "3",
            "before": "",
            "after": "",
            "amount": "1",
            "external_id": "3114hqq4rqsvlhgr8s66msvju9"
}

Wenn Ressourcen über eine externe Quelle angelegt werden, müssen die Ressourcen noch mit Objekten verbunden werden, bevor sie funktional in Betrieb genommen werden können. Diese API eignet sich insbesondere für das Aktualisieren von Attributen bestehender Ressourcen.