API's voor het werken met verzonden formulieren op het formulierportaal apis-to-work-with-submitted-forms-on-forms-portal
AEM Forms biedt API's die u kunt gebruiken voor het zoeken naar formuliergegevens die via de portal Formulieren worden verzonden. Bovendien kunt u opmerkingen plaatsen of eigenschappen van verzonden formulieren bijwerken met de API's die in dit document worden beschreven.
GET /content/forms/portal/submission.review.json?func=getFormsForSubmissionReview get-content-forms-portal-submission-review-json-func-getformsforsubmissionreview-br
Retourneert een lijst met alle in aanmerking komende formulieren.
URL-parameters url-parameters
Voor deze API zijn geen aanvullende parameters vereist.
Antwoord response
Het reactieobject bevat een JSON-array die formuliernamen en het pad naar de opslagplaats bevat. De structuur van de respons is als volgt:
[
{formName: "<form name>",
formPath: "<path to the form>" },
{.....},
......]
Voorbeeld example
Verzoek URL
https://[host]:[port]/content/forms/portal/submission.review.json?func=getFormsForSubmissionReview
Reactie
[{"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
Retourneert details van alle verzonden formulieren. U kunt URL-parameters echter gebruiken om de resultaten te beperken.
URL-parameters url-parameters-1
Geef de volgende parameters op in de aanvraag-URL:
Antwoord response-1
Het reactieobject bevat een JSON-array die details van de opgegeven formulieren bevat. De structuur van de respons is als volgt:
{
total: "<total number of submissions>",
items: [{ formName: "<name of the form>", formPath: "<path to the form>", owner: "<owner of the form>"},
....]}
Voorbeeld example-1
Verzoek URL
https://[host]:[port]/content/forms/portal/submission.review.json?func=getAllSubmissions&formPath=/content/dam/formsanddocuments/forms-review/form2
Reactie
{"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
Voegt een opmerking toe aan de opgegeven verzendinstantie.
URL-parameters url-parameters-2
Geef de volgende parameters op in de aanvraag-URL:
submitID
Comment
Antwoord response-2
Retourneert een opmerking-id bij het plaatsen van een opmerking.
Voorbeeld example-2
Verzoek URL
https://[host:'port'/content/forms/portal/submission.review.json?func=addComment&submitID=1403037413508500&comment=API+test+comment
Reactie
1403873422601300
GET /content/forms/portal/submission.review.json?func=getComments get-content-forms-portal-submission-review-json-func-getcomments-nbsp
Retourneert alle opmerkingen die op het opgegeven verzendexemplaar zijn geplaatst.
URL-parameters url-parameters-3
Geef de volgende parameter op in de aanvraag-URL:
submitID
Antwoord response-3
Het reactieobject bevat een JSON-array die alle opmerkingen bevat die aan de opgegeven verzendings-id zijn gekoppeld. De structuur van de respons is als volgt:
[{
owner: "<name of the commenter>",
comment: "<comment text>",
time: "<time when the comment was posted>"},
{ }......]
Voorbeeld example-3
Verzoek URL
https://[host]:'port'/content/forms/portal/submission.review.json?func=getComments&submitID=1403037413508500
Reactie
[{"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
Hiermee wordt de waarde van de opgegeven eigenschap van de opgegeven ingediende formulierinstantie bijgewerkt.
URL-parameters url-parameters-4
Geef de volgende parameters op in de aanvraag-URL:
submitID
property
value
Antwoord response-4
Retourneert een JSON-object met informatie over de geposte update.
Voorbeeld example-4
Verzoek URL
https://[host]:'port'/content/forms/portal/submission.review.json?func=updateSubmission&submitID=1403037413508500&value=sample_value&property=some_new_prop
Reactie
{"formName":"form2","owner":"admin","jcr:lastModified":1446727516593,"path":"/content/forms/fp/admin/submit/metadata/1403037413508500.html","submitID":"1403037413508500","status":"submitted"}