API per lavorare con i moduli inviati sul portale dei moduli apis-to-work-with-submitted-forms-on-forms-portal

AEM Forms fornisce API che è possibile utilizzare per eseguire query sui dati dei moduli inviati tramite il portale Forms. Inoltre, puoi pubblicare commenti o aggiornare le proprietà dei moduli inviati utilizzando le API illustrate in questo documento.

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

Restituisce un elenco di tutti i moduli idonei.

Parametri URL url-parameters

Questa API non richiede parametri aggiuntivi.

Risposta response

L’oggetto di risposta contiene un array JSON che include i nomi dei moduli e il relativo percorso dell’archivio. La struttura della risposta è la seguente:

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

Esempio example

URL richiesta

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

Risposta

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

Restituisce i dettagli di tutti i moduli inviati. Tuttavia, puoi utilizzare i parametri URL per limitare i risultati.

Parametri URL url-parameters-1

Specifica i seguenti parametri nell’URL della richiesta:

Risposta response-1

L’oggetto di risposta contiene un array JSON che include i dettagli dei moduli specificati. La struttura della risposta è la seguente:

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

Esempio example-1

URL richiesta

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

Risposta

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

Aggiunge un commento all'istanza di invio specificata.

Parametri URL url-parameters-2

Specifica i seguenti parametri nell’URL della richiesta:

Risposta response-2

Restituisce un ID commento in caso di pubblicazione corretta di un commento.

Esempio example-2

URL richiesta

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

Risposta

1403873422601300

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

Restituisce tutti i commenti pubblicati sull'istanza di invio specificata.

Parametri URL url-parameters-3

Specifica il seguente parametro nell’URL della richiesta:

Risposta response-3

L’oggetto di risposta contiene un array JSON che include tutti i commenti associati all’ID di invio specificato. La struttura della risposta è la seguente:

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

Esempio example-3

URL richiesta

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

Risposta

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

Aggiorna il valore della proprietà specificata dell'istanza di modulo inviata specificata.

Parametri URL url-parameters-4

Specifica i seguenti parametri nell’URL della richiesta:

Risposta response-4

Restituisce un oggetto JSON con informazioni sull’aggiornamento inviato.

Esempio example-4

URL richiesta

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

Risposta

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