Verknüpfen API
- Pascal Kordas
- Dennis Scheidner
Teil von AntonyLegacy
Inhaltsverzeichnis
Objekte verknüpfen
Endpunkt: POST - /api/v1/link
Version: 2.22.126
Beschreibung: Verknüpft ein Objekt mit einem weiteren
Beispiel Request:
{
"fromRegisterUri":"antony://mail/1601",
"toRegisterUri":"antony://contact/1211"
}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 Verknüpfung aufheben
Endpunkt: DELETE - /api/v1/link
Version: 2.22.126
Beschreibung: Hebt die Verknüpfung zwischen Objekten auf
Beispiel Request:
{
"fromRegisterUri":"antony://mail/1601",
"toRegisterUri":"antony://contact/1211"
}Beispiel Response:
200 Statuscode
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Alle Verknüpften Objekte eines Objekts abholen
Endpunkt: GET - /api/v1/link?registerUri={registerUri}&skip={skip}&take={take}
Version: 2.22.126
Beschreibung: Hebt die Verknüpfung zwischen Objekten auf
Beispiel Request:
http://localhost/api/v1/link?registerUri=antony://mail/1601&skip=0&take=5
Beispiel Response:
200 Statuscode
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Alle Verknüpften Objekte eines Objekts durchsuchen
Endpunkt: GET - /api/v1/link?registerUri={registerUri}&searchText={searchText}&skip={skip}&take={take}
Version: 2.22.126
Beschreibung: Hebt die Verknüpfung zwischen Objekten auf
Beispiel Request:
http://localhost/api/v1/link?registerUri=antony://mail/1601&searchText=Max+Mustermann&skip=0&take=5
Beispiel Response:
200 Statuscode
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Alle verknüpfbaren Objekte mit Suchtext suchen
Endpunkt: GET - /api/v1/link/getLinkableObjects?searchText={searchText}&skip={skip}&take={take}
Version: 2.22.132
Beschreibung: Gibt alle Objekte zurück die verknüpfbar sind.
Beispiel Request:
http://localhost/api/v1/link/getLinkableObjects?searchText=Das+ist+ein+Test&skip=0&take=5
Beispiel Response:
200 Statuscode
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Verknüpfte Objekte (Bestimmter Typ) abholen
Endpunkte:
GET- /api/v1/calendar/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}&fields={fields}
GET- /api/v1/chat/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}&fields={fields}
GET- /api/v1/contacts/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}&fields={fields}
GET- /api/v1/mail/query/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}&fields={fields}
GET- /api/v1/flexobject/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take} | Hier gibt es kein Fields Parameter
Version: 2.22.132
Beschreibung: Gibt alle Objekte zurück die vom Typen Chat, Kalender, Kontakt oder Mail sind und mit der angegeben RegisterUri verknüpft sind
Beispiel Response:
200 Statuscode
Gibt eine Auflistung der Objekte zurück
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error