API per l’utilizzo dei moduli inviati nel portale dei moduli

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

NOTA

Gli utenti che richiameranno le API devono essere aggiunti al gruppo di revisori come descritto in Associazione dei revisori dell'invio a un modulo.

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

Restituisce un elenco di tutti i moduli idonei.

Parametri URL

Questa API non richiede parametri aggiuntivi.

Risposta

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

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

Esempio

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=getAllSubmission

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

Parametri URL

Specifica i seguenti parametri nell’URL della richiesta:

Parametro Descrizione
formPath Specifica il percorso del repository CRX in cui si trova il modulo. Se non si specifica il percorso del modulo, viene restituita una risposta vuota.
offset (facoltativo) Specifica il punto iniziale nell'indice del set di risultati. Il valore predefinito è 0.
limit (facoltativo) Limita il numero di risultati. Il valore predefinito è 30.
orderby
(facoltativo)
Specifica la proprietà per l'ordinamento dei risultati. Il valore predefinito è jcr:lastModified, che ordina i risultati in base all'ora dell'ultima modifica.
sort
(facoltativo)
Specifica l'ordine dei risultati dell'ordinamento. Il valore predefinito è desc, che ordina i risultati in ordine decrescente. Puoi specificare asc per ordinare i risultati in ordine crescente.
cutPoints
(facoltativo)
Specifica un elenco di proprietà del modulo separate da virgola da includere nei risultati. Le proprietà predefinite sono:
formName, formPath, submitID, formType, jcr:lastModified, owner
search
(facoltativo)
Cerca il valore specificato nelle proprietà del modulo e restituisce moduli con valori corrispondenti. Il valore predefinito è "".

Risposta

L'oggetto response 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

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

Aggiunge un commento all’istanza di invio specificata.

Parametri URL

Specifica i seguenti parametri nell’URL della richiesta:

Parametro Descrizione
submitID Specifica l'ID metadati associato a un'istanza di invio.
Comment Specifica il testo da aggiungere al commento all'istanza di invio specificata.

Risposta

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

Esempio

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  

Restituisce tutti i commenti inviati nell'istanza di invio specificata.

Parametri URL

Specifica il seguente parametro nell’URL della richiesta:

Parametro Descrizione
submitID Specifica l'ID metadati di un'istanza di invio.

Risposta

L'oggetto response contiene una matrice 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

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

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

Parametri URL

Specifica i seguenti parametri nell’URL della richiesta:

Parametro Descrizione
submitID Specifica l'ID metadati associato a un'istanza di invio.
property Specifica la proprietà della maschera da aggiornare.
value Specifica il valore della proprietà modulo da aggiornare.

Risposta

Restituisce un oggetto JSON con informazioni sull'aggiornamento registrato.

Esempio

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

In questa pagina