API para trabajar con formularios enviados en el portal de formularios apis-to-work-with-submitted-forms-on-forms-portal
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.
GET /content/forms/portal/submission.review.json?func=getFormsForSubmissionReview get-content-forms-portal-submission-review-json-func-getformsforsubmissionreview-br
Devuelve una lista de todos los formularios aptos.
Parámetros de URL url-parameters
Esta API no requiere parámetros adicionales.
Respuesta response
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 example
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 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 url-parameters-1
Especifique los siguientes parámetros en la dirección URL de la solicitud:
Respuesta response-1
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 example-1
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 post-content-forms-portal-submission-review-json-func-addcomment-br
Agrega un comentario a la instancia de envío especificada.
Parámetros de URL url-parameters-2
Especifique los siguientes parámetros en la dirección URL de la solicitud:
submitID
Comment
Respuesta response-2
Devuelve un ID de comentario al publicar correctamente un comentario.
Ejemplo example-2
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 get-content-forms-portal-submission-review-json-func-getcomments-nbsp
Devuelve todos los comentarios publicados en la instancia de envío especificada.
Parámetros de URL url-parameters-3
Especifique el siguiente parámetro en la dirección URL de la solicitud:
submitID
Respuesta response-3
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 example-3
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 post-content-forms-portal-submission-review-json-func-updatesubmission-br
Actualiza el valor de la propiedad especificada de la instancia de formulario enviada especificada.
Parámetros de URL url-parameters-4
Especifique los siguientes parámetros en la dirección URL de la solicitud:
submitID
property
value
Respuesta response-4
Devuelve un objeto JSON con información sobre la actualización publicada.
Ejemplo example-4
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"}