使用API在网页上列出表单

AEM Forms提供基于REST的搜索API,Web开发人员可使用它查询和检索一组符合搜索条件的表单。 您可以使用API根据各种过滤器搜索表单。 响应对象包含表单属性、属性和呈现表单的端点。

要使用REST API搜索表单,请向位于https://[server]:[port]/libs/fd/fm/content/manage.json的服务器发送GET请求,其中包含如下所述的查询参数。

查询参数

属性名称
描述
func

指定要调用的函数。 要搜索表单,请将func 属性的值设置为searchForms

例如, URLParameterBuilder entityBuilder=new URLParameterBuilder (); entityBuilder.add("func", "searchForms");

注意: 此参数为必填参数。

appPath

指定用于搜索表单的应用程序路径。 默认情况下,appPath属性会搜索根节点级别上所有可用的应用程序。

您可以在一个搜索查询中指定多个应用程序路径。 用管道(|)字符分隔多条路径。

cutPoints

指定要用资产提取的属性。 可以使用星号(*)一次获取所有属性。 使用管道(|)运算符指定多个属性。

例如, cutPoints=propertyName1|propertyName2|propertyName3

注意:

  • 始终获取id、路径和名称等属性。
  • 每个资产都有一组不同的属性。 formUrl、pdfUrl和guideUrl等属性不取决于刀具点属性。 这些属性取决于资产类型,并会相应地获取。
relation
指定要与搜索结果一起提取的相关资产。 您可以选择以下选项之一来提取相关资产:
  • NO_RELATION:请勿提取相关资产。
  • 立即:获取与搜索结果直接相关的资产。
  • 全部:直接及间接相关资产。
maxSize 指定要获取的最大表单数。
偏移 指定要从开始跳过的表单数。
returnCount 指定是否返回与给定条件匹配的搜索结果。
语句

指定语句的列表。 查询在列表JSON格式中指定的语句时执行。

例如,

JSONArray statementArray=new JSONArray(); JSONObject statement=new JSONObject(); statement.put("name", "title"); statement.put("value", "SimpleSurveyAF"); statement.put("operator", "EQ"); statementArray.put(statement);

在上例中,

  • name:指定要搜索的属性的名称。
  • :指定要搜索的属性的值。
  • 运算符:指定搜索时要应用的运算符。支持以下运算符:
    • EQ —— 等于
    • NEQ —— 不等于
    • GT —— 大于
    • LT —— 小于
    • GTEQ —— 大于或等于
    • LTEQ —— 小于或等于
    • CONTAINS —— 如果B是A的一部分,则A包含B
    • 全文——全文搜索
    • STARTSWITH —— 如果B是A的开头部分,则为B的开始
    • ENDSWITH —— 如果B是A的结束部分,则A以B结尾
    • LIKE —— 实现LIKE运算符
    • AND —— 合并多个语句

    注意: GT、LT、GTEQ和LTEQ运算符适用于线性类型的属性,如LONG、多次和DATE。

排序

指定搜索结果的顺序条件。 标准以JSON格式定义。 可以对多个字段上的搜索结果进行排序。 结果按字段在查询中显示的顺序排序。

例如,

要检索按标题属性按升序排序的查询结果,请添加以下参数:

JSONArray orderingsArray=new JSONArray(); JSONObject orderings=new JSONObject(); orderings.put("name", "title"); orderings.put("criteria", "ASC"); orderingsArray.put(orderings); entityBuilder.add("orderings", orderingsArray.toString());

  • name:指定用于对搜索结果排序的属性的名称。
  • 条件:指定结果的顺序。顺序属性接受以下值:
    • ASC —— 使用ASC按升序排列结果。
    • DES —— 使用DES以降序排列结果。
includeXdp 指定是否检索二进制内容。 includeXdp属性适用于FORMPDFFORMPRINTFORM类型的资产。
资产类型 指定要从所有已发布资产中检索的资产类型。 使用管道(|)运算符指定多个资产类型。 有效的资产类型包括FORM、PDFFORM、PRINTFORM、RESOURCE和GUIDE。

示例请求

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}
]

相关文章

在此页面上