APIs para trabalhar com formulários enviados no portal de formulários apis-to-work-with-submitted-forms-on-forms-portal

O AEM Forms fornece APIs que podem ser usadas para consultar dados de formulários enviados pelo portal de formulários. Além disso, você pode postar comentários ou atualizar propriedades de formulários enviados usando as APIs explicadas neste documento.

GET /content/forms/portal/submission.review.json?func=getFormsForSubmissionReview get-content-forms-portal-submission-review-json-func-getformsforsubmissionreview-br

Retorna uma lista de todos os formulários elegíveis.

Parâmetros de URL url-parameters

Essa API não requer parâmetros adicionais.

Resposta response

O objeto response contém uma matriz JSON que inclui nomes de formulários e seu caminho de repositório. A estrutura da resposta é a seguinte:

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

Exemplo example

URL de solicitação

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

Resposta

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

Retorna detalhes de todos os formulários enviados. No entanto, você pode usar parâmetros de URL para limitar os resultados.

Parâmetros de URL url-parameters-1

Especifique os seguintes parâmetros no URL da solicitação:

Resposta response-1

O objeto response contém uma matriz JSON que inclui detalhes dos formulários especificados. A estrutura da resposta é a seguinte:

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

Exemplo example-1

URL de solicitação

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

Resposta

{"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

Adiciona um comentário à instância de envio especificada.

Parâmetros de URL url-parameters-2

Especifique os seguintes parâmetros no URL da solicitação:

Resposta response-2

Retorna uma ID de comentário sobre a postagem bem-sucedida de um comentário.

Exemplo example-2

URL de solicitação

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

Resposta

1403873422601300

GET /content/forms/portal/submission.review.json?func=getComments   get-content-forms-portal-submission-review-json-func-getcomments-nbsp

Retorna todos os comentários postados na instância de envio especificada.

Parâmetros de URL url-parameters-3

Especifique o seguinte parâmetro no URL da solicitação:

Resposta response-3

O objeto response contém uma matriz JSON que inclui todos os comentários associados à ID de envio especificada. A estrutura da resposta é a seguinte:

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

Exemplo example-3

URL de solicitação

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

Resposta

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

Atualiza o valor da propriedade especificada da instância de formulário submetido especificada.

Parâmetros de URL url-parameters-4

Especifique os seguintes parâmetros no URL da solicitação:

Resposta response-4

Retorna um objeto JSON com informações sobre a atualização publicada.

Exemplo example-4

URL de solicitação

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

Resposta

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