用於處理Forms Portal上已提交表單的API apis-to-work-with-submitted-forms-on-forms-portal

AEM Forms提供API，供您查詢透過Forms Portal提交的表單資料。 此外，您可以使用本檔案說明的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

回應物件包含JSON陣列，其中包含與指定提交ID相關聯的所有註解。 回應的結構如下：

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