Assets HTTP API assets-http-api

Ökning overview

HTTP-API:t Assets tillåter åtgärder för att skapa/läsa-uppdatera-ta bort (CRUD) på digitala resurser, inklusive metadata, återgivningar och kommentarer, samt strukturerat innehåll med Experience Manager innehållsfragment. Den exponeras vid /api/assets och implementeras som REST API. Den innehåller stöd för innehållsfragment.

Så här kommer du åt API:

API-svaret är en JSON-fil för vissa MIME-typer och en svarskod för alla MIME-typer. JSON-svaret är valfritt och kanske inte är tillgängligt för exempelvis PDF-filer. Använd svarskoden för ytterligare analyser eller åtgärder.

Efter Off Time är en resurs och dess återgivningar inte tillgängliga via webbgränssnittet Assets och via HTTP-API:t. API:t returnerar 404-felmeddelande om On Time ligger i framtiden eller om Off Time redan finns.

Innehållsfragment content-fragments

Ett innehållsfragment är en särskild typ av resurs. Den kan användas för att komma åt strukturerade data, t.ex. texter, siffror och datum. Eftersom det finns flera skillnader mellan standard-resurser (till exempel bilder eller dokument) gäller vissa ytterligare regler för hantering av innehållsfragment.

Mer information finns i Stöd för innehållsfragment i Experience Manager Assets HTTP API.

Datamodell data-model

HTTP-API:t Assets visar två huvudelement, mappar och resurser (för standardresurser).

Dessutom visas mer detaljerade element för anpassade datamodeller som beskriver strukturerat innehåll i innehållsfragment. Mer information finns i Datamodeller för innehållsfragment.

Mappar folders

Mappar är som kataloger i traditionella filsystem. De är behållare för andra mappar eller kontroller. Mappar har följande komponenter:

Entiteter: Enheterna i en mapp är dess underordnade element, som kan vara mappar och resurser.

Egenskaper:

Länkar-mappar visar tre länkar:

Assets assets

I Experience Manager innehåller en resurs följande element:

Mer information om element i innehållsfragment finns i Stöd för innehållsfragment i Experience Manager Assets HTTP API.

I Experience Manager har en mapp följande komponenter:

HTTP-API:t Assets innehåller följande funktioner:

Förutsättningar

Hämta en mapplista retrieve-a-folder-listing

Hämtar en siren-representation av en befintlig mapp och av dess underordnade enheter (undermappar eller resurser).

Begäran: GET /api/assets/myFolder.json

Svarskoder: Svarskoderna är:

Svar: Klassen för entiteten som returneras är en resurs eller en mapp. Egenskaperna för enheter som ingår är en deluppsättning av alla egenskaper för varje enhet. Om du vill få en fullständig representation av entiteten måste klienterna hämta innehållet i den URL som länken pekar på med rel av self.

Skapa en mapp create-a-folder

Skapar en ny sling: OrderedFolder vid den angivna sökvägen. Om * anges i stället för ett nodnamn använder serverleten parameternamnet som nodnamn. Data accepteras antingen som en Siren-representation av den nya mappen eller som en uppsättning namn/värde-par, kodade som application/www-form-urlencoded eller multipart/ form- data, vilket är användbart när du skapar en mapp direkt från ett HTML-formulär. Dessutom kan mappens egenskaper anges som URL-frågeparametrar.

Ett API-anrop misslyckas med en 500-svarskod om den överordnade noden för den angivna sökvägen inte finns. Ett anrop returnerar svarskoden 409 om mappen redan finns.

Parametrar: name är mappnamnet.

Begäran

Svarskoder: Svarskoderna är:

Skapa en resurs create-an-asset

Placera den angivna filen på den angivna sökvägen för att skapa en resurs i DAM-databasen. Om * anges i stället för ett nodnamn använder serverleten parameternamnet eller filnamnet som nodnamn.

Parametrar: Parametrarna är name för resursnamnet och file för filreferensen.

Begäran

Svarskoder: Svarskoderna är:

Uppdatera en resurbinär update-asset-binary

Uppdaterar en resurs binärfil (återgivning med namnet original). En uppdatering utlöser standardarbetsflödet för resurshantering som körs, om det är konfigurerat.

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

Svarskoder: Svarskoderna är:

Uppdatera metadata för resurs update-asset-metadata

Uppdaterar metadataegenskaperna för resursen. Om du uppdaterar någon egenskap i namnutrymmet dc: uppdaterar API:t samma egenskap i namnutrymmet jcr. API:t synkroniserar inte egenskaperna under de två namnutrymmena.

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

Svarskoder: Svarskoderna är:

Synkronisera metadatauppdatering mellan namnområdet dc och jcr sync-metadata-between-namespaces

API-metoden uppdaterar metadataegenskaperna i namnområdet jcr. Uppdateringarna som görs med användargränssnittet ändrar metadataegenskaperna i namnområdet dc. Om du vill synkronisera metadatavärdena mellan dc och jcr-namnområdet kan du skapa ett arbetsflöde och konfigurera Experience Manager så att arbetsflödet körs när resursen redigeras. Använd ett ECMA-skript för att synkronisera de metadataegenskaper som krävs. Följande exempelskript synkroniserar titelsträngen mellan dc:title och 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();
}
}

Skapa en resursåtergivning create-an-asset-rendition

Skapa en resursåtergivning för en resurs. Om parameternamnet för begäran inte anges används filnamnet som återgivningsnamn.

Parametrar: Parametrarna är name för återgivningens namn och file som en filreferens.

Begäran

Svarskoder: Svarskoderna är:

Uppdatera en resursåtergivning update-an-asset-rendition

Uppdateringar ersätter en resursåtergivning med nya binära data.

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

Svarskoder: Svarskoderna är:

Lägga till en kommentar till en resurs create-an-asset-comment

Skapar en ny resurskommentar.

Parametrar: Parametrarna är message för kommentarens meddelandetext och annotationData för anteckningsdata i JSON-format.

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

Svarskoder: Svarskoderna är:

Kopiera en mapp eller en resurs copy-a-folder-or-asset

Kopierar en mapp eller en resurs som är tillgänglig på den angivna sökvägen till ett nytt mål.

Begäranrubriker: Parametrarna är:

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

Svarskoder: Svarskoderna är:

Flytta en mapp eller en resurs move-a-folder-or-asset

Flyttar en mapp eller resurs vid den angivna sökvägen till ett nytt mål.

Begäranrubriker: Parametrarna är:

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

Använd inte /content/dam i URL:en. Ett exempelkommando för att flytta resurser och skriva över befintliga är:

curl -u admin:admin -X MOVE https://[aem_server]:[port]/api/assets/source/file.png -H "X-Destination: https://[aem_server]:[port]/api/assets/destination/file.png" -H "X-Overwrite: T"

Svarskoder: Svarskoderna är:

Ta bort en mapp, en resurs eller en återgivning delete-a-folder-asset-or-rendition

Tar bort en resurs (-tree) vid den angivna sökvägen.

Begäran

Svarskoder: Svarskoderna är:

Tips och begränsningar tips-best-practices-limitations