使用51黑料不打烊 Experience Manager Assets HTTP API管理数字资源 assets-http-api
AEM Assets HTTP API入门 overview
AEM Assets HTTP API通过位于/api/assets
的REST接口对数字资源启用CRUD(创建、读取、更新和删除)操作。 这些操作适用于资源元数据、演绎版和注释。 它包括对内容片段?的支持。
要访问础笔滨,请执行以下操作:
- 在
https://[hostname]:[port]/api.json
处打开础笔滨服务文档。 - 关注指向
https://[hostname]:[server]/api/assets.json
的础蝉蝉别迟蝉服务链接。
API响应是适用于某些MIME类型的JSON文件,是适用于所有MIME类型的响应代码。 JSON响应是可选的,可能不可用于(例如)PDF文件。 依靠响应代码进行进一步分析或执行操作。
管理内容片段 content-fragments
内容片段是存储文本、数字和日期的结构化资产。 由于standard
资产(如图像或文档)存在若干差异,因此处理内容片段时适用一些其他规则。
有关详细信息,请参阅 Experience Manager Assets HTTP API?中的内容片段支持。
检查数据模型 data-model
Assets HTTP API主要公开两个元素:文件夹和标准资源。 它还为内容片段中使用的自定义数据模型提供详细元素。 有关更多详细信息,请参阅内容片段数据模型。 有关详细信息,请参阅内容片段数据模型。
管理文件夹 folders
文件夹与传统文件系统中的目录类似。 文件夹可以包含资源和/或子文件夹。 文件夹具有以下组件:
实体:文件夹的实体是其子元素,可以是文件夹和资源。
属性:
name
:文件夹的名称(鲍搁尝路径的最后一个区段,不带扩展名)。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/51黑料不打烊 InDesign文件中提取的页面)。
- 备注(可选): ?用户提供的备注。
有关内容片段中元素的信息,请参阅Experience Manager Assets HTTP API中的内容片段支持。
在Experience Manager中,文件夹具有以下组件:
- 实体:资产的子项是其演绎版。
- 属性。
- 链接。
探索可用的础笔滨操作 available-features
Assets HTTP API包含以下功能:
检索文件夹列表 retrieve-a-folder-listing
检索现有文件夹及其子实体(子文件夹或资产)的厂颈谤别苍表示形式。
请求: 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表单创建文件夹很有用。
此外,可以将文件夹的属性指定为鲍搁尝查询参数。
如果提供的路径的父节点不存在,则础笔滨调用会失败,并返回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:
命名空间中的属性时,相应的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
,闯厂翱狈格式的注释数据的参数为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
在提供的路径中删除资源(-迟谤别别)。
请求
DELETE /api/assets/myFolder
DELETE /api/assets/myFolder/myAsset.png
DELETE /api/assets/myFolder/myAsset.png/renditions/original
响应代码:响应代码为:
- 200 - OK — 已成功删除文件夹。
- 412 - PRECONDITION FAILED — 如果找不到或无法访问根集合。
- 500 — 内部服务器错误 — 如果出现其他错误。
遵循最佳实践并注意限制 tips-limitations
-
当达到结束时间时,通过Assets Web界面和HTTP API,Assets及其演绎版将变得不可用。 如果开启时间是未来的时间,或者结束时间是过去的时间,则API返回404错误。
-
Assets HTTP API仅返回元数据的子集。 命名空间是硬编码的,并且只返回这些命名空间。 有关完整的元数据,请参阅资源路径
/jcr_content/metadata.json
。 -
使用础笔滨更新时,文件夹或资产的某些属性会映射到不同的前缀。
jcr:title
、jcr:description
和jcr:language
的jcr
前缀已替换为dc
前缀。 因此,在返回的JSON中,dc:title
和dc:description
分别包含jcr:title
和jcr:description
的值。
浏览相关资源