AEM Forms提供API,您可用來查詢透過表單入口網站提交的表單資料。 此外,您可以使用本檔案說明的API張貼註解或更新已提交表單的屬性。
必須依照中的說明,將叫用API的使用者新增到稽核者群組 將提交稽核者與表單建立關聯.
傳回所有合格表單的清單。
此API不需要其他引數。
回應物件包含JSON陣列,其中包含表單名稱及其存放庫路徑。 回應的結構如下:
[
{formName: "<form name>",
formPath: "<path to the form>" },
{.....},
......]
請求 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"}]
傳回所有已提交表單的詳細資料。 不過,您可以使用URL引數來限制結果。
在請求URL中指定下列引數:
參數 | 說明 |
---|---|
formPath |
指定表單所在的CRX存放庫路徑。 如果您未指定表單路徑,則會傳回空白回應。 |
offset (可選) |
指定結果集索引中的起點。 預設值為 0. |
limit (可選) |
限制結果數量。 預設值為 30. |
orderby (可選) |
指定排序結果的屬性。 預設值為 jcr:lastModified,會根據上次修改時間來排序結果。 |
sort (可選) |
指定排序結果的順序。 預設值為 desc,會依遞減順序排序結果。 您可以指定 asc 以遞增順序排序結果。 |
cutPoints (可選) |
指定要包含在結果中的以逗號分隔的表單屬性清單。 預設屬性為:formName , formPath , submitID , formType , jcr:lastModified , owner |
search (可選) |
在表單屬性中搜尋指定的值,並傳回具有相符值的表單。 預設值為 "". |
回應物件包含JSON陣列,其中包含指定表單的詳細資訊。 回應的結構如下:
{
total: "<total number of submissions>",
items: [{ formName: "<name of the form>", formPath: "<path to the form>", owner: "<owner of the form>"},
....]}
請求 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"}]}
將註解新增至指定的提交執行個體。
在請求URL中指定下列引數:
參數 | 說明 |
---|---|
submitID |
指定與提交執行個體相關聯的中繼資料ID。 |
Comment |
指定要新增至指定提交執行個體的註解文字。 |
在評論成功張貼時傳回評論ID。
請求 URL
https://[host:'port'/content/forms/portal/submission.review.json?func=addComment&submitID=1403037413508500&comment=API+test+comment
回應
1403873422601300
傳回在指定提交執行個體上張貼的所有註解。
在請求URL中指定以下引數:
參數 | 說明 |
---|---|
submitID |
指定提交執行個體的中繼資料ID。 |
回應物件包含JSON陣列,其中包含與指定提交ID相關聯的所有註解。 回應的結構如下:
[{
owner: "<name of the commenter>",
comment: "<comment text>",
time: "<time when the comment was posted>"},
{ }......]
請求 URL
https://[host]:'port'/content/forms/portal/submission.review.json?func=getComments&submitID=1403037413508500
回應
[{"owner":"fr1","comment":"API test comment","time":1446726988250}]
更新指定之提交表單執行個體的指定屬性值。
在請求URL中指定下列引數:
參數 | 說明 |
---|---|
submitID |
指定與提交執行個體相關聯的中繼資料ID。 |
property |
指定要更新的表單屬性。 |
value |
指定要更新的表單屬性值。 |
傳回JSON物件,其中包含已發佈更新的相關資訊。
請求 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"}