フォームポータルで送信済みフォームを操作するための API

注意

AEM 6.4 の拡張サポートは終了し、このドキュメントは更新されなくなりました。 詳細は、 技術サポート期間. サポートされているバージョンを見つける ここ.

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

メモ

「フォームへの送信レビュー担当者の関連付け」で説明するように、API を呼び出すユーザーは、レビュー担当者グループに追加する必要があります。

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

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

URL パラメーター

この 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"}]

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

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

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

POST /content/forms/portal/submission.review.json?func=addComment

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

URL パラメーター

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

パラメーター 説明
submitID 送信インスタンスに関連付けられているメタデータ ID を指定します。
Comment 指定した送信インスタンスに追加するコメントのテキストを指定します。

回答

コメントが正常に投稿された場合に、コメント ID を返します。

例

リクエスト 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  

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

URL パラメーター

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

パラメーター 説明
submitID 送信インスタンスのメタデータ ID を指定します。

応答

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

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

POST /content/forms/portal/submission.review.json?func=updateSubmission

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

URL パラメーター

リクエスト 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"}

このページ