Versions Compared

Old Version 6

changes.mady.by.user Dennis Scheidner

Saved on

compared with

New Version 7

changes.mady.by.user Pascal Kordas

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel2
maxLevel2

Objekte

...

verknüpfen

Endpunkt: POST - /api/v1/link/link
Version: 2.2322.219126
Beschreibung: Verknüpft ein Objekt mit einem weiteren

Beispiel Request:

Code Block
http://localhost:5041{
    "fromRegisterUri":"antony://mail/1601",
    "toRegisterUri":"antony://contact/1211"
}

Beispiel Response:

200 Statuscode

Code Block
{
  "ResultCode": 0
  "Message": ""
}
Info

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

Note

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:

Code Block
{
    "fromRegisterUri":"antony://mail/0&toRegisterUri=1601",
    "toRegisterUri":"antony://contact/1231211"
}

Beispiel Response:

200 Statuscode

Code Block
{
  "ResultCode": 0
  "Message": ""
}

...

Note

Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können

...

Alle Verknüpften Objekte eines Objekts abholen

Endpunkt: DELETE GET - /api/v1/link/unlink?registerUri={registerUri}&skip={skip}&take={take}
Version: 2.2322.219126
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

Code Block
[
    {
        "RegisterUri": "antony://contact/1211",
        "CommonCaption": "John - Doe",
        "CommonFrom": "",
        "CommonTo": ""
    },
    {
        "RegisterUri": "antony://flexobject/4/86",
        "CommonCaption": "Das ist ein Test Flexobjekt",
        "CommonFrom": "",
        "CommonTo": ""
    }
]

Das Icon Feld wird in Zukunft noch dazu kommen. Aktuell haben wir nicht auf die schnelle die Möglichkeit die Icons mit zu implementieren

Info

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

Note

Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können

...

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

Code Block
[
    {
        "RegisterUri": "antony://contact/1002",
     "ResultCode": 0    "CommonCaption": "Max Mustermann - Musterstraße 12",
        "CommonFrom": "",
        "MessageCommonTo": ""
    }
]

Das Icon Feld wird in Zukunft noch dazu kommen. Aktuell haben wir nicht auf die schnelle die Möglichkeit die Icons mit zu implementieren

Info

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.

...

Note

Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können

...

Verknüpfte Objekte (Bestimmter Typ) abholen

Endpunkte:
GET- /api/v1/calendar/by-resource/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}

GET- /api/v1/flexobject/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}

hier fehlen die Flexobjekte!

Version: 2.2322.219126
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:

Code Block
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

...

Info

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

Code Block
http://localhost:5041/api/v1/link/searchObjectsToLink?RegisterUri=antony://mail/0

Beispiel Respone

Code Block
languagejson
[
{
  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

Code Block
http://localhost:5041/api/v1/link/getLinkedObjects?RegisterUri=antony://mail/0

Beispiel Respone

Code Block
languagejson
[ { icon -> base64 encoded icon description -> beschreibung aus antony (zusammen) id -> id des objektes objecttype -> 3 für mails, .... } ]

...