API pour travailler avec des formulaires envoyés sur le portail de formulaires apis-to-work-with-submitted-forms-on-forms-portal
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.
GET /content/forms/portal/submission.review.json?func=getFormsForSubmissionReview get-content-forms-portal-submission-review-json-func-getformsforsubmissionreview-br
Renvoie une liste de tous les formulaires éligibles.
paramètres d’URL url-parameters
Cette API ne nécessite pas de paramètres supplémentaires.
Réponse response
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 example
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 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 url-parameters-1
Spécifiez les paramètres suivants dans l’URL de requête :
Réponse response-1
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 example-1
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 post-content-forms-portal-submission-review-json-func-addcomment-br
Ajoute un commentaire à l’instance d’envoi spécifiée.
paramètres d’URL url-parameters-2
Spécifiez les paramètres suivants dans l’URL de requête :
submitID
Comment
Réponse response-2
Renvoie un identifiant de commentaire lors de la publication réussie d’un commentaire.
Exemple example-2
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 get-content-forms-portal-submission-review-json-func-getcomments-nbsp
Renvoie tous les commentaires publiés sur l’instance d’envoi spécifiée.
paramètres d’URL url-parameters-3
Spécifiez le paramètre suivant dans l’URL de requête :
submitID
Réponse response-3
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 example-3
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 post-content-forms-portal-submission-review-json-func-updatesubmission-br
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 url-parameters-4
Spécifiez les paramètres suivants dans l’URL de requête :
submitID
property
value
Réponse response-4
Renvoie un objet JSON contenant des informations sur la mise à jour publiée.
Exemple example-4
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"}