Assets-HTTP-API

Die Assets-HTTP-API ermöglicht CRUD-Vorgänge (Create-Read-Update-Delete, Erstellen/Lesen/Aktualisieren/Löschen) für digitale Assets, einschließlich Metadaten, Ausgabedarstellungen und Kommentaren sowie strukturierten Inhalten mit Experience Manager-Inhaltsfragmenten. Sie wird unter /api/assets bereitgestellt und als REST-API implementiert.

So greifen Sie auf die API zu:

1. Öffnen Sie das Dokument zum API-Service unter https://[hostname]:[port]/api.json.
2. Folgen Sie dem Link zum Assets-Service, der zu https://[hostname]:[server]/api/assets.json führt.

Die API antwortet mit einer JSON-Datei für einige MIME-Typen und einem Antwort-Code für alle MIME-Typen. Die JSON-Antwort ist optional und kann zum Beispiel nicht für PDF-Dateien verfügbar sein. Verwenden Sie den Antwort-Code für weitere Analysen oder Aktionen.

Nach der Ausschaltzeit sind ein Asset und seine Ausgabedarstellungen weder über die Assets-Web-Oberfläche noch über die HTTP-API verfügbar. Die API gibt die Fehlermeldung 404 zurück, wenn die Einschaltzeit in der Zukunft oder die Ausschaltzeit in der Vergangenheit liegt.

Datenmodell

Die Assets-HTTP-API stellt zwei wichtige Elemente bereit: Ordner und Assets (für Standard-Assets).

Ordner

Ordner verhalten sich wie Verzeichnisse in traditionellen Dateisystemen. Sie stellen Container für andere Ordner oder Assets dar. Ordner enthalten folgende Komponenten:

Entitäten: Zu den Entitäten eines Ordners zählen die untergeordneten Elemente, z. B. die Ordner und Assets.

Eigenschaften:

• name ist der Name des Ordners. Dies entspricht dem letzten Segment im URL-Pfad ohne die Erweiterung.
• title Ist ein optionaler Titel des Ordners, der anstelle des Namens angezeigt werden kann

Links-Ordner stellen drei Links bereit:

• self: Link zu sich selbst.
• parent: Link zum übergeordneten Ordner.
• thumbnail: (Optionaler) Link zu einem Ordnerminiaturbild.

Assets

Experience Managers ein Asset die folgenden Elemente enthält:

• Die Eigenschaften und Metadaten des Assets.
• Mehrere Ausgabedarstellungen, z. B. die ursprüngliche Ausgabedarstellung (das ursprünglich hochgeladene Asset), eine Miniaturansicht und viele andere Ausgabedarstellungen. Bei den zusätzlichen Ausgabedarstellungen kann es sich um Bilder unterschiedlicher Größe, verschiedene Videokodierungen oder aus PDF- oder Adobe InDesign-Dateien extrahierte Seiten handeln.
• Optionale Kommentare.

In Experience Manager enthält ein Ordner die folgenden Komponenten:

• Entitäten: Die untergeordneten Elemente von Assets sind die Ausgabedarstellungen.
• Eigenschaften.
• Links.

Die Assets-HTTP-API bietet die folgenden Funktionen:

• Abrufen von Ordnerauflistungen.
• Erstellen eines Ordners.
• Erstellen von Assets.
• Aktualisieren der Asset-Binärdatei.
• Aktualisieren der Asset-Metadaten.
• Erstellen von Asset-Ausgabedarstellungen.
• Aktualisieren von Asset-Ausgabedarstellungen.
• Erstellen von Asset-Kommentaren.
• Kopieren von Ordnern oder Assets.
• Verschieben von Ordnern oder Assets.
• Löschen von Ordnern, Assets oder Ausgabedarstellungen.

Voraussetzungen

• Greife Sie auf https://[aem_server]:[port]/system/console/configMgr zu.
• Navigieren Sie zu Adobe Granite CSRF Filter.
• Stellen Sie sicher, dass die Eigenschaft Filtermethoden Folgendes enthält: POST, PUT, DELETE.

Abrufen von Ordnerauflistungen

Ruft eine Siren-Darstellung eines vorhandenen Ordners und seiner untergeordneten Entitäten ab (Unterordner oder Assets).

Anfrage: GET /api/assets/myFolder.json

Antwort-Codes: Die Antwort-Codes sind:

• 200 – OK – Erfolg.
• 404 – NICHT GEFUNDEN – Ordner existiert nicht oder ist nicht zugänglich.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Antwort: Die Klasse der zurückgegebenen Entität ist ein Asset oder ein Ordner. Die Eigenschaften der enthaltenen Entitäten bilden eine Teilmenge der vollständigen Eigenschaften jeder Entität. Um eine vollständige Darstellung der Entität zu erreichen, sollten Kunden den Inhalt der URL abrufen, auf die der Link mit einem rel von self verweist.

Erstellen von Ordnern

Erstellt einen neuen Ordner sling: OrderedFolder im festgelegten Pfad. Wenn statt eines Knotennamens ein * angegeben wird, verwendet das Servlet den Parameternamen als Knotennamen. Akzeptiert als Anfragedaten wird entweder eine Siren-Darstellung des neuen Ordners oder ein Satz von Name-Wert-Paaren, kodiert als application/www-form-urlencoded oder multipart/ form- data. Dies ist dann sinnvoll, wenn Sie einen Ordner direkt aus einem HTML-Formular erstellen. Zusätzlich können die Eigenschaften des Ordners als URL-Abfrageparameter angegeben werden.

Wenn der übergeordnete Knoten des angegebenen Pfades nicht vorhanden ist, schlägt der API-Aufruf mit einem Antwort-Code 500 fehl. Ein Aufruf gibt einen Antwort-Code 409 zurück, wenn der Ordner bereits vorhanden ist.

Parameter: name ist der Ordnername.

Anfrage

• POST /api/assets/myFolder -H"Content-Type: application/json" -d '{"class":"assetFolder","properties":{"title":"My Folder"}}'
• POST /api/assets/* -F"name=myfolder" -F"title=My Folder"

Antwort-Codes: Die Antwort-Codes sind:

• 201 – ERSTELLT – bei erfolgreicher Erstellung.
• 409 – KONFLIKT – wenn der Ordner bereits existiert.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn die Stammsammlung nicht gefunden oder nicht aufgerufen werden kann.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Erstellen von Assets

Platzieren Sie die bereitgestellte Datei am angegebenen Pfad, um ein Asset im DAM-Repository zu erstellen. Wenn anstelle eines Knotennamens ein * angegeben wird, verwendet das Servlet den Parameternamen oder den Dateinamen als Knotennamen.

Parameter: Die Parameter beziehen sich name auf den Asset-Namen und file auf die Dateireferenz.

Anfrage

• POST /api/assets/myFolder/myAsset.png -H"Content-Type: image/png" --data-binary "@myPicture.png"
• POST /api/assets/myFolder/* -F"name=myAsset.png" -F"file=@myPicture.png"

Antwort-Codes: Die Antwort-Codes sind:

• 201 - ERSTELLT - wenn Asset erfolgreich erstellt wurde.
• 409 - KONFLIKT - wenn Asset bereits vorhanden.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn die Stammsammlung nicht gefunden oder nicht aufgerufen werden kann.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Aktualisieren von Asset-Binärdateien

Aktualisiert die Binärdatei eines Assets (Darstellung mit dem Namen Original). Bei einer Aktualisierung wird der standardmäßige Arbeitsablauf für die Verarbeitung von Assets ausgeführt, sofern er konfiguriert ist.

Anfrage: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: image/png" --data-binary @myPicture.png

Antwort-Codes: Die Antwort-Codes sind:

• 200 – OK – wenn das Asset erfolgreich aktualisiert wurde.
• 404 – NICHT GEFUNDEN – wenn das Asset nicht gefunden oder unter dem angegebenen URI nicht aufgerufen werden konnte.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn die Stammsammlung nicht gefunden oder nicht aufgerufen werden kann.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Aktualisieren der Asset-Metadaten

Aktualisiert die Asset-Metadateneigenschaften. Wenn Sie eine Eigenschaft im dc:-Namespace aktualisieren, aktualisiert die API dieselbe Eigenschaft im jcr-Namespace. Die API synchronisiert die Eigenschaften unter den beiden Namespaces nicht.

Anfrage: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"jcr:title":"My Asset"}}'

Antwort-Codes: Die Antwort-Codes sind:

• 200 – OK – wenn das Asset erfolgreich aktualisiert wurde.
• 404 – NICHT GEFUNDEN – wenn das Asset nicht gefunden oder unter dem angegebenen URI nicht aufgerufen werden konnte.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn die Stammsammlung nicht gefunden oder nicht aufgerufen werden kann.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Synchronisieren Sie Metadaten-Update zwischen dc und jcr Namensraum

Die API-Methode aktualisiert die Metadateneigenschaften im Namensraum jcr. Die mithilfe von Touch-UI vorgenommenen Aktualisierungen ändern die Metadateneigenschaften im Namensraum dc. Um die Metadatenwerte zwischen dem Namensraum dc und dem jcr zu synchronisieren, können Sie einen Workflow erstellen und Experience Manager konfigurieren, der den Workflow beim Bearbeiten von Assets ausführt. Verwenden Sie ein ECMA-Skript, um die erforderlichen Metadateneigenschaften zu synchronisieren. Das folgende Beispielskript synchronisiert die Titelzeichenfolge zwischen dc:title und jcr:title.

var workflowData = workItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH")
{
 var path = workflowData.getPayload().toString();
 var node = workflowSession.getSession().getItem(path);
 var metadataNode = node.getNode("jcr:content/metadata");
 var jcrcontentNode = node.getNode("jcr:content");
if (jcrcontentNode.hasProperty("jcr:title"))
{
 var jcrTitle = jcrcontentNode.getProperty("jcr:title");
 metadataNode.setProperty("dc:title", jcrTitle.toString());
 metadataNode.save();
}
}

Erstellen von Asset-Ausgabedarstellungen

Erstellt eine neue Asset-Ausgabedarstellung für ein Asset. Wenn der Name nicht als Anfrageparameter angegeben wurde, wird der Dateiname als Ausgabedarstellungsname verwendet.

Parameter: Die Parameter sind name für den Namen der Ausgabedarstellung und file als ein Dateiverweis.

Anfrage

• POST /api/assets/myfolder/myasset.png/renditions/web-rendition -H"Content-Type: image/png" --data-binary "@myRendition.png"
• POST /api/assets/myfolder/myasset.png/renditions/* -F"name=web-rendition" -F"file=@myRendition.png"

Antwort-Codes: Die Antwort-Codes sind:

• 201 – ERSTELLT - wenn die Ausgabedarstellung erfolgreich erstellt wurde.
• 404 – NICHT GEFUNDEN – wenn das Asset nicht gefunden oder unter dem angegebenen URI nicht aufgerufen werden konnte.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn die Stammsammlung nicht gefunden oder nicht aufgerufen werden kann.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Aktualisieren von Asset-Ausgabedarstellungen

Aktualisiert bzw. ersetzt eine Asset-Ausgabedarstellung durch die neuen Binärdaten.

Anfrage: PUT /api/assets/myfolder/myasset.png/renditions/myRendition.png -H"Content-Type: image/png" --data-binary @myRendition.png

Antwort-Codes: Die Antwort-Codes sind:

• 200 – OK – wenn die Ausgabedarstellung erfolgreich aktualisiert wurde.
• 404 – NICHT GEFUNDEN – wenn das Asset nicht gefunden oder unter dem angegebenen URI nicht aufgerufen werden konnte.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn die Stammsammlung nicht gefunden oder nicht aufgerufen werden kann.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Hinzufügen eines Kommentars zu einem Asset

Erstellt einen neuen Asset-Kommentar.

Parameter: Die Parameter sind message für den Nachrichtentext des Kommentars und annotationData für die Anmerkungsdaten im JSON-Format bestimmt.

Anfrage: POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"

Antwort-Codes: Die Antwort-Codes sind:

• 201 – ERSTELLT - wenn der Kommentar erfolgreich erstellt wurde.
• 404 – NICHT GEFUNDEN – wenn das Asset nicht gefunden oder unter dem angegebenen URI nicht aufgerufen werden konnte.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn die Stammsammlung nicht gefunden oder nicht aufgerufen werden kann.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Kopieren von Ordnern oder Assets

Kopiert einen Ordner oder ein Asset in dem angegebenen Pfad in ein neues Ziel.

Anfrage-Header: Die Parameter sind:

• X-Destination – ein neuer Ziel-URI im Bereich der API-Lösung, in den die Ressource kopiert werden soll.
• X-Depth – entweder infinity oder 0. Mit 0 werden nur die Ressource und ihre Eigenschaften kopiert und nicht ihre untergeordneten Elemente.
• X-Overwrite – Verwenden Sie F, um ein Überschreiben eines Assets am vorhandenen Ziel zu verhindern.

Anfrage: COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"

Antwort-Codes: Die Antwort-Codes sind:

• 201 – ERSTELLT – wenn der Ordner/das Asset in ein nicht vorhandenes Ziel kopiert wurde.
• 204 – KEIN INHALT – wenn der Ordner/das Asset in ein vorhandenes Ziel kopiert wurde.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn ein Anfrage-Header fehlt.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Verschieben von Ordnern oder Assets

Verschiebt einen Ordner oder ein Asset in dem angegebenen Pfad in ein neues Ziel.

Anfrage-Header: Die Parameter sind:

• X-Destination – ein neuer Ziel-URI im Bereich der API-Lösung, in den die Ressource kopiert werden soll.
• X-Depth – entweder infinity oder 0. Mit 0 werden nur die Ressource und ihre Eigenschaften kopiert und nicht ihre untergeordneten Elemente.
• X-Overwrite Verwenden Sie entweder T, um das Löschen einer vorhandenen Ressource zu erzwingen, oder F, um das Überschreiben einer vorhandenen Ressource zu verhindern.

Anfrage: MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"

Antwort-Codes: Die Antwort-Codes sind:

• 201 – ERSTELLT – wenn der Ordner/das Asset in ein nicht vorhandenes Ziel kopiert wurde.
• 204 – KEIN INHALT – wenn der Ordner/das Asset in ein vorhandenes Ziel kopiert wurde.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn ein Anfrage-Header fehlt.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.

Löschen eines Ordners, eines Assets oder einer Ausgabedarstellung

Löscht eine Ressource(nstruktur) im angegebenen Pfad.

Anfrage

• DELETE /api/assets/myFolder
• DELETE /api/assets/myFolder/myAsset.png
• DELETE /api/assets/myFolder/myAsset.png/renditions/original

Antwort-Codes: Die Antwort-Codes sind:

• 200 – OK – wenn der Ordner erfolgreich gelöscht wurde.
• 412 – VORBEDINGUNG FEHLGESCHLAGEN – wenn die Stammsammlung nicht gefunden oder nicht aufgerufen werden kann.
• 500 – INTERNER SERVER-FEHLER – wenn etwas anderes schief geht.