APIs zum Arbeiten mit gesendeten Formularen in 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.

Hinweis

Users who will invoke the APIs must be added to the reviewers group as described in Associating submission reviewers to a form.

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

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

URL-Parameter

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

Antwort

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

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

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

URL-Parameter

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

Parameter Beschreibung
formPath Gibt den Pfad für das CRX-Repository an, in dem sich das Formular befindet. Wenn Sie den Pfad des Formulars nicht angeben, wird eine leere Antwort zurückgegeben.
offset (optional) Gibt den Startpunkt im Index des Ergebnissatzes an. Der Standardwert lautet 0.
limit (optional) Begrenzt die Anzahl der Ergebnisse. Der Standardwert lautet 30.
orderby
(optional)
Gibt die Eigenschaft für die Sortierung der Ergebnisse an. Der Standardwert ist jcr:lastModified, d. h., die Ergebnisse werden nach dem Zeitpunkt der letzten Änderung sortiert.
sort
(optional)
Gibt die Reihenfolge für die Sortierung der Ergebnisse an. Der Standardwert ist desc, d. h., die Ergebnisse werden in absteigender Reihenfolge sortiert. Indem Sie asc angeben, können Sie die Ergebnisse in iaufsteigender Reihenfolge sortieren.
cutPoints
(optional)
Gibt eine kommagetrennte Liste von Formulareigenschaften an, die in die Ergebnisse aufgenommen werden sollen. Die Standardeigenschaften sind:
formName, formPath, submitID, formType, jcr:lastModified, owner
search
(optional)
Such in den Formulareigenschaften nach dem angegebenen Wert und gibt Formulare mit übereinstimmenden Werten zurück. Der Standardwert ist "".

Antwort

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

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

Fügt der angegebenen Sendeinstanz einen Kommentar hinzu.

URL-Parameter

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

Parameter Beschreibung
submitID Gibt die zu einer Sendeinstanz gehörige Metadaten-ID an.
Comment Gibt den Text für den Kommentar an, der der angegebenen Sendeinstanz hinzugefügt werden soll.

Antwort

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

Beispiel

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  

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

URL-Parameter

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

Parameter Beschreibung
submitID Gibt die Metadaten-ID einer Sendeinstanz an.

Antwort

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

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

Aktualisiert den Wert der angegebenen Eigenschaft der angegebenen gesendeten Formularinstanz.

URL-Parameter

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

Parameter Beschreibung
submitID Gibt die zu einer Sendeinstanz gehörige Metadaten-ID an.
property Gibt die zu aktualisierende Formulareigenschaft an.
value Gibt den Wert der zu aktualisierenden Formulareigenschaft an.

Antwort

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

Beispiel

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

Auf dieser Seite