APIs para trabalhar com formulários enviados no portal de formulários

Última atualização em 2023-05-23
  • Tópicos
  • Forms Portal
    Exibir mais informações sobre este tópico
  • Criado para:
  • User

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.

OBSERVAÇÃO

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

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

Retorna uma lista de todos os formulários qualificados.

Parâmetros de URL

Essa API não requer parâmetros adicionais.

Resposta

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

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

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

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

Parâmetro Descrição
formPath Especifica o caminho do repositório 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

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

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

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

Parâmetros de URL

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

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

Exemplo

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  

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

Parâmetros de URL

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

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

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

Atualiza o valor da propriedade specified da instância do formulário enviado especificada.

Parâmetros de URL

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

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

Exemplo

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"}
Página anterior
Next page

Nesta página