在使用API的网页上列出表单 listing-forms-on-a-web-page-using-apis

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：

创建对象：

管理员
用户
开发人员

AEM Forms提供了一个基于REST的搜索API，Web开发人员可以使用该API来查询和检索一组符合搜索条件的表单。您可以使用API根据各种筛选器搜索表单。响应对象包含表单属性、属性和渲染表单端点。

要使用REST API搜索表单，请使用下述查询参数向https://'[server]:[port]'/libs/fd/fm/content/manage.json上的服务器发送GET请求。

查询参数 query-parameters

属性名称

描述

函数

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

例如，

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

注意： 此参数是必需的。

appPath

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

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

剪切点

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

例如， cutPoints=propertyName1|propertyName2|propertyName3

注释：

始终获取ID、路径和名称等属性。
每个资产都具有一组不同的属性。 formUrl、pdfUrl和guideUrl等属性不依赖于cutpoints属性。这些属性取决于资源类型并相应地获取。

关系

指定要与搜索结果一起获取的相关资源。您可以选择以下选项之一来获取相关资源：

NO_RELATION：不获取相关资源。
IMMEDIATE：获取与搜索结果直接相关的资源。
ALL：获取直接或间接相关的资产。

maxSize

指定要获取的最大表单数。

offset

指定从开始起跳过的表单数。

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：指定要搜索的属性的名称。
value：指定要搜索的属性的值。
operator：指定搜索时要应用的运算符。支持以下运算符：
- EQ — 等于
- NEQ — 不等于
- GT — 大于
- LT — 小于
- GTEQ — 大于或等于
- LTEQ — 小于或等于
- CONTAINS - A包含B（如果B是A的一部分）
- 全文 — 全文搜索
- STARTSTWITH — 如果B是A的开头部分，则A以B开头
- ENDSWITH — 如果B是A的结尾部分，则A以B结尾
- LIKE — 实现LIKE运算符
- AND — 合并多个语句
注意： GT、LT、GTEQ和LTEQ运算符适用于线性类型的属性，如LONG、DOUBLE和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：指定用于对搜索结果排序的属性的名称。
标准：指定结果的顺序。 order属性接受以下值：
- ASC — 使用ASC以升序排列结果。
- DES — 使用DES以降序排列结果。

includeXdp

指定是否检索二进制内容。 includeXdp属性适用于FORM、PDFFORM和PRINTFORM类型的资产。

资产类型

指定要从所有发布的资源中检索的资源类型。使用管道(|)运算符指定多个资源类型。有效的资源类型为FORM、PDF表单、PRINTFORM、RESOURCE和GUIDE。

示例请求 sample-request

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

示例响应 sample-response

[
{"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}
]

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2

在使用API的网页上列出表单 listing-forms-on-a-web-page-using-apis

查询参数 query-parameters

示例请求 sample-request

示例响应 sample-response

相关文章