Assets HTTP-API assets-http-api

Overzicht overview

Met de HTTP-API van Assets kunt u CRUD-bewerkingen (read-read-update-delete) maken voor digitale elementen, waaronder metagegevens, vertoningen en opmerkingen, en voor gestructureerde inhoud met behulp van Experience Manager Inhoudsfragmenten. Deze wordt weergegeven in /api/assets en wordt geïmplementeerd als REST API. Het omvat steun voor de Fragmenten van de Inhoud.

De API openen:

De API-reactie is een JSON-bestand voor sommige MIME-typen en een antwoordcode voor alle MIME-typen. Het JSON-antwoord is optioneel en is mogelijk niet beschikbaar, bijvoorbeeld voor PDF-bestanden. Vertrouw op de antwoordcode voor verdere analyse of acties.

Na Off Time zijn een element en de bijbehorende uitvoeringen niet beschikbaar via de Assets -webinterface en via de HTTP-API. De API retourneert een foutbericht van 404 als de On Time in de toekomst is of als Off Time in het verleden is.

Inhoudsfragmenten content-fragments

A inhoudsfragmentis een speciaal type van activa. Het kan worden gebruikt om tot gestructureerde gegevens, zoals teksten, aantallen, data toegang te hebben. Aangezien er verschillende verschillen zijn tussen standard -elementen (zoals afbeeldingen of documenten), zijn er enkele aanvullende regels van toepassing op de afhandeling van inhoudsfragmenten.

Voor verdere informatie zie de Steun van de Fragmenten van de Inhoud in Experience Manager Assets HTTP API.

Gegevensmodel data-model

De Assets HTTP API stelt twee belangrijke elementen, omslagen en activa (voor standaardactiva) bloot.

Bovendien, stelt het meer gedetailleerde elementen voor de modellen van douanegegevens bloot die gestructureerde inhoud in de Fragments van de Inhoud beschrijven. Zie Modellen van de Gegevens van het Fragment van de Inhoudvoor verdere informatie.

Mappen folders

Mappen zijn vergelijkbaar met mappen in traditionele bestandssystemen. Het zijn containers voor andere mappen of berichten. Mappen hebben de volgende componenten:

Entiteiten: De entiteiten van een omslag zijn zijn kindelementen, die omslagen en activa kunnen zijn.

Eigenschappen:

de Omslagen van Verbindingen stellen drie verbindingen bloot:

Assets assets

In Experience Manager bevat een element de volgende elementen:

Voor informatie over elementen in de Fragmenten van de Inhoud zie de Steun van de Fragmenten van de Inhoud in HTTP van Experience Manager Assets API.

In Experience Manager heeft een map de volgende componenten:

De Assets HTTP API bevat de volgende functies:

Eerste vereisten

Een mappenlijst ophalen retrieve-a-folder-listing

Haalt een Siren-weergave op van een bestaande map en van de onderliggende entiteiten (submappen of elementen).

Verzoek: GET /api/assets/myFolder.json

de codes van de Reactie: De antwoordcodes zijn:

Reactie: De klasse van de teruggekeerde entiteit is activa of een omslag. De eigenschappen van ingesloten entiteiten vormen een subset van de volledige reeks eigenschappen van elke entiteit. Om een volledige weergave van de entiteit te verkrijgen, moeten clients de inhoud ophalen van de URL waarnaar de koppeling verwijst met een rel van self .

Een map maken create-a-folder

Maakt een nieuwe sling: OrderedFolder op het opgegeven pad. Als een * wordt verstrekt in plaats van een knooppuntnaam, gebruikt servlet de parameternaam als knooppuntnaam. Gegevens die worden geaccepteerd als aanvraaggegevens zijn een Sirene-weergave van de nieuwe map of een set naam-waardeparen, gecodeerd als application/www-form-urlencoded of multipart/ form - data , nuttig om een map te maken die rechtstreeks afkomstig is van een HTML-formulier. Bovendien kunnen eigenschappen van de map worden opgegeven als URL-queryparameters.

