Zum Hauptinhalt springen

POST /links

Beschreibung

Erstellt einen neuen Link und gibt ein JSON-Objekt mit einer neuen Link-ID zurück.

Die Route verarbeitet die HTTP POST-Anfrage, die an den Pfad /links gesendet wird.

Payload

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

NameTypBeschreibung
sourcenumber oder stringErforderlich. Die ID des Start-Links.
targetnumber oder stringErforderlich. Die ID des End-Links.
relationstringErforderlich. Der Typ der durch den Link erstellten Beziehung.

Beispiel:

{
"source": 1,
"target": 2,
"relation": "relatesTo"
}

Antwort

Die Route gibt ein JSON-Objekt mit einer neuen Link-ID 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: