Sie sehen sich Hilfeinhalte der folgenden Version an:

Überblick

Die Assets-HTTP-API ist ein spezieller Teil der allgemeinen Marketing Cloud-API. Die allgemeine Dokumentation finden Sie in der Benutzerdokumentation zur Marketing Cloud-API.

Die Assets-HTTP-API wird unter /api/assets bereitgestellt und ermöglicht CRUD-Vorgänge (Create-Read-Update-Delete, Erstellen/Lesen/Aktualisieren/Löschen) für Assets, einschließlich Binärdateien, Metadaten, Ausgabeformate und Kommentare.

Aktuelle Implementierung

Die Assets-HTTP-API wurde erstmals mit Adobe Experience Manager (AEM) Assets 6.1 implementiert.

So greifen Sie auf die API zu:

  1. Starten Sie AEM.

  2. Öffnen Sie das Dokument zum API-Dienst unter http://<Servername>:<Port>/api.json.

  3. Folgen Sie dem Link zum Assets-Dienst.

Datenmodell

Die Assets-HTTP-API stellt zwei wichtige Elemente bereit: Ordner und Assets.

Ordner

Ordner sind mit Verzeichnissen in traditionellen Dateisystemen vergleichbar. 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  -- Name of the folder. This is the same as the last segment in the URL path without the extension
title -- Optional title of the folder which can be displayed instead of its name

Links

Ordner stellen drei Links bereit:

self      -- Link to itself
parent    -- Link to the parent folder
thumbnail -- (Optional) link to a folder thumbnail image

Assets

Bei Assets handelt es sich eigentlich um Elemente aus mehreren Teilen:

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

Ordner enthalten folgende Komponenten:

Entitäten

Die untergeordneten Elemente von Assets sind die Ausgabeformate.

Eigenschaften

Links

Verfügbare Funktionen

Die Assets-HTTP-API bietet die folgenden Funktionen:

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

Hinweis:

Zur besseren Lesbarkeit der folgenden Beispiele wird die vollständige cURL-Notation weggelassen. Tatsächlich korreliert die Notation mit Resty, dem Skript-Wrapper für cURL.

Voraussetzungen
  • Gehen Sie zu http://<Server>:<Port>/system/console/configMgr.
  • Navigieren Sie zu Adobe Granite CSRF-Filter.
  • Stellen Sie sicher, dass die Eigenschaft Filtermethoden Folgendes enthält: POST, PUT und DELETE.

Abrufen von Ordnerauflistungen

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

Anforderung

GET /api/assets/myFolder.json

Antwortcodes

200 - OK - success
404 - NOT FOUND - folder does not exist or is not accessible
500 - INTERNAL SERVER ERROR - if something else goes wrong

Antwort

Die Klasse der zurückgegebenen Entität ist Assets/Ordner.

Die Eigenschaften der enthaltenen Entitäten bilden eine Untergruppe der vollständigen Eigenschaften einer jeden 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 Anforderungsdaten 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 Vorgang mit einem Antwortcode 500 fehl. Wenn der Ordner bereits vorhanden ist, wird der Antwortcode 409 zurückgegeben.

Parameter

name - Folder name

Anforderung

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

Oder

POST /api/assets/* -F"name=myfolder" -F"title=My Folder"

Antwortcodes

201 - CREATED - on successful creation
409 - CONFLICT - if folder already exist
412 - PRECONDITION FAILED - if root collection cannot be found or accessed
500 - INTERNAL SERVER ERROR - if something else goes wrong

Erstellen von Assets

Erstellt ein DAM-Asset in dem angegebenen Pfad mit der angegebenen Datei. Wenn statt eines Knotennamens ein * angegeben wird, verwendet das Servlet den Parameternamen oder Dateinamen als Knotennamen.

Parameter

name - Asset name
file - File reference

Anforderung

POST /api/assets/myFolder/myAsset.png -H"Content-Type: image/png" --data-binary "@myPicture.png"

oder

POST /api/assets/myFolder/* -F"name=myAsset.png" -F"file=@myPicture.png"

Antwortcodes

201 - CREATED - if Asset has been created successfully
409 - CONFLICT - if Asset already exist
412 - PRECONDITION FAILED - if root collection cannot be found or accessed
500 - INTERNAL SERVER ERROR - if something else goes wrong

Aktualisieren der Asset-Binärdatei

Aktualisiert eine Asset-Binärdatei (Ausgabeformat mit Originalnamen). Dadurch wird der standardmäßige Asset-Workflow ausgelöst, wenn er entsprechend konfiguriert ist.

Anforderung

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

Antwortcodes

200 - OK - if Asset has been updated successfully
404 - NOT FOUND - if Asset could not be found or accessed at the provided URI
412 - PRECONDITION FAILED - if root collection cannot be found or accessed
500 - INTERNAL SERVER ERROR - if something else goes wrong

Aktualisieren der Asset-Metadaten

Aktualisiert die Asset-Metadateneigenschaften.

Anforderung

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

Antwortcodes

200 - OK - if Asset has been updated successfully
404 - NOT FOUND - if Asset could not be found or accessed at the provided URI
412 - PRECONDITION FAILED - if root collection cannot be found or accessed
500 - INTERNAL SERVER ERROR - if something else goes wrong

Erstellen von Asset-Ausgabeformaten

Erstellt ein neues Asset-Ausgabeformat für ein Asset. Wenn der Anforderungsparametername nicht angegeben wurde, wird der Dateiname als Ausgabeformatname verwendet.

Parameter

name - Rendition name
file - File reference

Anforderung

POST /api/assets/myfolder/myasset.png/renditions/web-rendition -H"Content-Type: image/png" --data-binary "@myRendition.png"

oder

POST /api/assets/myfolder/myasset.png/renditions/* -F"name=web-rendition" -F"file=@myRendition.png"

Antwortcodes

201 - CREATED - if Rendition has been created successfully
404 - NOT FOUND - if Asset could not be found or accessed at the provided URI
412 - PRECONDITION FAILED - if root collection cannot be found or accessed
500 - INTERNAL SERVER ERROR - if something else goes wrong

Aktualisieren von Asset-Ausgabeformaten

Aktualisiert bzw. ersetzt ein Asset-Ausgabeformat durch die neuen Binärdaten.

Anforderung

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

Antwortcodes

200 - OK - if Rendition has been updated successfully
404 - NOT FOUND - if Asset could not be found or accessed at the provided URI
412 - PRECONDITION FAILED - if root collection cannot be found or accessed
500 - INTERNAL SERVER ERROR - if something else goes wrong

Erstellen von Asset-Kommentaren

Erstellt einen neuen Asset-Kommentar.

Parameter

message - Message
annotationData - Annotation data (JSON)

Anforderung

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

Antwortcodes

201 - CREATED - if Comment has been created successfully
404 - NOT FOUND - if Asset could not be found or accessed at the provided URI
412 - PRECONDITION FAILED - if root collection cannot be found or accessed
500 - INTERNAL SERVER ERROR - if something else goes wrong

Kopieren von Ordnern oder Assets

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

Anforderungs-Header

X-Destination - a new destination URI within the API solution scope to copy the resource to
X-Depth - either 'infinity' or '0'. The value '0' only copies the resource and its properties, no children.
X-Overwrite - 'F' to prevent overwriting an existing destination

Anforderung

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

Antwortcodes

201 - CREATED - if folder/asset has been copied to a non-existing destination
204 - NO CONTENT - if the folder/asset has been copied to an existing destination
412 - PRECONDITION FAILED - if a request header is missing or
500 - INTERNAL SERVER ERROR - if something else goes wrong

Verschieben von Ordnern oder Assets

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

Anforderungs-Header

X-Destination - a new destination URI within the API solution scope to copy the resource to
X-Depth - either 'infinity' or '0'. The value '0' only copies the resource and its properties, no children.
X-Overwrite - either 'T' to force deletion of existing resources or 'F' to prevent overwriting an existing resource.

Anforderung

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

Antwortcodes

201 - CREATED - if folder/asset has been copied to a non-existing destination
204 - NO CONTENT - if the folder/asset has been copied to an existing destination
412 - PRECONDITION FAILED - if a request header is missing or
500 - INTERNAL SERVER ERROR - if something else goes wrong

Löschen von Ordnern, Assets oder Ausgabeformaten

Löscht eine Ressource (Struktur) in dem angegebenen Pfad.

Anforderung

DELETE /api/assets/myFolder

oder

DELETE /api/assets/myFolder/myAsset.png

oder

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

Antwortcodes

200 - OK - if folder has been deleted successfully
412 - PRECONDITION FAILED - if root collection cannot be found or accessed
500 - INTERNAL SERVER ERROR - if something else goes wrong

Dieses Werk unterliegt den Bedingungen der Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License.  Twitter™- und Facebook-Beiträge fallen nicht unter die Bedingungen der Creative Commons-Lizenz.

Rechtliche Hinweise   |   Online-Datenschutzrichtlinie