Adobe Experience Manager Assets HTTP API assets-http-api
概述 overview
Assets HTTP API允许对数字资源执行创建 — 读取 — 更新 — 删除(CRUD)操作，包括对元数据、演绎版和评论的操作，以及使用Experience Manager内容片段的结构化内容。 它在/api/assets中公开，并作为REST API实现。 它包括对内容片段🔗的支持。
要访问API，请执行以下操作：
- 在
https://[hostname]:[port]/api.json处打开API服务文档。 - 关注指向
https://[hostname]:[server]/api/assets.json的Assets服务链接。
API响应是适用于某些MIME类型的JSON文件，是适用于所有MIME类型的响应代码。 JSON响应是可选的，可能无法用于（例如）PDF文件。 依靠响应代码进行进一步分析或执行操作。
内容片段 content-fragments
内容片段是一种特殊类型的资产。 它可用于访问结构化数据，如文本、数字、日期等。 由于standard资产（如图像或文档）存在若干差异，因此处理内容片段时适用一些其他规则。
有关详细信息，请参阅 Experience Manager Assets HTTP API🔗中的内容片段支持。
数据模型 data-model
Assets HTTP API公开两个主要元素：文件夹和资源（用于标准资源）。 此外，它还会为描述内容片段中结构化内容的自定义数据模型显示更详细的元素。 有关详细信息，请参阅内容片段数据模型。
文件夹 folders
文件夹与传统文件系统中的目录类似。 文件夹可以只包含资源，也可以只包含文件夹或文件夹和资源。 文件夹具有以下组件：
实体：文件夹的实体是其子元素，可以是文件夹和资源。
属性：
name是文件夹的名称。 这与URL路径中没有扩展的最后一个区段相同。title是文件夹的可选标题，可以显示它而不是其名称。
jcr:title、jcr:description和jcr:language的jcr前缀已替换为dc前缀。 因此，在返回的JSON中，dc:title和dc:description分别包含jcr:title和jcr:description的值。链接 文件夹显示三个链接：
self：链接到自身。parent：链接到父文件夹。thumbnail：（可选）链接到文件夹缩略图图像。
资源 assets
在Experience Manager中，资产包含以下元素：
- 资源的属性和元数据。
- 最初上传的资产的二进制文件。
- 已配置多个演绎版。 这些可以是不同大小的图像、不同编码的视频，或者从PDF或Adobe InDesign文件中提取的页面。
- 可选注释。
有关内容片段中元素的信息，请参阅Experience Manager Assets HTTP API中的内容片段支持。
在Experience Manager中，文件夹具有以下组件：
- 实体：资产的子项是其演绎版。
- 属性。
- 链接。
可用功能 available-features
Assets HTTP API包含以下功能：
检索文件夹列表 retrieve-a-folder-listing
检索现有文件夹及其子实体（子文件夹或资产）的Siren表示形式。
请求： GET /api/assets/myFolder.json
响应代码：响应代码为：
- 200 — 确定 — 成功。
- 404 - NOT FOUND — 文件夹不存在或无法访问。
- 500 — 内部服务器错误 — 如果出现其他错误。
响应：返回的实体的类是资产或文件夹。 包含的实体的属性是每个实体的完整属性集的子集。 要获取实体的完整表示形式，客户端应检索链接指向的URL的内容，该URL具有self的rel。
创建文件夹 create-a-folder
在给定路径创建一个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 — 内部服务器错误 — 如果出现其他错误。
创建资产 create-an-asset
有关如何创建资产的信息，请参阅资产上传。 无法使用HTTP API创建资源。
更新资产二进制文件 update-asset-binary
有关如何更新资产二进制文件的信息，请参阅资产上传。 无法使用HTTP API更新资产二进制文件。
更新资源的元数据 update-asset-metadata
更新资源元数据属性。 如果更新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 — 内部服务器错误 — 如果出现其他错误。
创建资源演绎版 create-an-asset-rendition
为资源创建演绎版。 如果未提供请求参数名称，则使用文件名作为演绎版名称。
参数：格式副本的名称为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 — 内部服务器错误 — 如果出现其他错误。
更新资源演绎版 update-an-asset-rendition
更新会分别用新的二进制数据替换资产演绎版。
请求： 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 — 内部服务器错误 — 如果出现其他错误。
在资产上添加评论 create-an-asset-comment
参数：评论的消息正文的参数为message，JSON格式的注释数据的参数为annotationData。
请求： POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"
响应代码：响应代码为：
- 201 - CREATED — 如果评论已成功创建。
- 404 - NOT FOUND — 如果在提供的URI中找不到或无法访问资产。
- 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
- 500 — 内部服务器错误 — 如果出现其他错误。
复制文件夹或资源 copy-a-folder-or-asset
将提供的路径中可用的文件夹或资产复制到新目标。
请求标头：参数为：
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 — 内部服务器错误 — 如果出现其他错误。
移动文件夹或资源 move-a-folder-or-asset
将给定路径下的文件夹或资源移动到新目标。
请求标头：参数为：
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 — 内部服务器错误 — 如果出现其他错误。
删除文件夹、资源或演绎版 delete-a-folder-asset-or-rendition
在提供的路径中删除资源(-tree)。
请求
DELETE /api/assets/myFolderDELETE /api/assets/myFolder/myAsset.pngDELETE /api/assets/myFolder/myAsset.png/renditions/original
响应代码：响应代码为：
- 200 - OK — 已成功删除文件夹。
- 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
- 500 — 内部服务器错误 — 如果出现其他错误。
提示、最佳实践和限制 tips-limitations
-
在结束时间后，无法通过Assets Web界面和HTTP API使用资产及其演绎版。 如果开启时间是未来的时间，或者结束时间是过去的时间，则API会返回404错误消息。
-
Assets HTTP API不返回完整的元数据。 命名空间是硬编码的，并且只返回这些命名空间。 有关完整的元数据，请参阅资源路径
/jcr_content/metadata.json。 -
使用API更新时，文件夹或资产的某些属性会映射到不同的前缀。
jcr:title、jcr:description和jcr:language的jcr前缀已替换为dc前缀。 因此，在返回的JSON中，dc:title和dc:description分别包含jcr:title和jcr:description的值。
另请参阅