フォームポータルで送信済みフォームを操作するための API apis-to-work-with-submitted-forms-on-forms-portal

AEM Forms はフォームポータル経由で送信されたフォームデータに対してクエリーを実行する際に使用できる API を提供します。また、この文書で説明している API を使用して、送信済みフォームに対してコメントを投稿したりプロパティを更新したりできます。

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

すべての有効なフォームのリストを返します。

URL パラメーター url-parameters

この API にはその他のパラメーターは必要ありません。

応答 response

この応答オブジェクトには、フォーム名とそのリポジトリパスを含む JSON 配列が含まれています。応答の構造は次のとおりです。

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

例 example

リクエスト URL

https://[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"}]

GET /content/forms/portal/submission.review.json?func=getAllSubmissions get-content-forms-portal-submission-review-json-func-getallsubmissions

すべての送信済みフォームの詳細を返します。ただし、URL パラメーターを使用して結果を制限できます。

URL パラメーター url-parameters-1

リクエスト URL で次のパラメーターを指定します。

応答 response-1

応答オブジェクトには、指定したフォームの詳細を含む JSON 配列が含まれています。応答の構造は次のとおりです。

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

例 example-1

リクエスト URL

https://[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"}]}

POST /content/forms/portal/submission.review.json?func=addComment post-content-forms-portal-submission-review-json-func-addcomment-br

指定した送信インスタンスにコメントを追加します。

URL パラメーター url-parameters-2

リクエスト URL で次のパラメーターを指定します。

回答 response-2

コメントが正常に投稿されるとコメント ID を返します。

例 example-2

リクエスト URL

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

応答

1403873422601300

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

指定した送信インスタンスに投稿したすべてのコメントを返します。

URL パラメーター url-parameters-3

リクエスト URL で次のパラメーターを指定します。

応答 response-3

応答オブジェクトには、指定した送信 ID に関連付けられているすべてのコメントを含む JSON 配列が含まれています。応答の構造は次のとおりです。

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

例 example-3

リクエスト URL

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

応答

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

指定した送信済みフォームインスタンスの指定したプロパティの値を更新します。

URL パラメーター url-parameters-4

リクエスト URL で次のパラメーターを指定します。

応答 response-4

投稿された更新に関する情報を持つ JSON オブジェクトを返します。

例 example-4

リクエスト URL

https://[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"}