Inhaltsverzeichnis
Stichworte abrufen
Endpunkt: GET- /api/v1/tagDefinition?skip={skip}&take={take}
Version: 2.22.129
Beschreibung: Löscht den angegebenen Tag
Beispiel Request:
/api/v1/tagDefinition?skip=0&take=5
Beispiel Response:
200 Statuscode
{ "ResultCode": 0, "Data": { "Id": 2 }, "Message": null }
Resulcode enum:
0 = Erfolgreich
1 = Tag existiert nicht
2 = Interner Server Fehler
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Stichwort erstellen
Endpunkt: POST - /api/v1/tagDefinition
Version: 2.22.129
Beschreibung: Erstellt einen neues Stichwort
Beispiel Request:
{ "parentId": 0, "Text": "Lorem Ipsum" }
Beispiel Response:
200 Statuscode
{ "ResultCode": 0, "Data": { "Id": 2, "ParentId": 0, "Text": "Lorem Ipsum" }, "Message": null }
Resulcode enum:
0 = Erfolgreich
1 = Interner Server Fehler
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Stichwort updaten
Endpunkt: PUT- /api/v1/tagDefinition
Version: 2.22.129
Beschreibung: Aktualisiert das angegebene Stichwort
Beispiel Request:
{ "id": 2, "parentId": 0, "Text": "Lorem Ipsum 2" }
Beispiel Response:
200 Statuscode
{ "ResultCode": 0, "Data": { "Id": 2, "ParentId": 0, "Text": "Lorem Ipsum 2" }, "Message": null }
Resulcode enum:
0 = Erfolgreich
1 = Tag existiert nicht
2 = Interner Server Fehler
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Stichwort löschen
Endpunkt: POST - /api/v1/tagDefinition
Version: 2.22.129
Beschreibung: Löscht das angegeben Stichwort
Beispiel Request:
{ "id": 2 }
Beispiel Response:
200 Statuscode
{ "ResultCode": 0, "Data": { "Id": 2 }, "Message": null }
Resulcode enum:
0 = Erfolgreich
1 = Tag existiert nicht
2 = Interner Server Fehler
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Alle Verknüpfungen anhand einer RegisterUri abholen
Endpunkt: POST - /api/v1/tagLink?registerUri={registerUri}&skip={skip}&take={take}
Version: 2.22.129
Beschreibung: Holt alle Stichworte ab die mit einem bestimmten Objekt verknüpft sind
Beispiel Request:
/api/v1/tagLink?registerUri=antony://mail/1601&skip=0&take=5
Beispiel Response:
200 Statuscode
[ { "registerUri":"antony://mail/1601", "tagId": 2 }, { "registerUri":"antony://mail/1601", "tagId": 3 } ]
Resulcode enum:
0 = Erfolgreich
1 = Interner Server Fehler
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Alle Verknüpfungen anhand der Tag Id abholen
Endpunkt: POST - /api/v1/tagLink?tagId={tagId}&skip={skip}&take={take}
Version: 2.22.129
Beschreibung: Gibt alle Verknüpfungen zwischen Objekt und Tag ab die mit dem angegeben Tag versehen sind
Beispiel Request:
/api/v1/tagLink?tagId=2&skip=0&take=5
Beispiel Response:
200 Statuscode
[ { "registerUri":"antony://mail/1601", "tagId": 2 }, { "registerUri":"antony://mail/1602", "tagId": 2 } ]
Resulcode enum:
0 = Erfolgreich
1 = Interner Server Fehler
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Objekt mit einem Stichwort verknüpfen
Endpunkt: POST - /api/v1/tagLink
Version: 2.22.129
Beschreibung: Verknüpft ein Stichwort mit einem Objekt
Beispiel Request:
{ "registerUri" : "antony://mail/1601", "tagId": 1 }
Beispiel Response:
200 Statuscode
{ "ResultCode": 0, "Data": { "Id": 2 }, "Message": null }
Resulcode enum:
0 = Erfolgreich
1 = Interner Server Fehler
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Stichwort von einem Objekt entfernen
Endpunkt: POST - /api/v1/tagLink
Version: 2.22.129
Beschreibung: Entfernt die Verknüpfung zwischen einem Stichwort und einem Objekt
Beispiel Request:
{ "registerUri" : "antony://mail/1601", "tagId": 1 }
Beispiel Response:
200 Statuscode
{ "ResultCode": 0, "Data": { "Id": 2 }, "Message": null }
Resulcode enum:
0 = Erfolgreich
1 = Interner Server Fehler
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können