API pour travailler avec des formulaires envoyés sur le portail de formulaires

Dernière mise à jour : 2023-05-04
  • Créé pour :
  • User
ATTENTION

AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

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.

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

Renvoie une liste de tous les formulaires éligibles.

paramètres d’URL

Cette API ne nécessite pas de paramètres supplémentaires.

Réponse

L’objet de réponse contient un tableau JSON qui inclut les noms des formulaires et leur chemin d’accès au référentiel. La structure de la réponse est la suivante :

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

Exemple

URL de la demande

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

Réponse

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

Renvoie les détails de tous les formulaires envoyés. Vous pouvez toutefois utiliser des paramètres d’URL pour limiter les résultats.

paramètres d’URL

Spécifiez les paramètres suivants dans l’URL de requête :

Paramètre Description
formPath Spécifie le chemin d’accès au référentiel CRX où réside le formulaire. Si vous ne spécifiez pas le chemin du formulaire, une réponse vide est renvoyée.
offset (facultatif) Indique le point de départ dans l’index du jeu 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, qui trie les résultats en fonction de l’heure de la dernière modification.
sort
(facultatif)
Indique l’ordre de tri des résultats. La valeur par défaut est desc, qui 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 les suivantes :
formName, formPath, submitID, formType, jcr:lastModified, owner
search
(facultatif)
Recherche la valeur spécifiée dans les propriétés du formulaire et renvoie les formulaires avec les valeurs correspondantes. La valeur par défaut est "".

Réponse

L’objet de réponse contient un tableau JSON qui inclut les détails des formulaires spécifiés. La structure de la réponse est la suivante :

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

Exemple

URL de la demande

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

Réponse

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

Ajoute un commentaire à l’instance d’envoi spécifiée.

paramètres d’URL

Spécifiez les paramètres suivants dans l’URL de requête :

Paramètre Description
submitID Définit l’ID des métadonnées associé à une instance d’envoi.
Comment Spécifie le texte que le commentaire doit ajouter à l’instance d’envoi spécifiée.

Réponse

Renvoie un identifiant de commentaire lors de la publication réussie d’un commentaire.

Exemple

URL de la demande

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

Réponse

1403873422601300

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

Renvoie tous les commentaires publiés sur l’instance d’envoi spécifiée.

paramètres d’URL

Spécifiez le paramètre suivant dans l’URL de requête :

Paramètre Description
submitID Indique l’ID de métadonnées d’une instance d’envoi.

Réponse

L’objet de réponse contient un tableau JSON qui inclut tous les commentaires associés à l’ID d’envoi spécifié. La structure de la réponse est la suivante :

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

Exemple

URL de la demande

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

Réponse

[{"owner":"fr1","comment":"API test comment","time":1446726988250}]

POST /content/forms/portal/submission.review.json?func=updateSubmission

Met à jour la valeur de la propriété spécifiée de l’instance de formulaire envoyée spécifiée.

paramètres d’URL

Spécifiez les paramètres suivants dans l’URL de requête :

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.

Réponse

Renvoie un objet JSON contenant des informations sur la mise à jour publiée.

Exemple

URL de la demande

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

Réponse

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

Sur cette page