Versions Compared

Old Version 3

changes.mady.by.user Pascal Kordas

Saved on

compared with

New Version Current

changes.mady.by.user Dennis Scheidner

Saved on

Key

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

Teil von AntonyLegacy

Inhaltsverzeichnis

Table of Contents
minLevel2
maxLevel2

Objekte

...

verknüpfen

Endpunkt: GET POST - /api/v1/link/link
Version: 2.2322.219126
Beschreibung: Verlinkt 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: GET - /api/v1/link/unlink?registerUri={registerUri}&skip={skip}&take={take}
Version: 2.2322.219126
Beschreibung: Hebt die Verlinkung 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://mail/1601",
        "CommonCaption": "Das ist eine Test E-Mail",
        "CommonFrom": "john@doe.de",
        "CommonTo": "max@mustermann.de"
    },
    {
        "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://mail/1601",
        "CommonCaption": "Das ist eine Test E-Mail",
        "CommonFrom": "john@doe.de",
        "CommonTo": "max@mustermann.de"
    },
    {
         "ResultCode": 0"RegisterUri": "antony://contact/1002",
        "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.

401 Statuscode:

Kein Body

500 Statuscode:

Interner Server Error

Note

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

...

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

Code Block
[
   {
        "RegisterUri": "antony://mail/1601",
        "CommonCaption": "Das ist eine Test E-Mail",
        "CommonFrom": "john@doe.de",
        "CommonTo": "max@mustermann.de"
    },
    {
        "RegisterUri": "antony://contact/1002",
        "CommonCaption": "Max Mustermann - Musterstraße 12",
        "CommonFrom": "",
        "CommonTo": ""
    }
]

401 Statuscode:

Kein Body

500 Statuscode:

...

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}&fields={fields}

GET- /api/v2v1/chat/command/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.2322.219132
Beschreibung: Gibt alle Objekte zurück die vom Typen Chat, Kalender, Kontakt oder Mail sind und mit der angegeben RegisterUri verlinkt sind

Beispiel Request:

...

verknüpft sind

Beispiel Response:

200 Statuscode

Gibt eine Auflistung der Objekte zurück

...