Inhaltsverzeichnis
Objekte verlinken
Endpunkt: POST - /api/v1/link/link
Version: 2.23.219
Beschreibung: Verknüpft ein Objekt mit einem weiteren
Beispiel Request:
http://localhost:5041/api/v1/link/link?fromRegisterUri=antony://mail/0&toRegisterUri=antony://contact/123
Beispiel Response:
200 Statuscode
{
"ResultCode": 0
"Message": ""
}
Der ResultCode kann folgende Bedeutung haben:
0 = Ok
1 = Eine der übergebenen RegisterUri’s ist falsch
2 = Ein Fehler ist im Service aufgetreten
Das Message Feld kann Informationen zum ResultCode enthalten.
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Objekt Verlinkung aufheben
Endpunkt: DELETE - /api/v1/link/unlink
Version: 2.23.219
Beschreibung: Hebt die Verknüpfung zwischen Objekten auf
Beispiel Request:
http://localhost:5041/api/v1/link/unlink?fromRegisterUri=antony://mail/0&toRegisterUri=antony://contact/123
Beispiel Response:
200 Statuscode
{
"ResultCode": 0
"Message": ""
}
Der ResultCode kann folgende Bedeutung haben:
0 = Ok
1 = Eine der übergebenen RegisterUri’s ist falsch
2 = Ein Fehler ist im Service aufgetreten
Das Message Feld kann Informationen zum ResultCode enthalten.
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Verlinkte Objekte abholen
Endpunkte:
GET- /api/v1/calendar/by-resource/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}
GET- /api/v2/chat/command/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}
GET- /api/v1/contacts/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}
GET- /api/v1/mail/query//getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}
hier fehlen die Flexobjekte!
Version: 2.23.219
Beschreibung: Gibt alle Objekte zurück die vom Typen Chat, Kalender, Kontakt oder Mail sind und mit der angegeben RegisterUri verknüpft sind
Beispiel Request:
http://localhost:5041/api/v1/link/link?fromRegisterUri=antony://mail/0&toRegisterUri=antony://contact/123
Beispiel Response:
200 Statuscode
Gibt eine Auflistung der Objekte zurück
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Um die RegisterUri eines Objekts zu bekommen muss man als Feld (sofern möglich) noch “registerUri” mit angeben
Suchen nach Objekten zum verlinken (fehlt)
Endpunkt: GET- /api/v1/link/searchObjectsToLink ?
Version:
Beschreibung: gibt eine Liste von Standardobjekten zurück, die mit dem objekt verknüpft werden können
http://localhost:5041/api/v1/link/searchObjectsToLink?RegisterUri=antony://mail/0
Beispiel Respone
[
{
icon -> base64 encoded icon
description -> beschreibung aus antony (zusammen)
id -> id des objektes
objecttype -> 3 für mails, ....
}
]
Anzeige der verlinkten Objekte
Endpunkt: GET- /api/v1/link/getLinkedObjects
Version:
Beschreibung: gibt eine Liste von Standardobjekten zurück, die mit dem Object verlinkt sind
http://localhost:5041/api/v1/link/getLinkedObjects?RegisterUri=antony://mail/0
Beispiel Respone
[
{
icon -> base64 encoded icon
description -> beschreibung aus antony (zusammen)
id -> id des objektes
objecttype -> 3 für mails, ....
}
]