AEM Forms提供了一个基于REST的搜索API,Web开发人员可以使用该API查询和检索一组符合搜索条件的表单。 您可以使用API根据各种过滤器搜索表单。 响应对象包含表单属性、属性和表单的渲染端点。
要使用REST API搜索表单,请使用下面描述的查询参数,向位于https://'[server]:[port]'/libs/fd/fm/content/manage.json
的服务器发送GET请求。
属性名称 |
描述 |
func |
指定要调用的函数。 要搜索表单,请将 例如, 注意: 此参数是必选项。 |
appPath |
指定用于搜索表单的应用程序路径。 默认情况下,appPath属性会搜索根节点级别上所有可用的应用程序。 您可以在单个搜索查询中指定多个应用程序路径。 使用管道字符(|)分隔多个路径。 |
cutPoints |
指定要与资产一起获取的属性。 您可以使用星号(*)一次获取所有属性。 使用管道(|)运算符指定多个属性。 例如, 注意:
|
relation |
指定要获取的相关资产以及搜索结果。 您可以选择以下选项之一来获取相关资产:
|
maxSize | 指定要获取的最大表单数。 |
偏移 | 指定要从开始跳过的表单数。 |
returnCount | 指定是否返回与给定条件匹配的搜索结果。 |
语句 | 指定语句列表。 查询在JSON格式指定的语句列表中执行。 例如,
在上述示例中,
|
排序 |
指定搜索结果的顺序条件。 标准以JSON格式定义。 您可以对多个字段的搜索结果进行排序。 在查询中显示字段时,结果会按相应顺序排序。 例如, 要以升序方式检索按标题属性排序的查询结果,请添加以下参数:
|
includeXdp | 指定是否检索二进制内容。 includeXdp 属性适用于FORM 、PDFFORM 和PRINTFORM 类型的资产。 |
assetType | 指定要从所有已发布资产中检索的资产类型。 使用管道(|)运算符指定多个资产类型。 有效的资产类型包括表单、PDFFORM、打印表单、资源和指南。 |
func : searchForms
appPath : /content/dam/formsanddocuments/MyApplication23
cutPoints : title|description|author|status|creationDate|lastModifiedDate|activationDate|expiryDate|tags|allowedRenderFormat|formmodel
relation : NO_RELATION
includeXdp : false
maxSize : 10
offset : 0
returnCount : true
statements: [{"name":"name","value":"*Claim.xdp","operator":"CONTAINS"},
{"name":"","value":"Expense","operator":"FULLTEXT"},
{"name":"description","value":"ABCD*","operator":"CONTAINS"},
{"name":"status","value":"false","operator":"EQ"},
{"name":"lastModifiedDate","value":"01/09/2013","operator":"GTEQ"},
{"name":"lastModifiedDate","value":"01/18/2013","operator":"LTEQ"}]
orderings:[{"name" :“lastModifiedDate“:”order”:”ASC”}]
[
{"resultCount":2},
{"assetType":"FORM","name":"ExpenseClaim.xdp","id":"509fa2d5-e3c9-407b-b8dc-fa0ba08eb0ce",
"path":"/content/dam/formsanddocuments/MyApplication23/1.0/ExpenseClaim.xdp",
"title":"Expense Report","description":"ABCDEFGIJK","author":"Frank Bowman",
"tags":[],"formUrl":"/content/dam/formsanddocuments/MyApplication23/1.0/ExpenseClaim.xdp/jcr:content",
"pdfUrl":"/content/dam/formsanddocuments/MyApplication23/1.0/ExpenseClaim.xdp/jcr:content?type=pdf",
"references":[],"images":[{"assetType":"resource","name":"Image.gif","id":"5477a127-8bbf-4cec-8f81-2689e5cb4a15",
"path":"/content/dam/formsanddocuments/MyApplication23/1.0/Image.gif","resourceSize":0}],
"status":false,"creationDate":1358429845623,"lastModifiedDate":1358429846771},
{"assetType":"FORM","name":"ExpenseClaim.xdp","id":"4312239b-b666-4d36-95bc-641b3a39ddd4",
"path":"/content/dam/formsanddocuments/MyApplication23/ExpenseClaim.xdp",
"title":"Expense Report","description":"ABCDefghijklm","author":"Frank Bowman",
"tags":[],"formUrl":"/content/dam/formsanddocuments/MyApplication23/ExpenseClaim.xdp/jcr:content",
"pdfUrl":"/content/dam/formsanddocuments/MyApplication23/ExpenseClaim.xdp/jcr:content?type=pdf",
"references":[],"images":[{"assetType":"resource","name":"Image.gif","id":"118a2e3f-7097-4d8c-85d1-651306de284a",
"path":"/content/dam/formsanddocuments/MyApplication23/Image.gif","resourceSize":0}],"status":false,
"creationDate":1358429856690,"lastModifiedDate":1358430109023}
]