Adobe Experience Manager 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.

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 (t.ex. 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 som i de traditionella filsystemen. Mappen kan bara innehålla resurser, bara mappar, eller mappar och resurser. 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:

Tillgängliga funktioner available-features

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

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 sling: OrderedFolder vid den angivna sökvägen. Om * anges i stället för ett nodnamn används parameternamnet som nodnamn. I begäran godkänns något av följande:

Mappens egenskaper kan också 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 finns.

Parametrar: name är mappnamnet.

Begäran

Svarskoder: Svarskoderna är:

Skapa en resurs create-an-asset

Mer information om hur du skapar en resurs finns i överföring av resurser. Du kan inte skapa en resurs med HTTP API.

Uppdatera en resurbinär update-asset-binary

Mer information om hur du uppdaterar resursbinärfiler finns i Överför resurser. Du kan inte uppdatera en resursinbinär fil med HTTP API.

Uppdatera metadata för en resurs update-asset-metadata

Uppdaterar egenskaperna för resursmetadata. 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":{"dc:title":"My Asset"}}'

Svarskoder: Svarskoderna är:

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

Skapa en å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

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

Uppdateringarna 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

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"

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, metodtips och begränsningar tips-limitations

Se även