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

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

Tópicos:

Criado para:

Usuário
Desenvolvedor

O AEM Forms fornece APIs que você pode usar para consultar dados de formulários enviados por meio do portal de formulários. Além disso, você pode publicar comentários ou atualizar propriedades de formulários enviados usando as APIs explicadas neste documento.

NOTE

Os usuários que chamarão as APIs devem ser adicionados ao grupo de revisores conforme descrito em Associando revisores de envio a um formulário.

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 qualificados.

Parâmetros de URL url-parameters

Essa API não requer parâmetros adicionais.

Resposta response

O objeto de resposta 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

Solicitar URL

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:

Parâmetro

Descrição

formPath

Especifica o caminho do repositório do CRX onde o formulário reside. Se você não especificar o caminho do formulário, ele retornará uma resposta vazia.

offset
(opcional)

Especifica o ponto inicial no índice do conjunto de resultados. O valor padrão é 0.

limit
(opcional)

Limita o número de resultados. O valor padrão é 30.

orderby
(opcional)

Especifica a propriedade para classificar resultados. O valor padrão é jcr:lastModified, que classifica os resultados com base no horário da última modificação.

sort
(opcional)

Especifica a ordem de classificação dos resultados. O valor padrão é desc, que classifica os resultados em ordem decrescente. Você pode especificar asc para classificar os resultados em ordem crescente.

cutPoints
(opcional)

Especifica uma lista separada por vírgulas de propriedades de formulário a serem incluídas nos resultados. As propriedades padrão são:
formName, formPath, submitID, formType, jcr:lastModified, owner

search
(opcional)

Pesquisa o valor especificado nas propriedades do formulário e retorna formulários com valores correspondentes. O valor padrão é ".

Resposta response-1

O objeto de resposta 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

Solicitar URL

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:

Parâmetro

Descrição

submitID

Especifica a ID de metadados associada a uma instância de envio.

Comment

Especifica o texto a ser adicionado ao comentário para a instância de envio especificada.

Resposta response-2

Retorna uma ID de comentário na publicação bem-sucedida de um comentário.

Exemplo example-2

Solicitar URL

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 publicados na instância de envio especificada.

Parâmetros de URL url-parameters-3

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

Parâmetro

Descrição

submitID

Especifica a ID de metadados de uma instância de envio.

Resposta response-3

O objeto de resposta 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

Solicitar URL

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 specified da instância do formulário enviado especificada.

Parâmetros de URL url-parameters-4

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

Parâmetro

Descrição

submitID

Especifica a ID de metadados associada a uma instância de envio.

property

Especifica a propriedade de formulário a ser atualizada.

value

Especifica o valor da propriedade de formulário a ser atualizada.

Resposta response-4

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

Exemplo example-4

Solicitar URL

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

recommendation-more-help

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