Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

Ergänzende Informationen zur API-Doku für die Verwendung der Generic MultiQueue

In einer MultiQueue kann die ID (eines Objekts) mehrfach vorkommen. Je nach Anforderung müssen Sie bei einem Delete darauf achten, ob Sie alle Einträge zu einer ID oder nur einen bestimmten Eintrag löschen möchten.

Alle Einträge zu einer ID aus der GenericMultiQueue löschen


DELETE /api/rest/genericMultiQueue/remove/<ID>

Beispiel
DELETE /api/rest/genericMultiQueue/remove/12345

Einen bestimmten Eintrag aus der GenericMultiQueue löschen


Geben Sie eine sortId mit, sodass das System nur den definierten Eintrag entfernt. Um die sortId zu erhalten, geben Sie bei der Abfrage folgendes Property mit:

Beispiel
GET /api/rest/object?provider=genericmultiqueue&query=<ident der Queue>&properties=id&properties=genericMultiQueueSortId&properties=uuid&properties=~

Beispiel
GET /api/rest/object?provider=genericmultiqueue&query=odoo.Eingangsrechnung&properties=id&properties=genericMultiQueueSortId&properties=uuid&properties=~

Durch diese Abfrage erhalten Sie die id, die genericMultiQueueSortId sowie alle Metadaten und die uuid der in der Queue befindlichen Objekte.

Passender Delete zu obigem Beispiel:

DELETE /api/rest/genericMultiQueue/remove/1234567?sortId=987654321

Ein Objekt zur Queue hinzufügen


POST /api/rest/genericMultiQueue/add/[agorum-object-id]

ident: <ident>
data: <optionale Zeichenkette>