Adobe Experience Manager Assets HTTP API

版本 文章链接
AEM 6.5 单击此处
AEM as a Cloud Service 本文

概述

此 Assets HTTP API允许对数字资产执行创建 — 读取 — 更新 — 删除(CRUD)操作，包括对元数据、演绎版和评论执行操作，同时允许使用结构化内容 Experience Manager 内容片段。 它公开于 /api/assets 并作为REST API实施。 它包括 支持内容片段.

要访问API，请执行以下操作：

  1. 打开API服务文档，网址为 https://[hostname]:[port]/api.json.
  2. 请遵循 Assets 服务链接指向 https://[hostname]:[server]/api/assets.json.

API响应是适用于某些MIME类型的JSON文件，是适用于所有MIME类型的响应代码。 JSON响应是可选的，并且可能不可用，例如PDF文件。 依靠响应代码进行进一步分析或执行操作。

注意

弃用与上传或更新资产或二进制文件（如演绎版）相关的所有API调用 Experience Manager as a Cloud Service 部署。 要上传二进制文件，请使用 直接二进制上传API 而是。

内容片段

A 内容片段 是一种特殊类型的资产。 它可用于访问结构化数据，如文本、数字、日期等。 由于与以下内容存在若干差异： standard 资产（如图像或文档）中，一些其他规则适用于处理内容片段。

有关详细信息，请参阅 中的内容片段支持 Experience Manager Assets HTTP API.

数据模型

此 Assets HTTP API公开两个主要元素：文件夹和资源（对于标准资源）。 此外，它还会为描述内容片段中结构化内容的自定义数据模型显示更详细的元素。 参见 内容片段数据模型 以进一步了解。

文件夹

文件夹与传统文件系统中的目录类似。 文件夹可以只包含资源，也可以只包含文件夹或文件夹和资源。 文件夹具有以下组件：

实体：文件夹的实体是它的子元素，可以是文件夹和资源。

属性:

  • name 是文件夹的名称。 这与URL路径中没有扩展名的最后一个区段相同。
  • title 是文件夹的可选标题，可以显示它而不是其名称。
注意

文件夹或资产的某些属性映射到不同的前缀。 此 jcr 前缀 jcr:title， jcr:description、和 jcr:language 替换为 dc 前缀。 因此，在返回的JSON中， dc:title 和 dc:description 包含值 jcr:title 和 jcr:description，则不会显示任何内容。

链接 文件夹显示三个链接：

  • self：链接到自身。
  • parent：链接到父文件夹。
  • thumbnail：（可选）链接到文件夹缩略图图像。

Assets

In Experience Manager 资源包含以下元素：

  • 资源的属性和元数据。
  • 最初上载了资产的二进制文件。
  • 配置多个演绎版。 这些页面可以是不同大小的图像、不同编码的视频，也可以是从PDF中提取的页面，或者 Adobe InDesign 文件。
  • 可选注释。

有关内容片段中元素的信息，请参阅 Experience Manager Assets HTTP API中的内容片段支持.

In Experience Manager 文件夹具有以下组件：

  • 实体：资产的子项是其演绎版。
  • 属性.
  • 链接.

可用功能

此 Assets HTTP API包含以下功能：

注意

为了便于阅读，以下示例省略了完整的cURL符号。 表示法与 Resty 是cURL的脚本包装器。

检索文件夹列表

检索现有文件夹及其子实体（子文件夹或资产）的Siren表示形式。

请求： GET /api/assets/myFolder.json

响应代码：响应代码为：

  • 200 — 确定 — 成功。
  • 404 — 未找到 — 文件夹不存在或无法访问。
  • 500 — 内部服务器错误 — 如果出现其他错误。

响应：返回的实体的类是资源或文件夹。 所包含实体的属性是每个实体的完整属性集的子集。 为了获得实体的完整表示形式，客户端应检索由具有的链接的链接指向的URL的内容 rel 之 self.

创建文件夹

创建 sling： OrderedFolder 在给定路径上。 如果 * 提供的不是节点名称，而是参数名称，此servlet使用参数名称作为节点名称。 请求接受以下任一情况：

  • 新文件夹的警报表示形式
  • 一组名称 — 值对，编码为 application/www-form-urlencoded 或 multipart/ form- data. 这些选项对于直接从HTML表单创建文件夹很有用。

此外，可以将文件夹的属性指定为URL查询参数。

API调用失败，原因是 500 响应代码（如果提供的路径的父节点不存在）。 调用返回响应代码 409 如果文件夹存在，则为。

参数： name 是文件夹名称。

请求

  • 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"

