API HTTP Assets assets-http-api

Información general overview

La API HTTP Assets permite realizar operaciones de creación, lectura, actualización y eliminación (CRUD) en recursos digitales, incluidos metadatos, representaciones y comentarios, así como contenido estructurado mediante Experience Manager fragmentos de contenido. Se expone en /api/assets y se implementa como API de REST. Incluye compatibilidad con fragmentos de contenido.

Para acceder a la API:

La respuesta de la API es un archivo JSON para algunos tipos de MIME y un código de respuesta para todos los tipos de MIME. La respuesta JSON es opcional y es posible que no esté disponible, por ejemplo, para archivos de PDF. Confíe en el código de respuesta para realizar más análisis o acciones.

Transcurrido el tiempo de inactividad, un recurso y sus representaciones no estarán disponibles a través de la interfaz web Assets ni a través de la API HTTP. La API devuelve el mensaje de error 404 si el Tiempo de activación es futuro o el Tiempo de inactividad es anterior.

Fragmentos de contenido content-fragments

Un fragmento de contenido es un tipo especial de recurso. Se puede utilizar para acceder a datos estructurados, como textos, números, fechas, entre otros. Dado que existen varias diferencias entre los recursos de standard (como imágenes o documentos), algunas reglas adicionales se aplican al manejo de fragmentos de contenido.

Para obtener más información, consulte Compatibilidad con fragmentos de contenido en la API HTTP de Experience Manager Assets.

Modelo de datos data-model

La API HTTP Assets expone dos elementos, carpetas y recursos principales (para recursos estándar).

Además, expone elementos más detallados para los modelos de datos personalizados que describen el contenido estructurado en Fragmentos de contenido. Consulte Modelos de datos de fragmento de contenido para obtener más información.

Carpetas folders

Las carpetas son como los directorios de los sistemas de archivos tradicionales. Son contenedores para otras carpetas o aserciones. Las carpetas tienen los siguientes componentes:

Entidades: las entidades de una carpeta son sus elementos secundarios, que pueden ser carpetas y recursos.

Propiedades:

Vínculos Las carpetas muestran tres vínculos:

Recursos assets

En Experience Manager, un recurso contiene los siguientes elementos:

Para obtener información sobre los elementos de los fragmentos de contenido, consulte Compatibilidad con fragmentos de contenido en la API HTTP de Experience Manager Assets.

En Experience Manager, una carpeta tiene los siguientes componentes:

La API HTTP Assets incluye las siguientes características:

Requisitos previos

Recuperar una lista de carpetas retrieve-a-folder-listing

Recupera una representación de sirena de una carpeta existente y de sus entidades secundarias (subcarpetas o recursos).

Solicitud: GET /api/assets/myFolder.json

Códigos de respuesta: Los códigos de respuesta son:

Respuesta: La clase de la entidad devuelta es un recurso o una carpeta. Las propiedades de las entidades contenidas son un subconjunto del conjunto completo de propiedades de cada entidad. Para obtener una representación completa de la entidad, los clientes deben recuperar el contenido de la dirección URL a la que apunta el vínculo con un rel de self.

Crear una carpeta. create-a-folder

Crea un nuevo(a) sling: OrderedFolder en la ruta dada. Si se proporciona * en lugar del nombre de un nodo, el servlet utiliza el nombre del parámetro como nombre de nodo. Se acepta como datos de solicitud una representación de sirena de la nueva carpeta o un conjunto de pares nombre-valor, codificados como application/www-form-urlencoded o multipart/ form- data, que son útiles para crear una carpeta directamente desde un formulario de HTML. Además, las propiedades de la carpeta se pueden especificar como parámetros de consulta de URL.

Una llamada de API produce un error con un código de respuesta 500 si el nodo principal de la ruta de acceso proporcionada no existe. Una llamada devuelve un código de respuesta 409 si la carpeta ya existe.

Parámetros: name es el nombre de la carpeta.

Petición

Códigos de respuesta: Los códigos de respuesta son:

Crear un recurso create-an-asset

Coloque el archivo proporcionado en la ruta proporcionada para crear un recurso en el repositorio de DAM. Si se proporciona * en lugar de un nombre de nodo, el servlet utiliza el nombre de parámetro o el nombre de archivo como nombre de nodo.

Parámetros: los parámetros son name para el nombre del recurso y file para la referencia de archivo.

Petición

Códigos de respuesta: Los códigos de respuesta son:

Actualizar un binario de recursos update-asset-binary

Actualiza el archivo binario de un recurso (representación con el nombre original). Una actualización déclencheur el flujo de trabajo de procesamiento de recursos predeterminado que se ejecutará, si está configurado.

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

Códigos de respuesta: Los códigos de respuesta son:

Actualizar metadatos del recurso update-asset-metadata

Actualiza las propiedades de los metadatos del recurso. Si actualiza cualquier propiedad en el espacio de nombres dc:, la API actualiza la misma propiedad en el espacio de nombres jcr. La API no sincroniza las propiedades en las dos áreas de nombres.

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

Códigos de respuesta: Los códigos de respuesta son:

Sincronizar actualización de metadatos entre el espacio de nombres dc y jcr sync-metadata-between-namespaces

El método API actualiza las propiedades de metadatos en el espacio de nombres jcr. Las actualizaciones realizadas mediante la interfaz de usuario cambian las propiedades de metadatos del espacio de nombres dc. Para sincronizar los valores de metadatos entre el espacio de nombres dc y jcr, puede crear un flujo de trabajo y configurar el Experience Manager para que ejecute el flujo de trabajo tras la edición del recurso. Utilice un script ECMA para sincronizar las propiedades de metadatos requeridas. El siguiente script de ejemplo sincroniza la cadena de título entre dc:title y 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();
}
}

Crear una representación de recursos create-an-asset-rendition

Crear una representación de recursos para un recurso. Si no se proporciona el nombre del parámetro de solicitud, se utilizará el nombre de archivo como nombre de representación.

Parámetros: los parámetros son name para el nombre de la representación y file como referencia de archivo.

Petición

Códigos de respuesta: Los códigos de respuesta son:

Actualizar una representación de recursos update-an-asset-rendition

Las actualizaciones reemplazan respectivamente una representación de recursos con los nuevos datos binarios.

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

Códigos de respuesta: Los códigos de respuesta son:

Agregar un comentario en un recurso create-an-asset-comment

Crea un nuevo comentario de recurso.

Parámetros: los parámetros son message para el cuerpo del mensaje del comentario y annotationData para los datos de anotación en formato JSON.

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

Códigos de respuesta: Los códigos de respuesta son:

Copiar una carpeta o un recurso copy-a-folder-or-asset

Copia una carpeta o un recurso disponible en la ruta proporcionada a un nuevo destino.

Encabezados de solicitud: Los parámetros son:

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

Códigos de respuesta: Los códigos de respuesta son:

Mover una carpeta o un recurso move-a-folder-or-asset

Mueve una carpeta o un recurso en la ruta determinada a un nuevo destino.

Encabezados de solicitud: Los parámetros son:

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

No use /content/dam en la dirección URL. Un comando de ejemplo para mover recursos y sobrescribir los existentes es el siguiente:

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"

Códigos de respuesta: Los códigos de respuesta son:

Eliminar una carpeta, un recurso o una representación delete-a-folder-asset-or-rendition

Elimina un recurso (-tree) en la ruta proporcionada.

Petición

Códigos de respuesta: Los códigos de respuesta son:

Sugerencias y limitaciones tips-best-practices-limitations