APIs zum Arbeiten mit gesendeten Formularen in Forms Portal apis-to-work-with-submitted-forms-on-forms-portal

AEM Forms bietet APIs, mit deren Hilfe Sie über das Formularportal gesendete Formulardaten abfragen können. Darüber hinaus können Sie mithilfe der in diesem Dokument beschriebenen APIs Kommentare veröffentlichen oder die Eigenschaften gesendeter Formulare aktualisieren.

GET /content/forms/portal/submission.review.json?func=getFormsForSubmissionReview get-content-forms-portal-submission-review-json-func-getformsforsubmissionreview-br

Gibt eine Liste aller zulässigen Formulare zurück.

URL-Parameter url-parameters

Für diese API sind keine zusätzlichen Parameter erforderlich.

Antwort response

Das Antwortobjekt enthält ein JSON-Array mit den Namen der Formulare und ihrem Repository-Pfad. Die Antwort weist die folgende Struktur auf:

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

Beispiel example

URL-Anforderung

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

Antwort

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

Gibt Details zu allen gesendeten Formularen zurück. Sie können die Ergebnisse jedoch mithilfe der URL-Parameter einschränken.

URL-Parameter url-parameters-1

Geben Sie die folgenden Parameter in der Anfrage-URL an:

Antwort response-1

Das Antwortobjekt enthält ein JSON-Array mit Details zu den angegebenen Formularen. Die Antwort weist die folgende Struktur auf:

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

Beispiel example-1

URL-Anforderung

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

Antwort

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

Fügt der angegebenen Sendeinstanz einen Kommentar hinzu.

URL-Parameter url-parameters-2

Geben Sie die folgenden Parameter in der Anfrage-URL an:

Antwort response-2

Gibt bei erfolgreicher Veröffentlichung des Kommentars eine Kommentar-ID zurück.

Beispiel example-2

URL-Anforderung

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

Antwort

1403873422601300

GET /content/forms/portal/submission.review.json?func=getComments get-content-forms-portal-submission-review-json-func-getcomments-nbsp

Gibt alle für die angegebene Sendeinstanz veröffentlichten Kommentare zurück.

URL-Parameter url-parameters-3

Geben Sie den folgenden Parameter in der Anfrage-URL an:

Antwort response-3

Das Antwortobjekt enthält ein JSON-Array mit allen mit der angegebenen Sende-ID verknüpften Kommentaren. Die Antwort weist die folgende Struktur auf:

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

Beispiel example-3

URL-Anforderung

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

Antwort

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

Aktualisiert den Wert der festgelegten Eigenschaft der angegebenen gesendeten Formularinstanz.

URL-Parameter url-parameters-4

Geben Sie die folgenden Parameter in der Anfrage-URL an:

Antwort response-4

Gibt ein JSON-Objekt mit Informationen zur veröffentlichten Aktualisierung zurück.

Beispiel example-4

URL-Anforderung

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

Antwort

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