Testversion anfordern
Menü
Funktionen Anwendungsbeispiele Branchen Ratgeber Referenzen Angebot Lizenzmodelle erklärt Download Support Handbuch Video-Tutorials Fragen und Antworten Wartung Fernwartung Kontakt Testversion anfordern
Support / Handbuch / Integrationen

Rest-API Schnittstelle

Daminion Server REST-API (Version 0.9 Beta)

Über die REST-API binden Sie externe Anwendungen per HTTP an den Daminion Server an. So lesen Sie zum Beispiel Medienobjekte, ihre Eigenschaften oder Tags aus. Die API ist in jeder Team-Server-Lizenz ohne Aufpreis enthalten.

Basis-URL

Alle Abfragen beginnen mit dieser Adresse:

http://hostname:8090/api/

8090 ist der Standard-Port. Sie ändern ihn im Daminion Server Administrations-Panel unter „Administration“ -> „Einstellungen…“, Reiter „API“.

Gespeicherte Suchen auflisten

GET /api/tags/savedSearches

Liefert die Liste der gespeicherten Suchen.

Beispiel:

http://localhost:8090/api/tags/savedSearches

Antwort:

<tagValues count="N">
  <tagValue id="%value1%" name="%name1%"/>
  <tagValue id="%value2%" name="%name2%"/>
  …
  <tagValue id="%valueN%" name="%nameN%"/>
</tagValues>

Elemente einer gespeicherten Suche

GET /api/mediaitems/?savedSearchesId=%savedSearchId%&offset=%offset%&limit=%limit%&[tags=%tags%]

Listet die Elemente des Katalogs auf, die zu einer gespeicherten Suche gehören.

Pflichtparameter:

  • savedSearchesId: Kennung der gespeicherten Suche (siehe oben)
  • offset: Startposition in der Ergebnisliste, beginnend bei 0
  • limit: höchste Anzahl zurückgegebener Ergebnisse

Optionaler Parameter:

  • tags: ob die Tags mitgeliefert werden; mögliche Werte none oder all, Standard ist all

Beispiel:

http://localhost:8090/api/mediaitems?savedSearchesId=1&offset=0&limit=25

Antwort:

<mediaItems count="N">
  <mediaItem id="%id%" uri="http://%host%:%port%/api/mediaitems/%id%">
    <tagValues>
      <tagValue key="%tagGuid%" name="%tagName%">%value%</tagValue>
      …
    </tagValues>
  </mediaItem>
  …
</mediaItems>

Tags eines Elements

GET /api/mediaitems/%mediaItemId%

Liefert die Tag-Werte eines bestimmten Elements.

Pflichtparameter: mediaItemId: Kennung des Elements

Beispiel:

http://localhost:8090/api/mediaitems/75

Antwort:

<mediaItem id="%id%" uri="http://%host%:%port%/api/mediaitems/%id%">
  <tagValues>
    <tagValue key="%tagGuid%" name="%tagName%">%value%</tagValue>
    …
  </tagValues>
</mediaItem>

Vorschaubild eines Elements

GET /api/mediaitems/%itemId%/thumbnail?size=%thumbnailSize%

Liefert das Vorschaubild (Miniatur) eines Elements als JPEG.

Pflichtparameter: itemId: Kennung des Elements

Optionaler Parameter: size: Größe der Miniatur; mögliche Werte small, medium oder large, Standard ist medium

Beispiel:

http://localhost:8090/api/mediaitems/75/thumbnail?size=large

Große Vorschau eines Elements

GET /api/mediaitems/%itemId%/preview

Liefert die große Vorschau eines Elements als JPEG.

Pflichtparameter: itemId: Kennung des Elements

Beispiel:

http://localhost:8090/api/mediaitems/75/preview

Tag-Felder auflisten

GET /api/tags

Liefert die Liste aller Tag-Felder.

Beispiel:

http://localhost:8090/api/tags

Antwort:

<tags count="N">
  <tag key="%tagGuid1%" name="%tagName1%"/>
  <tag key="%tagGuid2%" name="%tagName2%"/>
  …
  <tag key="%tagGuidN%" name="%tagNameN%"/>
</tags>

Testen Sie Daminion in Ihrer eigenen Umgebung

Auf Wunsch unterstützen wir Sie bei der Installation.