HTTP API för Assets assets-http-api

Med Assets HTTP API kan du skapa, läsa, uppdatera och ta bort (CRUD)-åtgärder för 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.

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, till exempel för 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 Assets webbgränssnitt och via HTTP API. API:t returnerar 404-felmeddelande om On Time kommer i framtiden eller Off Time har redan varit.

Datamodell data-model

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

Mappar folders

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

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

Egenskaper:

Länkar I mapparna visas tre länkar:

Assets assets

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

I Experience Manager en mapp har följande komponenter:

Resursens HTTP-API 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 enheten 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. För att få en fullständig representation av enheten bör kunderna hämta innehållet i den URL som länken pekar på med en rel av self.

Skapa en mapp create-a-folder

Skapar en ny sling: OrderedFolder vid den angivna sökvägen. Om en * anges i stället för ett nodnamn, används parameternamnet som nodnamn. Godkänt som begärandedata är antingen en Siren-representation av den nya mappen eller en uppsättning namn/värde-par, kodade som application/www-form-urlencoded eller multipart/ form- data, användbart när du vill skapa 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 en svarskod 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 en * anges i stället för ett nodnamn, används 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 egenskaperna för resursmetadata. Om du uppdaterar någon egenskap i dc: namnutrymme, uppdaterar API-gränssnittet samma egenskap i jcr namnutrymme. 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 dc och jcr namespace sync-metadata-between-namespaces

API-metoden uppdaterar metadataegenskaperna i jcr namnutrymme. Uppdateringarna som görs med Touch-UI ändrar metadataegenskaperna i dc namnutrymme. Synkronisera metadatavärdena mellan dc och jcr I kan du skapa ett arbetsflöde och konfigurera Experience Manager för att köra arbetsflödet 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 ny 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 renderingens 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 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"

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: