Zum Hauptinhalt springen

POST /links

Beschreibung

Fügt einen neuen Link hinzu und gibt ein JSON-Objekt mit der neuen Link-ID zurück

Diese Route verarbeitet HTTP POST-Anfragen, die an den Endpunkt /links gesendet werden.

Payload

Der Server erwartet ein JSON-Objekt mit den folgenden Eigenschaften:

NameTypBeschreibung
masterIdnumber oder stringErforderlich. Die ID des Master-Links.
slaveIdnumber oder stringErforderlich. Die ID des Slave-Links.
relationstringErforderlich. Definiert die Art der Beziehung, die der Link darstellt.

Beispiel:

{
"masterId": 1,
"slaveId": 2,
"relation": "relatesTo",
}

Antwort

Die Antwort gibt ein JSON-Objekt mit der ID des neu erstellten Links zurück.

Beispiel:

{ 
"id": 1
}

Der HTTP-Statuscode zeigt an, ob die Anfrage erfolgreich war (response.status == 200) oder fehlgeschlagen ist (response.status == 500).


Verwandte Artikel: