AEM Forms proporciona una API de búsqueda basada en REST que los desarrolladores web pueden utilizar para realizar consultas y recuperar un conjunto de formularios que cumplen los criterios de búsqueda. Las API se pueden utilizar para buscar formularios basados en diversos filtros. El objeto response contiene atributos de formulario, propiedades y puntos finales de procesamiento de los formularios.
Para buscar formularios con la API de REST, envíe una solicitud de GET al servidor en https://'[server]:[port]'/libs/fd/fm/content/manage.json
con los parámetros de consulta que se describen a continuación.
Nombre del atributo |
Descripción |
func |
Especifica la función que se va a llamar. Para buscar formularios, establezca el valor del atributo Por ejemplo, Nota: Este parámetro es obligatorio. |
appPath |
Especifica la ruta de la aplicación para buscar formularios. De forma predeterminada, el atributo appPath busca en todas las aplicaciones disponibles en el nivel de nodo raíz. Puede especificar varias rutas de aplicación en una sola consulta de búsqueda. Separe las distintas rutas con el carácter de barra vertical (|). |
cutPoints |
Especifica las propiedades que se van a recuperar con los recursos. Puede utilizar el asterisco (*) para recuperar todas las propiedades a la vez. Utilice el operador de barra vertical (|) para especificar varias propiedades. Por ejemplo, Nota:
|
relation |
Especifica los recursos relacionados que se van a recuperar junto con los resultados de la búsqueda. Puede elegir una de las siguientes opciones para recuperar recursos relacionados:
|
maxSize | Especifica el número máximo de formularios que se van a recuperar. |
desplazamiento | Especifica el número de formularios que se omitirán en el inicio. |
returnCount | Especifica si se devuelven o no los resultados de búsqueda que coinciden con los criterios dados. |
sentencias | Especifica la lista de las sentencias. Las consultas se ejecutan en la lista de las instrucciones especificadas en el formato JSON. Por ejemplo,
En el ejemplo anterior,
|
pedidos |
Especifica los criterios de pedido para los resultados de búsqueda. Los criterios se definen en el formato JSON. Puede ordenar los resultados de búsqueda en más de un campo. Los resultados se ordenan en el orden en que aparecen los campos en la consulta. Por ejemplo, Para recuperar los resultados de consulta ordenados por propiedad title en orden ascendente, agregue el siguiente parámetro:
|
includeXdp | Especifica si se recupera el contenido binario o no. El atributo includeXdp se aplica a los recursos de tipo FORM , PDFFORM y PRINTFORM . |
assetType | Especifica los tipos de recursos que se van a recuperar de todos los recursos publicados. Utilice el operador de barra vertical (|) para especificar varios tipos de recursos. Los tipos de recursos válidos son FORM, PDFFORM, PRINTFORM, RESOURCE y 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}
]