Adobe Experience Manager Assets HTTP-API assets-http-api
Overzicht overview
De Assets Met de HTTP-API kunt u CRUD-bewerkingen (read-read-update-delete) maken voor digitale elementen, waaronder metagegevens, uitvoeringen en opmerkingen, en voor gestructureerde inhoud met gebruik van Experience Manager Inhoudsfragmenten Het wordt blootgesteld bij /api/assets en is geïmplementeerd als REST API. Hieronder vallen ondersteuning voor inhoudsfragmenten.
De API openen:
- Open het API-servicedocument op
https://[hostname]:[port]/api.json. - Volg de Assets servicekoppeling die leidt naar
https://[hostname]:[server]/api/assets.json.
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.
Inhoudsfragmenten content-fragments
A Inhoudsfragment is een speciaal soort actief. 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 enkele aanvullende regels van toepassing op de afhandeling van inhoudsfragmenten.
Zie voor meer informatie Ondersteuning voor inhoudsfragmenten in het dialoogvenster Experience Manager Assets HTTP-API.
Gegevensmodel data-model
De Assets HTTP API stelt twee belangrijke elementen, omslagen en activa (voor standaardactiva) bloot. Bovendien worden meer gedetailleerde elementen beschikbaar gesteld voor aangepaste gegevensmodellen die gestructureerde inhoud in Content Fragments beschrijven. Zie Gegevensmodellen van inhoudsfragmenten voor nadere informatie.
Mappen folders
Mappen zijn vergelijkbaar met mappen zoals in traditionele bestandssystemen. De map kan alleen elementen, alleen mappen of mappen en elementen bevatten. Mappen hebben de volgende componenten:
Entiteiten: De entiteiten van een map zijn onderliggende elementen, mappen en elementen.
Eigenschappen:
nameis de naam van de map. Dit is het zelfde als het laatste segment in de weg URL zonder de uitbreiding.titleis een optionele titel van de map die in plaats van de naam kan worden weergegeven.
jcr voorvoegsel jcr:title, jcr:description, en jcr:language worden vervangen door dc voorvoegsel Vandaar in de geretourneerde JSON, dc:title en dc:description bevatten de waarden van jcr:title en jcr:description, respectievelijk.Koppelingen Mappen maken drie koppelingen zichtbaar:
self: Koppeling naar zichzelf.parent: Koppeling naar de bovenliggende map.thumbnail: (Optioneel) koppeling naar een miniatuurafbeelding van een map.
Assets assets
In Experience Manager een element bevat de volgende elementen:
- De eigenschappen en metagegevens van het element.
- Oorspronkelijk geüpload binair bestand van het element.
- Meerdere uitvoeringen, zoals geconfigureerd. Dit kunnen afbeeldingen van verschillende grootten, video's van verschillende coderingen of uitgenomen pagina's van PDF of Adobe InDesign bestanden.
- Optionele opmerkingen.
Zie voor informatie over elementen in inhoudsfragmenten Ondersteuning voor inhoudsfragmenten in Experience Manager Assets HTTP API.
In Experience Manager een map bevat de volgende componenten:
- Entiteiten: De onderliggende elementen van activa zijn de uitvoeringen.
- Eigenschappen.
- Koppelingen.
Beschikbare functies available-features
De Assets HTTP API bevat de volgende functies:
- Een mappenlijst ophalen.
- Een map maken.
- Een element maken (afgekeurd)
- Binair element bijwerken (afgekeurd).
- Metagegevens van elementen bijwerken.
- Een elementuitvoering maken.
- Een elementuitvoering bijwerken.
- Een middelenopmerking maken.
- Een map of element kopiëren.
- Een map of element verplaatsen.
- Een map, element of uitvoering verwijderen.
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
Antwoordcodes: De responscodes zijn:
- 200 - OK - succes.
- 404 - NIET GEVONDEN - map bestaat niet of is niet toegankelijk.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
Antwoord: De klasse van de geretourneerde entiteit is een middel of een map. De eigenschappen van ingesloten entiteiten vormen een subset van de volledige reeks eigenschappen van elke entiteit. Om een volledige vertegenwoordiging van de entiteit te verkrijgen, zouden de cliënten de inhoud van URL moeten terugwinnen waarop de verbinding met rel van self.
Een map maken create-a-folder
Maakt een sling: OrderedFolder op het opgegeven pad. Indien * wordt verstrekt in plaats van een knoopnaam, gebruikt servlet de parameternaam als knooppuntnaam. In het verzoek worden de volgende twee handelingen geaccepteerd:
- Een Sirene-weergave van de nieuwe map
- Een set naam-waardeparen, gecodeerd als
application/www-form-urlencodedofmultipart/form-data. Dit is handig als u een map rechtstreeks vanuit een HTML-formulier wilt maken.
Ook kunnen eigenschappen van de map worden opgegeven als URL-queryparameters.
Een API-aanroep mislukt met een 500 antwoordcode als het bovenliggende knooppunt van het opgegeven pad niet bestaat. Een vraag keert een reactiecode terug 409 als de map bestaat.
Parameters: name is de mapnaam.
Verzoek
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"
Antwoordcodes: De responscodes zijn:
- 201 - GEMAAKT - over succesvol maken.
- 409 - CONFLICT - als de map bestaat.
- 412 - VOORWAARDE MISLUKT - als de wortelinzameling niet kan worden gevonden of worden betreden.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
Een element maken create-an-asset
Zie elementen uploaden voor informatie over hoe u een element maakt. U kunt geen middel tot stand brengen gebruikend HTTP API.
Elementbinair bijwerken update-asset-binary
Zie elementen uploaden voor informatie over het bijwerken van middelenbinaire bestanden. U kunt een element binair niet bijwerken gebruikend HTTP API.
Metagegevens van een element bijwerken update-asset-metadata
Hiermee werkt u de metagegevenseigenschappen van het element bij. Als u een eigenschap in het dialoogvenster dc: naamruimte, wordt dezelfde eigenschap in de API bijgewerkt jcr naamruimte. 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":{"dc:title":"My Asset"}}'
Antwoordcodes: De responscodes zijn:
- 200 - OK - als Asset met succes is bijgewerkt.
- 404 - NIET GEVONDEN - als Asset niet kon worden gevonden of betreden op de verstrekte URI.
- 412 - VOORWAARDE MISLUKT - als de wortelinzameling niet kan worden gevonden of worden betreden.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
Een elementuitvoering maken create-an-asset-rendition
Een uitvoering 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 de naam van de vertoning en file als bestandsverwijzing.
Verzoek
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"
Antwoordcodes
- 201 - GEMAAKT - als de vertoning is gemaakt.
- 404 - NIET GEVONDEN - als Asset niet kon worden gevonden of betreden op de verstrekte URI.
- 412 - VOORWAARDE MISLUKT - als de wortelinzameling niet kan worden gevonden of worden betreden.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
Een elementuitvoering bijwerken update-an-asset-rendition
Updates vervangen respectievelijk 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
Antwoordcodes: De responscodes zijn:
- 200 - OK - als de vertoning correct is bijgewerkt.
- 404 - NIET GEVONDEN - als Asset niet kon worden gevonden of betreden op de verstrekte URI.
- 412 - VOORWAARDE MISLUKT - als de wortelinzameling niet kan worden gevonden of worden betreden.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
Een opmerking toevoegen aan een element create-an-asset-comment
Parameters: De parameters zijn message voor de berichttekst van de opmerking en annotationData voor de Annotatiegegevens in JSON-indeling.
Verzoek: POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"
Antwoordcodes: De responscodes zijn:
- 201 - GEMAAKT - als Opmerking is gemaakt.
- 404 - NIET GEVONDEN - als Asset niet kon worden gevonden of betreden op de verstrekte URI.
- 412 - VOORWAARDE MISLUKT - als de wortelinzameling niet kan worden gevonden of worden betreden.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
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.
Aanvraagkoppen: De parameters zijn:
X-Destination- een nieuwe doel-URI binnen het bereik van de API-oplossing waarnaar de bron moet worden gekopieerd.X-Depth- hetzijinfinityof0. Gebruiken0kopieert alleen de bron en zijn eigenschappen en niet zijn kinderen.X-Overwrite- GebruikFom te voorkomen dat een actief op de bestaande bestemming wordt overschreven.
Verzoek: COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"
Antwoordcodes: De responscodes zijn:
- 201 - GEMAAKT - als de map/het element naar een niet-bestaand doel is gekopieerd.
- 204 - GEEN INHOUD - als de map of het middel naar een bestaande bestemming is gekopieerd.
- 412 - PRECONDITION MISLUKT - als een aanvraagkoptekst ontbreekt.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
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.
Aanvraagkoppen: De parameters zijn:
X-Destination- een nieuwe doel-URI binnen het bereik van de API-oplossing waarnaar de bron moet worden gekopieerd.X-Depth- hetzijinfinityof0. Gebruiken0kopieert alleen de bron en zijn eigenschappen en niet zijn kinderen.X-Overwrite- Gebruik beideTom bestaande bronnen op geforceerde wijze te verwijderen ofFom te voorkomen dat een bestaande bron wordt overschreven.
Verzoek: MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"
Antwoordcodes: De responscodes zijn:
- 201 - GEMAAKT - als de map/het element naar een niet-bestaand doel is gekopieerd.
- 204 - GEEN INHOUD - als de map of het middel naar een bestaande bestemming is gekopieerd.
- 412 - PRECONDITION MISLUKT - als een aanvraagkoptekst ontbreekt.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
Een map, element of uitvoering verwijderen delete-a-folder-asset-or-rendition
Hiermee verwijdert u een resource (-tree) bij het opgegeven pad.
Verzoek
DELETE /api/assets/myFolderDELETE /api/assets/myFolder/myAsset.pngDELETE /api/assets/myFolder/myAsset.png/renditions/original
Antwoordcodes: De responscodes zijn:
- 200 - OK - als de map is verwijderd.
- 412 - VOORWAARDE MISLUKT - als de wortelinzameling niet kan worden gevonden of worden betreden.
- 500 - INTERNE SERVERFOUT - als iets anders fout gaat.
Tips, aanbevolen procedures en beperkingen tips-limitations
-
Na de Off Time, een actief en de uitleveringen ervan niet beschikbaar zijn via de Assets en via de HTTP-API. De API geeft een foutbericht van 404 als de On Time in de toekomst is of Off Time is in het verleden.
-
De HTTP-API van middelen retourneert de volledige metagegevens niet. De naamruimten zijn gecodeerd en alleen die naamruimten worden geretourneerd. Zie het middelenpad voor volledige metagegevens
/jcr_content/metadata.json. -
Sommige eigenschappen van map of element worden toegewezen aan een ander voorvoegsel wanneer ze worden bijgewerkt met behulp van API's. De
jcrvoorvoegseljcr:title,jcr:description, enjcr:languageworden vervangen doordcvoorvoegsel Vandaar in de geretourneerde JSON,dc:titleendc:descriptionbevatten de waarden vanjcr:titleenjcr:description, respectievelijk.
Zie ook