API para trabajar con formularios enviados en el portal de formularios

AEM Forms proporciona una API que puede utilizar para consultar los datos de formularios enviados a través del portal de formularios. Además, puede publicar comentarios o actualizar las propiedades de los formularios enviados mediante las API explicadas en este documento.

NOTA

Los usuarios que invoquen las API deben agregarse al grupo de revisores tal como se describe en Asociar revisores de envío a un formulario.

GET /content/forms/portal/submission.review.json?func=getFormsForSubmissionReview

Devuelve una lista de todos los formularios aptos.

Parámetros de URL

Esta API no requiere parámetros adicionales.

Respuesta

El objeto response contiene una matriz JSON que incluye nombres de formularios y su ruta de acceso al repositorio. La estructura de la respuesta es la siguiente:

[
 {formName: "<form name>",
 formPath: "<path to the form>" },
 {.....},
 ......]

Ejemplo

URL de solicitud

https://[host]:[port]/content/forms/portal/submission.review.json?func=getFormsForSubmissionReview

Respuesta

[{"formPath":"/content/dam/formsanddocuments/forms-review/form2","formName":"form2"},{"formPath":"/content/dam/formsanddocuments/forms-review/form1","formName":"form1"}]

GET /content/forms/portal/submission.review.json?func=getAllSubmissions

Devuelve los detalles de todos los formularios enviados. Sin embargo, puede usar parámetros de URL para limitar los resultados.

Parámetros de URL

Especifique los siguientes parámetros en la dirección URL de la solicitud:

Parámetro Descripción
formPath Especifica la ruta del repositorio CRX donde reside el formulario. Si no especifica la ruta del formulario, devolverá una respuesta vacía.
offset (opcional) Especifica el punto inicial en el índice del conjunto de resultados. El valor predeterminado es 0.
limit (opcional) Limita el número de resultados. El valor predeterminado es 30.
orderby
(opcional)		 Especifica la propiedad para ordenar los resultados. El valor predeterminado es jcr:lastModified, que ordena los resultados en función de la última hora de modificación.
sort
(opcional)		 Especifica el orden para ordenar los resultados. El valor predeterminado es desc, que ordena los resultados en orden descendente. Puede especificar asc para ordenar los resultados en orden ascendente.
cutPoints
(opcional)		 Especifica una lista de propiedades de formulario separadas por coma que se incluirán en los resultados. Las propiedades predeterminadas son:
formName, formPath, submitID, formType, jcr:lastModified, owner
search
(opcional)		 Busca el valor especificado en las propiedades del formulario y devuelve formularios con valores coincidentes. El valor predeterminado es "".

Respuesta

El objeto response contiene una matriz JSON que incluye detalles de los formularios especificados. La estructura de la respuesta es la siguiente:

{
 total: "<total number of submissions>",
 items: [{ formName: "<name of the form>", formPath: "<path to the form>", owner: "<owner of the form>"},
 ....]}

Ejemplo

URL de solicitud

https://[host]:[port]/content/forms/portal/submission.review.json?func=getAllSubmissions&formPath=/content/dam/formsanddocuments/forms-review/form2

Respuesta

{"total":1,"items":[{"formName":"form2","formPath":"/content/dam/formsanddocuments/forms-review/form2","submitID":"1403037413508500","formType":"af","jcr:lastModified":"2015-11-05T17:52:32.243+05:30","owner":"admin"}]}

POST /content/forms/portal/submission.review.json?func=addComment

Agrega un comentario a la instancia de envío especificada.

Parámetros de URL

Especifique los siguientes parámetros en la dirección URL de la solicitud:

Parámetro Descripción
submitID Especifica el ID de los metadatos asociado a una instancia de envío.
Comment Especifica el texto para que el comentario se agregue a la instancia de envío especificada.

Respuesta

Devuelve un ID de comentario al publicar correctamente un comentario.

Ejemplo

URL de solicitud

https://[host:'port'/content/forms/portal/submission.review.json?func=addComment&submitID=1403037413508500&comment=API+test+comment

Respuesta

1403873422601300

GET /content/forms/portal/submission.review.json?func=getComments  

Devuelve todos los comentarios publicados en la instancia de envío especificada.

Parámetros de URL

Especifique el siguiente parámetro en la dirección URL de la solicitud:

Parámetro Descripción
submitID Especifica el ID de los metadatos de una instancia de envío.

Respuesta

El objeto de respuesta contiene una matriz JSON que incluye todos los comentarios asociados con el ID de envío especificado. La estructura de la respuesta es la siguiente:

[{
 owner: "<name of the commenter>",
 comment: "<comment text>",
 time: "<time when the comment was posted>"},
 { }......]

Ejemplo

URL de solicitud

https://[host]:'port'/content/forms/portal/submission.review.json?func=getComments&submitID=1403037413508500

Respuesta

[{"owner":"fr1","comment":"API test comment","time":1446726988250}]

POST /content/forms/portal/submission.review.json?func=updateSubmission

Actualiza el valor de la propiedad especificada de la instancia de formulario enviada especificada.

Parámetros de URL

Especifique los siguientes parámetros en la dirección URL de la solicitud:

Parámetro Descripción
submitID Especifica el ID de los metadatos asociado a una instancia de envío.
property Especifica la propiedad del formulario que se va a actualizar.
value Especifica el valor de la propiedad del formulario que se va a actualizar.

Respuesta

Devuelve un objeto JSON con información sobre la actualización publicada.

Ejemplo

URL de solicitud

https://[host]:'port'/content/forms/portal/submission.review.json?func=updateSubmission&submitID=1403037413508500&value=sample_value&property=some_new_prop

Respuesta

{"formName":"form2","owner":"admin","jcr:lastModified":1446727516593,"path":"/content/forms/fp/admin/submit/metadata/1403037413508500.html","submitID":"1403037413508500","status":"submitted"}

En esta página