API's voor het werken met verzonden formulieren op een formulierportal

LET OP

AEM 6.4 heeft het einde van de uitgebreide ondersteuning bereikt en deze documentatie wordt niet meer bijgewerkt. Raadpleeg voor meer informatie onze technische ondersteuningsperioden. Ondersteunde versies zoeken hier.

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.

OPMERKING

Gebruikers die de API's aanroepen, moeten worden toegevoegd aan de groep met revisoren, zoals wordt beschreven in Verzendrevisoren koppelen aan een formulier.

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

Retourneert een lijst met alle in aanmerking komende formulieren.

URL-parameters

Voor deze API zijn geen aanvullende parameters vereist.

Antwoord

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

Aanvraag-URL

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

Antwoord

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

Retourneert details van alle verzonden formulieren. U kunt URL-parameters echter gebruiken om de resultaten te beperken.

URL-parameters

Geef de volgende parameters op in de aanvraag-URL:

Parameter Beschrijving
formPath Hiermee geeft u het CRX-opslagpad op waar het formulier zich bevindt. Als u het formulierpad niet opgeeft, wordt een leeg antwoord geretourneerd.
offset (optioneel) Geeft het beginpunt op in de index van de resultatenset. De standaardwaarde is 0.
limit (optioneel) Hiermee beperkt u het aantal resultaten. De standaardwaarde is 30.
orderby
(optioneel)		 Specifies the property for sorting results. De standaardwaarde is jcr:lastModified, die resultaten sorteert op basis van de laatste gewijzigde tijd.
sort
(optioneel)		 Hiermee geeft u de volgorde voor het sorteren van resultaten op. De standaardwaarde is descen sorteert resulteert in aflopende volgorde. U kunt asc om de resultaten in oplopende volgorde te sorteren.
cutPoints
(optioneel)		 Hiermee geeft u een door komma's gescheiden lijst met formuliereigenschappen op die in de resultaten moeten worden opgenomen. De standaardeigenschappen zijn:
formName, formPath, submitID, formType, jcr:lastModified, owner
search
(optioneel)		 Zoekt de opgegeven waarde in formuliereigenschappen en retourneert formulieren met overeenkomende waarden. De standaardwaarde is "".

Antwoord

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

Aanvraag-URL

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

Antwoord

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

Voegt een opmerking toe aan de opgegeven verzendinstantie.

URL-parameters

Geef de volgende parameters op in de aanvraag-URL:

Parameter Beschrijving
submitID Hiermee wordt de metagegevens-id opgegeven die aan een verzendinstantie is gekoppeld.
Comment Geeft de tekst aan voor de opmerking die moet worden toegevoegd aan de opgegeven verzendinstantie.

Antwoord

Retourneert een opmerking-id bij het plaatsen van een opmerking.

Voorbeeld

Aanvraag-URL

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

Antwoord

1403873422601300

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

Retourneert alle opmerkingen die op het opgegeven verzendexemplaar zijn geplaatst.

URL-parameters

Geef de volgende parameter op in de aanvraag-URL:

Parameter Beschrijving
submitID Hiermee wordt de metagegevens-id van een verzendinstantie opgegeven.

Antwoord

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

Aanvraag-URL

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

Antwoord

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

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

Hiermee wordt de waarde van de opgegeven eigenschap van de opgegeven ingediende formulierinstantie bijgewerkt.

URL-parameters

Geef de volgende parameters op in de aanvraag-URL:

Parameter Beschrijving
submitID Hiermee wordt de metagegevens-id opgegeven die aan een verzendinstantie is gekoppeld.
property Hiermee geeft u de formuliereigenschap op die moet worden bijgewerkt.
value Hiermee wordt de waarde opgegeven van de eigenschap form die moet worden bijgewerkt.

Antwoord

Retourneert een JSON-object met informatie over de geposte update.

Voorbeeld

Aanvraag-URL

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

Antwoord

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

Op deze pagina