Version | Artikellänk |
---|---|
AEM 6.5 | Klicka här |
AEM as a Cloud Service | Den här artikeln |
The Assets HTTP-API:t gör det möjligt att skapa, läsa, uppdatera och 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:
https://[hostname]:[port]/api.json
.https://[hostname]:[server]/api/assets.json
.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.
Alla API-anrop som rör överföring eller uppdatering av resurser eller binära filer i allmänhet (som återgivningar) är föråldrade Experience Manager som Cloud Service distribution. Använd för att överföra binära filer API:er för direkt binär överföring i stället.
A Innehållsfragment är en särskild typ av tillgång. Den kan användas för att komma åt strukturerade data, t.ex. texter, siffror och datum. Som det finns flera skillnader mellan standard
resurser (t.ex. bilder eller dokument), kan vissa ytterligare regler gälla för hantering av innehållsfragment.
Mer information finns i Stöd för innehållsfragment i Experience Manager Assets HTTP-API.
The Assets HTTP API 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. Se Datamodeller för innehållsfragment för ytterligare information.
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:
Enheter: Enheterna i en mapp är dess underordnade element, som kan vara mappar och resurser.
Egenskaper:
name
är namnet på mappen. Detta är samma som det sista segmentet i URL-sökvägen utan tillägget.title
är en valfri mapptitel som kan visas i stället för dess namn.Vissa egenskaper för mapp eller resurs är mappade till ett annat prefix. The jcr
prefix för jcr:title
, jcr:description
och jcr:language
ersätts med dc
prefix. I den returnerade JSON-koden dc:title
och dc:description
innehåller värdena för jcr:title
och jcr:description
, respektive.
Länkar I mapparna visas tre länkar:
self
: Länka till sig själv.parent
: Länka till den överordnade mappen.thumbnail
: (Valfritt) länka till en mappminiatyrbild.I Experience Manager en resurs innehåller 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 en mapp har följande komponenter:
The Assets HTTP API innehåller följande funktioner:
För att underlätta läsbarheten utelämnar följande exempel de fullständiga cURL-noteringarna. Kommentaren korrelerar med Återställ som är en skriptwrapper för cURL.
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 ska klienterna hämta innehållet i den URL som länken pekar på med en rel
av self
.
Skapar en sling
: OrderedFolder
vid den angivna sökvägen. If *
anges i stället för ett nodnamn, används parameternamnet som nodnamn. I begäran godkänns något av följande:
application/www-form-urlencoded
eller multipart
/ form
- data
. Dessa är användbara när du vill skapa en mapp direkt från ett HTML-formulär.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 en svarskod 409
om mappen finns.
Parametrar: name
är mappnamnet.
Begäran
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"
Svarskoder: Svarskoderna är:
Se överföring av resurser om du vill ha information om hur du skapar en resurs. Du kan inte skapa en resurs med HTTP API.
Se överföring av resurser om du vill ha information om hur du uppdaterar resursbinärfiler. Du kan inte uppdatera en resursinbinär fil med HTTP API.
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":{"dc:title":"My Asset"}}'
Svarskoder: Svarskoderna är:
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 renderingens namn och file
som en filreferens.
Begäran
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"
Svarskoder
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:
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:
Kopierar en mapp eller resurs som är tillgänglig på den angivna sökvägen till ett nytt mål.
Begäranrubriker: Parametrarna är:
X-Destination
- en ny mål-URI inom API-lösningens omfång att kopiera resursen till.X-Depth
- antingen infinity
eller 0
. Använda 0
kopierar bara resursen och dess egenskaper och inte dess underordnade.X-Overwrite
- Användning F
för att förhindra att en resurs skrivs över på det befintliga målet.Begäran: COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"
Svarskoder: Svarskoderna är:
Flyttar en mapp eller resurs vid den angivna sökvägen till ett nytt mål.
Begäranrubriker: Parametrarna är:
X-Destination
- en ny mål-URI inom API-lösningens omfång att kopiera resursen till.X-Depth
- antingen infinity
eller 0
. Använda 0
kopierar bara resursen och dess egenskaper och inte dess underordnade.X-Overwrite
- Använd antingen T
för att tvinga bort befintliga resurser eller F
för att förhindra att en befintlig resurs skrivs över.Begäran: MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"
Svarskoder: Svarskoderna är:
Tar bort en resurs (-tree) vid den angivna sökvägen.
Begäran
DELETE /api/assets/myFolder
DELETE /api/assets/myFolder/myAsset.png
DELETE /api/assets/myFolder/myAsset.png/renditions/original
Svarskoder: Svarskoderna är:
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.
Resursens HTTP API returnerar inte alla metadata. Namnutrymmena är hårdkodade och endast dessa namnutrymmen returneras. Fullständiga metadata finns i resurssökvägen /jcr_content/metadata.json
.
Vissa egenskaper för mapp eller resurs mappas till ett annat prefix när de uppdateras med API:er. The jcr
prefix för jcr:title
, jcr:description
och jcr:language
ersätts med dc
prefix. I den returnerade JSON-koden dc:title
och dc:description
innehåller värdena för jcr:title
och jcr:description
, respektive.
Se även