Een API-aanroep mislukt met een antwoordcode 500 als het bovenliggende knooppunt van het opgegeven pad niet bestaat. Een aanroep retourneert een antwoordcode 409 als de map al bestaat.

Parameters: name is de omslagnaam.

Verzoek

de codes van de Reactie: De antwoordcodes zijn:

Een element maken create-an-asset

Plaats het opgegeven bestand op het opgegeven pad om een element te maken in de DAM-opslagplaats. Als een * wordt verstrekt in plaats van een knooppuntnaam, gebruikt servlet de parameternaam of de dossiernaam als knooppuntnaam.

Parameters: De parameters zijn name voor de activa naam en file voor de dossierverwijzing.

Verzoek

de codes van de Reactie: De antwoordcodes zijn:

Elementbinair bijwerken update-asset-binary

Hiermee werkt u de binaire waarde (uitvoering met de oorspronkelijke naam) van een element bij. Een update activeert de standaardworkflow voor middelenverwerking om deze uit te voeren, als deze is geconfigureerd.

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

de codes van de Reactie: De antwoordcodes zijn:

Metagegevens van elementen bijwerken update-asset-metadata

Werkt de eigenschappen van de elementmetagegevens bij. Als u een eigenschap in de naamruimte dc: bijwerkt, werkt de API dezelfde eigenschap in de naamruimte jcr bij. De API synchroniseert de eigenschappen niet onder de twee naamruimten.

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

de codes van de Reactie: De antwoordcodes zijn:

Update van metagegevens synchroniseren tussen dc en jcr namespace sync-metadata-between-namespaces

De API-methode werkt de eigenschappen van metagegevens in de naamruimte jcr bij. De updates die worden uitgevoerd via de gebruikersinterface wijzigen de eigenschappen van metagegevens in de naamruimte dc . Als u de waarden van metagegevens wilt synchroniseren tussen dc en jcr -naamruimte, kunt u een workflow maken en Experience Manager configureren om de workflow uit te voeren bij het bewerken van elementen. Gebruik een ECMA-script om de vereiste eigenschappen van metagegevens te synchroniseren. In het volgende voorbeeldscript wordt de titeltekenreeks gesynchroniseerd tussen dc:title en 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();
}
}

Een elementuitvoering maken create-an-asset-rendition

Een elementuitvoering voor een element maken. Als de naam van de parameter request niet wordt opgegeven, wordt de bestandsnaam gebruikt als naam voor de vertoning.

Parameters: De parameters zijn name voor naam van de vertoning en file als dossierverwijzing.

Verzoek

de codes van de Reactie: De antwoordcodes zijn:

Een elementuitvoering bijwerken update-an-asset-rendition

Updates vervangen een elementuitvoering door de nieuwe binaire gegevens.

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

de codes van de Reactie: De antwoordcodes zijn:

Een opmerking toevoegen aan een element create-an-asset-comment

Hiermee maakt u een nieuwe middelenopmerking.

Parameters: De parameters zijn message voor het berichtlichaam van de commentaar en annotationData voor de gegevens van de Annotatie in formaat JSON.

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

de codes van de Reactie: De antwoordcodes zijn:

Een map of element kopiëren copy-a-folder-or-asset

Hiermee kopieert u een map of element die beschikbaar is op het opgegeven pad naar een nieuwe bestemming.

Kopballen van het Verzoek: De parameters zijn:

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

de codes van de Reactie: De antwoordcodes zijn:

Een map of element verplaatsen move-a-folder-or-asset

Hiermee verplaatst u een map of element op het opgegeven pad naar een nieuwe bestemming.

Kopballen van het Verzoek: De parameters zijn:

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

Gebruik /content/dam niet in de URL. Een voorbeeldopdracht voor het verplaatsen van elementen en het overschrijven van bestaande elementen is:

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"

de codes van de Reactie: De antwoordcodes zijn:

Een map, element of uitvoering verwijderen delete-a-folder-asset-or-rendition

Hiermee verwijdert u een resource (-tree) bij het opgegeven pad.

Verzoek

de codes van de Reactie: De antwoordcodes zijn:

Tips en beperkingen tips-best-practices-limitations