Versions Compared

Key

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

...

Von einem Drittsystem aus können per DAM API Bildersuchen (mit bestimmten Suchbedingungen z. B. bestimmten Kategorien) im PEIQ DAM abgesetzt werden. Im Anschluss können die gefundenen Bilder bei Bedarf in der gewünschten Auflösung über die DAM API abgeholt werden.

Mögliche Parameter

  • projectId: Bei projectId="create" wird nur eine Suche unter den CREATE-Bildern abgesetzt. Bei proojectId="original" wird unter allen Originalbildern (Status in NGen = Original) gesucht

  • limit: Anzahl der Bilder, die gesucht werden sollen

  • search: Volltextsuche

  • categories: Ressort (IptcRes)

  • services: Dienst (IptcDie)

  • credit: Objektrecht (IptcOR)

  • sentFrom: Erstellt ab

  • sentTo: Erstellt bis

  • offset oder offsetindex: Gibt an, wie viele Bilder in der Ergebnisliste am Anfang übersprungen werden sollen

Beispiel: {baseUrl}/images/search?projectId=create&limit=50&search=paderborn&offset=20211201-11:44:06/261-4018999

Response

Beim Endpunkt GET /images/search liefern die Ergebnisfelder folgende Inhalte

  • id: CID

  • title: Titel/Überschirft (IptcUeb)

  • caption: Caption (Text/|TagName!=BU| Text/BU)

  • category: Ressort (IptcRes)

  • credit: Objektrecht (IptcOR)

  • location: Ort (IptcStadt)

Abrufen von Wertelisten

GET images/values/categories

GET images/values/services

Ein Drittsystem kann eine Liste der Werte für die Suchparameter Ressort (categories) und Dienst (services) für die anschließende Bildsuche abrufen. Die zurückgegebenen Werte sind nur eine Auswahl der möglichen Suchwerte. Es kann auch mit anderen Werten als den aus der Liste gesucht werden.

Der Endpunkt images/values/categories gibt die Werte der NGEN Werteliste WL_DBild_IptcRes zurück. images/values/services gibt die Werte der Werteliste WL_DBild_IptcDie zurück.

Abrufen der neuesten Bilder

...

Ein Drittsystem kann die neuesten Bilder per DAM API abrufen. Diese Bilder können im Anschluss in der gewünschten Auflösung über die DAM API abgeholt werden.

Mögliche Parameter

  • projectId

  • limit

  • offset: Beim ersten Aufruf wird der Offset nicht angegeben. Dann kommt beim Ergebnis ein Offset zurück, der beim nächsten Aufruf wieder mitgegeben wird, um den nächsten Block aufzusetzen. Der Offset besteht aus der Kombination aus CED und CID eines Startbildes (z.B. "20211117-11:52:58/1-16114101").

Beispiel für den Abruf der ersten 500 Bilder: {baseUrl}/images/latest?projectId=create&limit=500

Beispiel für den Abruf der nächsten 500 Bilder: {baseUrl}/images/latest?projectId=create&limit=500&offset=20210714-13:42:41/1-16059606

  • offsetindex: Dieser enthält die Zahl der Bilder, die in der Ergebnisliste am Anfang übersprungen werden. Übergibt man also offsetindex=100 so werden die ersten 1-100 Bilder nicht mit ausgeliefert, sondern erst ab dem 101. Bild

Abrufen der Originalbilder

...

Wurden z. B. über den E-Paper-Export die beschnittenen Bilder (Hard-Crop) exportiert und die IDs der zugehörigen Originalbilder (unbeschnitten) sind bekannt, können die Originalbilder per DAM API in der gewünschten Auflösung abgeholt werden.

Beispiel: {baseUrl}/images/1-16116144/HighRes

Abrufen der Bild-Metainformationen

...

Beschreibung

DAM-API Feld

NGen Eigenschaft

ArchivID

archive_id

DBildArchivID

Caption

caption

Text/
TagName!=BU,Beschreibung, IptcUeb

ErstelltAm

creation_timestamp

CED

ErstelltVon

creation_user

CEB

Bilddateiname

filename

BildDateiName

Honorarkürzel

honorar_id

DBildHonEmpfaenger

Bildursprung

origin

BildUrsprung

OriginalID

original_id

COID

CID

id

CID

Autorname

by_line

IptcAN

Ressort

category

IptcRes

Ort

location

IptcStadt

Objektrecht/Copyright

credit

IptcOR

Land

country

IptcLand

Aufnahmedatum

date_time_created

IptcED

Objektname

object_name

IptcON

Dienst

service_identifier

IptcDie

Quelle

source

IptcQue

Kommentar

special_instructions

IptcKom

Titel/Überschrift

title

IptcUeb

Priorität

urgency

IptcPri

Status

status

Status

BU

underline

Text/BU

Bildquelle innerhalb der BU

image_source

Text/BU/Bildquelle

Schlagwörter

keywords

  • type = person (für Personen) / location (für Orte) / organisation (für Organisationen) / topic (für allgemeine Schlagwörter)

  • priority = Priorität von 1 bis 5

SchlagwortXml

GeändertAm

modification_timestamp

CGD

GeändertVon

modification_user

CGB

Verwendungshinweis für zurückgezogene Bilder

usage_instructions

DBildVerwendungsHinweis

Bildbreite in Pixel

width

BildPixelX

Bildhöhe in Pixel

height

BildPixelY

SHA1-Wert

sha1

SHA1

Bildausschnitt (wird als relatives Rechteck in 1/10000 Einheiten ausgegeben)

area

  • height

  • width

  • position_x

  • position_y

BildAusschnitt

Beispiel: {baseUrl}/images/1-16116144

Anlegen von neuen Originalbildern

...