响应代码：响应代码为：

  • 201 — 已创建 — 成功创建时。
  • 409 — 冲突 — 如果文件夹存在。
  • 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
  • 500 — 内部服务器错误 — 如果出现其他错误。

创建资产

参见 资产上传 有关如何创建资产的信息。 无法使用HTTP API创建资源。

更新资产二进制文件

参见 资产上传 有关如何更新资产二进制文件的信息。 无法使用HTTP API更新资产二进制文件。

更新资源的元数据

更新资源元数据属性。 如果更新 dc: 命名空间中，API会更新 jcr 命名空间。 API不会同步两个命名空间下的属性。

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

响应代码：响应代码为：

  • 200 — 确定 — 如果已成功更新资产。
  • 404 - NOT FOUND — 如果在提供的URI中找不到或无法访问资产。
  • 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
  • 500 — 内部服务器错误 — 如果出现其他错误。

创建资源演绎版

为资源创建演绎版。 如果未提供请求参数名称，则使用文件名作为演绎版名称。

参数：参数为 name 格式副本的名称和 file 作为文件引用。

请求

  • 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"

响应代码

  • 201 - CREATED — 如果已成功创建演绎版。
  • 404 - NOT FOUND — 如果在提供的URI中找不到或无法访问资产。
  • 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
  • 500 — 内部服务器错误 — 如果出现其他错误。

更新资源演绎版

更新会分别用新的二进制数据替换资产演绎版。

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

响应代码：响应代码为：

  • 200 - OK — 如果已成功更新演绎版。
  • 404 - NOT FOUND — 如果在提供的URI中找不到或无法访问资产。
  • 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
  • 500 — 内部服务器错误 — 如果出现其他错误。

在资源上添加评论

参数：参数为 message 注释和的消息正文 annotationData JSON格式的注释数据。

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

响应代码：响应代码为：

  • 201 - CREATED — 如果评论已成功创建。
  • 404 - NOT FOUND — 如果在提供的URI中找不到或无法访问资产。
  • 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
  • 500 — 内部服务器错误 — 如果出现其他错误。

复制文件夹或资源

将提供的路径中可用的文件夹或资产复制到新目标。

请求标头：参数包括：

  • X-Destination - API解决方案范围内的新目标URI，用于将资源复制到。
  • X-Depth — 任一 infinity 或 0. 使用 0 仅复制资源及其属性，而不复制其子项。
  • X-Overwrite — 使用 F 以防止覆盖现有目标上的资产。

请求： COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"

响应代码：响应代码为：

  • 201 - CREATED — 文件夹/资产是否已复制到非现有目标。
  • 204 — 无内容 — 如果将文件夹/资产复制到现有目标。
  • 412 - PRECONDITION失败 — 如果缺少请求标头。
  • 500 — 内部服务器错误 — 如果出现其他错误。

移动文件夹或资源

将给定路径下的文件夹或资源移动到新目标。

请求标头：参数包括：

  • X-Destination - API解决方案范围内的新目标URI，用于将资源复制到。
  • X-Depth — 任一 infinity 或 0. 使用 0 仅复制资源及其属性，而不复制其子项。
  • X-Overwrite — 使用 T 强制删除现有资源或 F 以防止覆盖现有资源。

请求： MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"

响应代码：响应代码为：

  • 201 - CREATED — 文件夹/资产是否已复制到非现有目标。
  • 204 — 无内容 — 如果将文件夹/资产复制到现有目标。
  • 412 - PRECONDITION失败 — 如果缺少请求标头。
  • 500 — 内部服务器错误 — 如果出现其他错误。

删除文件夹、资源或演绎版

在提供的路径上删除资源(-tree)。

请求

  • DELETE /api/assets/myFolder
  • DELETE /api/assets/myFolder/myAsset.png
  • DELETE /api/assets/myFolder/myAsset.png/renditions/original

响应代码：响应代码为：

  • 200 — 确定 — 如果已成功删除文件夹。
  • 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
  • 500 — 内部服务器错误 — 如果出现其他错误。

提示、最佳实践和限制

  • 在 关闭时间，资源及其演绎版无法通过 Assets Web界面和通过HTTP API。 如果 准时 是未来或 关闭时间 是过去的。

  • 资源HTTP API未返回完整的元数据。 命名空间是硬编码的，并且只返回这些命名空间。 有关完整的元数据，请参阅资源路径 /jcr_content/metadata.json.

  • 使用API更新时，文件夹或资产的某些属性会映射到不同的前缀。 此 jcr 前缀 jcr:title， jcr:description、和 jcr:language 替换为 dc 前缀。 因此，在返回的JSON中， dc:title 和 dc:description 包含值 jcr:title 和 jcr:description，则不会显示任何内容。

另请参阅

相关文章

在此页面上