AEM Forms fournit des API que vous pouvez utiliser pour interroger les données de formulaire envoyées via un portail de formulaires. En outre, vous pouvez envoyer des commentaires ou mettre à jour les propriétés des formulaires envoyés à l’aide des API décrites dans ce document.
Remarque :
Les utilisateurs qui appelleront les API doivent être ajoutés au groupe de réviseurs comme décrit dans la section Associer des réviseurs d’envoi à un formulaire.
L’objet de réponse contient un tableau JSON qui inclut les noms de formulaires et leur chemin d’accès au référentiel. La structure de la réponse est comme suit :
[
{formName: "<nom du formulaire>",
formPath: "<chemin du formulaire>" },
{.....},
......]
http://[host]:[port]/content/forms/portal/submission.review.json?func=getFormsForSubmissionReview
[{"formPath":"/content/dam/formsanddocuments/forms-review/form2","formName":"form2"},{"formPath":"/content/dam/formsanddocuments/forms-review/form1","formName":"form1"}]
Renvoie les détails de tous les formulaires envoyés. Cependant, vous pouvez utiliser les paramètres d’URL pour limiter les résultats.
| Paramètre | Description |
|---|---|
| formPath | Spécifie le chemin d’accès au référentiel CRX dans lequel se trouve le formulaire. Si vous ne spécifiez pas le chemin d’accès au formulaire, une réponse vide est envoyée. |
| offset (facultatif) |
Spécifie le point de départ dans l’index de l’ensemble de résultats. La valeur par défaut est 0. |
| limit (facultatif) |
Limite le nombre de résultats. La valeur par défaut est 30. |
| orderby (facultatif) |
Spécifie la propriété pour trier les résultats. La valeur par défaut est jcr:lastModified, elle trie les résultats selon l’heure de la dernière modification. |
| sort (facultatif) |
Spécifie l’ordre pour trier les résultats. La valeur par défaut est desc, elle trie les résultats dans l’ordre décroissant. Vous pouvez spécifier asc pour trier les résultats dans l’ordre croissant. |
| cutPoints (facultatif) |
Spécifie une liste de propriétés de formulaire séparées par des virgules du formulaire à inclure dans les résultats. Les propriétés par défaut sont : formName, formPath, submitID, formType, jcr:lastModified, owner |
| search (facultatif) |
Recherche la valeur spécifiée dans les propriétés de formulaire, puis renvoie les formulaires avec les valeurs correspondantes. La valeur par défaut est "". |
L’objet de réponse contient un tableau JSON qui comprend les informations des formulaires spécifiés. La structure de la réponse est comme suit :
{
total: "<nombre total d’envois>",
items: [{ formName: "<nom du formulaire>", formPath: "<chemin du formulaire>", owner: "<propriétaire du formulaire>"},
....]}
http://[host]:[port]/content/forms/portal/submission.review.json?func=getAllSubmissions&formPath=/content/dam/formsanddocuments/forms-review/form2
{"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"}]}
| Paramètre | Description |
|---|---|
| submitID | Définit l’ID des métadonnées associé à une instance d’envoi. |
| Commentaire | Spécifie le texte pour que le commentaire s’ajoute à l’instance d’envoi spécifiée. |
http://[host:[port]/content/forms/portal/submission.review.json?func=addComment&submitID=1403037413508500&comment=API+test+comment
1403873422601300
L’objet de réponse contient un tableau JSON qui comprend tous les commentaires associés à l’ID d’envoi spécifié. La structure de la réponse est comme suit :
[{
owner: "<nom du commentateur>",
comment: "<texte du commentaire>",
time: "<heure de publication du commentaire>"},
{ }......]
http://[host]:[port]/content/forms/portal/submission.review.json?func=getComments&submitID=1403037413508500
[{"owner":"fr1","comment":"API test comment","time":1446726988250}]
| Paramètre | Description |
|---|---|
| submitID | Définit l’ID des métadonnées associé à une instance d’envoi. |
| property | Spécifie la propriété de formulaire à mettre à jour. |
| value | Indique la valeur de la propriété de formulaire à mettre à jour. |
http://[host]:[port]/content/forms/portal/submission.review.json?func=updateSubmission&submitID=1403037413508500&value=sample_value&property=some_new_prop
{"formName":"form2","owner":"admin","jcr:lastModified":1446727516593,"path":"/content/forms/fp/admin/submit/metadata/1403037413508500.html","submitID":"1403037413508500","status":"submitted"}
Les publications Twitter™ et Facebook ne sont pas couvertes par les dispositions Creative Commons.