/
IconService (/icon)

IconService (/icon)

Owned by Team Dodo
Last updated: Apr 01, 2025 by Technische Redaktion

 

Über den IconService können Katalog-Icons zu Trefferlisten-Objekten abgerufen werden. Innerhalb von Trefferlisten existiert dazu ein JSON-Attribut "iconId", welches die ID des Katalog-Icons des Objekts angibt.

/osrest/api/icon/preload

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: KEINE

Die Methode lädt eine Liste von Katalog-Icons von enaio® server. Somit muss enaio® appconnector später bei der Verwendung von icon/{id} nicht jedes Icon einzeln von enaio® server abrufen. Bei Erfolg wird lediglich ein HTTP 204 Statuscode (erfolgreich, no content) ohne Inhalt zurückgegeben. Im Fehlerfall weicht der HTTP-Statuscode entsprechend ab.

{ "iconIds": [ 1073741986, 1073741987, 1073741988, 1073742158, 1073742242 ]  }

/osrest/api/icon/ids

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Die Methode lädt eine Liste von Katalog-Icons aus dem Cache oder nicht vorgeladene Icons vom enaio® server. Bei Erfolg wird unter der Property "icons" eine Map mit der Icon ID als key und dem Icon als value ausgegeben. Konnten bestimmte Icons nicht geladen werden, werden diese mit entsprechender Fehlermeldung unter "failed" mit aufgeführt. Die Struktur der Fehler entspricht dabei der anderer "MultiAktionen" wie z.B. "workflows/personalize". Die Property "failed" wird nicht aufgeführt, wenn keine Fehler auftraten.

Anfragebeispiel

{ "iconIds": [ 1073742058, 123456789 ]  }

Rückgabeformat

{ "icons": { "1073742058": "R0lGODlhEAAQAPcAAAAAAGB4kGBwmGh4mGh4oHCAoHiAqHiI..." }, // Die Property "failed" wird nicht aufgeführt, wenn keine Fehler auftraten. "failed": [{ "item": { "id": "123456789" }, "error": { "root": "ICON_NOT_FOUND", "errorCode": 3200, "message": "The Icon with Id [123456789] was not found on the server.", "stackTrace": [ ... ] } }] }

/osrest/api/icon/{id}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: Image/gif

Diese Methode liefert das Katalog-Icon mit der angefragten ID zur Einbettung in ein <img....>-Tag zurück. Bei mehreren Icons in Trefferlisten wird empfohlen, diese zuvor über die preload-Methode zuladen zu lassen.