Sie sehen sich Hilfeinhalte der folgenden Version an:
- 6.4
- 6.3
- 6.2
- Ältere Versionen
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:
Benutzer, die die APIs aufrufen sollen, müssen der Reviewer-Gruppe hinzugefügt werden wie unter Verknüpfen von Reviewer mit einem Formular für die Übermittlung beschrieben.
Das Antwortobjekt enthält ein JSON-Array mit den Namen der Formulare und ihrem Repository-Pfad. Die Antwort weist die folgende Struktur auf:
[
{formName: "<Formularname>",
formPath: "<Pfad des Formulars>" },
{.....},
......]
http://[host]:[port]/content/forms/portal/submission.review.json?func=getFormsForSubmissionReview
[{"formPath":"/content/dam/formsanddocuments/forms-review/form2","formName":"form2"},{"formPath":"/content/dam/formsanddocuments/forms-review/form1","formName":"form1"}]
Gibt Details zu allen gesendeten Formularen zurück. Sie können die Ergebnisse jedoch mithilfe der URL-Parameter einschränken.
| 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 ist 0. |
| limit (optional) |
Begrenzt die Anzahl der Ergebnisse. Der Standardwert ist 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 "". |
Das Antwortobjekt enthält ein JSON-Array mit Details zu den angegebenen Formularen. Die Antwort weist die folgende Struktur auf:
{
total: "<Gesamtanzahl der Übermittlungen>",
items: [{ formName: "<Name des Formulars>", formPath: "<Pfad zum Formular>", owner: "<Besitzer des Formulars>"},
....]}
http://[host]:[port]/content/forms/portal/submission.review.json?func=getAllSubmissions&formPath=/content/dam/formsanddocuments/forms-review/form2
{"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"}]}
| Parameter | Beschreibung |
|---|---|
| submitID | Gibt die zu einer Sendeinstanz gehörige Metadaten-ID an. |
| Kommentar | Gibt den Text für den Kommentar an, der der angegebenen Sendeinstanz hinzugefügt werden soll. |
http://[host:[port]/content/forms/portal/submission.review.json?func=addComment&submitID=1403037413508500&comment=API+test+comment
1403873422601300
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 des Beitragenden>",
comment: "<Kommentartext>",
time: "<Zeitpunkt der Veröffentlichung des Kommentars>"},
{ }......]
http://[host]:[port]/content/forms/portal/submission.review.json?func=getComments&submitID=1403037413508500
[{"owner":"fr1","comment":"API test comment","time":1446726988250}]
| Parameter | Beschreibung |
|---|---|
| submitID | Gibt die zu einer Sendeinstanz gehörige Metadaten-ID an. |
| Eigenschaft | Gibt die zu aktualisierende Formulareigenschaft an. |
| value | Gibt den Wert der zu aktualisierenden Formulareigenschaft an. |
http://[host]:[port]/content/forms/portal/submission.review.json?func=updateSubmission&submitID=1403037413508500&value=sample_value&property=some_new_prop
{"formName":"form2","owner":"admin","jcr:lastModified":1446727516593,"path":"/content/forms/fp/admin/submit/metadata/1403037413508500.html","submitID":"1403037413508500","status":"submitted"}
Twitter™- und Facebook-Beiträge fallen nicht unter die Bedingungen der Creative Commons-Lizenz.