AEM Forms ワークスペースで使用する 各種 API

AEM Forms ワークスペースでは次の API が使用されています。

Javascript メソッド サービス名 API 名 コメント
getGroups ProcessManagementUserProxyService getGroups グループを検索します。何も指定しない場合はすべてのグループのリストを返します。名前を指定した場合はそれらのグループを返します。
getUsersAndGroups ProcessManagementUserProxyService getUsersAndGroups ユーザーおよびグループを検索します。何も指定しない場合はすべてのユーザーとグループのリストを返します。名前を指定した場合はそれらのユーザーとグループを返します。
prepareForSubmit ProcessManagementDocumentHandlingService prepareForSubmit これは、フォームを DocumentSubmitServlet 経由で送信する前に呼び出されます。実際の送信中に取得されるタスク ID をセッション変数（有効期限と共に）に設定します。
submitTask ProcessManagementDocumentHandlingService submit タスクに関連付けられたドキュメントオブジェクトを送信します（そして次にプロセスを送信します）。
getRootEndpointCategories ProcessManagementStartpointService getRootEndpointCategories サーバーに存在するすべてのルートカテゴリを取得します。
getDirectChildCategories ProcessManagementStartpointService getDirectChildCategories2 カテゴリのすべての直接の子を取得します。
getAllStartpoints ProcessManagementStartpointService getAllStartpoints すべてのカテゴリ下にあるサーバーに存在するすべてのスタートポイントを取得します。
invokeStartpoint ProcessManagementStartpointService invokeStartpoint これにより、スタートポイントが呼びされてスタートポイントに対応する新しいタスクが作成されます。
getAllTasks ProcessManagementTaskService getAllActionableTasks ログインしたユーザーに対して作成されて転送または問い合わせ、保存、割り当てられた、あるいは割り当てられて保存されたすべてのタスクを取得します。
getTask ProcessManagementTaskService getTask 特定のタスクを取得します。
renderTask ProcessManagementTaskService render タスクをレンダリングして、フォーム URL、フォームタイプ、データ URL （必要な場合）などフォームのレンダリングに必要な情報を返します。
submitWithPriorData ProcessManagementTaskService submitWithPriorData 結果キーを使用して TaskManager の送信 API の結果を返します。
submitWithData ProcessManagementTaskService submitWithData TaskManager の送信 API を使用してタスクに関連付けられたフォームデータ（文字列として渡された）を送信します。TaskManager の送信 API を呼び出さないフレックスフォームに使用されます。
save ProcessManagementTaskService save タスクをサーバーに保存します。
complete ProcessManagementTaskService complete タスクを完了し、タスクはプロセス設計に従って次の手順に渡されます。
getAttachment ProcessManagementTaskService getAttachment 利用できる添付ファイルの URL を返します。
getAllAttachments ProcessManagementTaskService getAllActionableAttachments タスクのすべての添付ファイルおよびメモを取得します。
share ProcessManagementTaskService share 別のユーザーとタスクを共有します。別のユーザーはタスクを要求してタスクの所有者になることができます。
forward ProcessManagementTaskService forward 別のユーザーにタスクを転送します。
consult ProcessManagementTaskService consult 別のユーザーにタスクについて問い合わせます。
claim ProcessManagementTaskService claim 共有キューで使用可能なタスクを要求します。
unlock ProcessManagementTaskService unlock タスクをロック解除します。
lock ProcessManagementTaskService lock タスクをロックします。これにより、共有されている場合は別のユーザーが要求できなくなります。
reject ProcessManagementTaskService reject タスクを前の所有者に返します。
abandon ProcessManagementTaskService abandon タスクを削除します。
setVisibility ProcessManagementTaskService setVisibility タスクの表示を設定します。表示が false に設定された場合は、それ以降ユーザーに表示されなくなります。
getUsers ProcessManagementUserProxyService getUsers ユーザーの検索に使用されます。名前が指定されていない場合はすべてのユーザーを返しますが、そうでない場合は指定された名前のユーザーを返します。
getUsersInGroup ProcessManagementUserProxyService getUsersInGroupByName グループ内のすべてのユーザーを返します。
grantQueueAccess ProcessManagementQueueService grantQueueAccess ログインしたユーザーのキューへのアクセスを指定したユーザーに付与します。基本的に固有のキューを別のユーザーと共有することになります。
requestQueueAccess ProcessManagementQueueService requestQueueAccess ログインしたユーザーに対して指定したユーザーのキューへのアクセスを要求します。ユーザーが要求を承認した場合、ユーザーのキューはログインユーザーと共有されます。
getGrantedUsers ProcessManagementQueueService getGrantedUsers ログインユーザーのキューへのアクセス権を持つすべてのユーザーを返します。
getUsersForAccessibleQueues ProcessManagementQueueService getUsersForAccessibleQueues ユーザーにアクセス可能なキューを持つすべてのユーザーを返します。
revokeQueueAccess ProcessManagementQueueService revokeQueueAccess ユーザーのリストから、ログインユーザーのキューへのアクセス権を持つユーザーを削除します。
removeQueueAccess ProcessManagementQueueService removeQueueAccess ユーザーのリストからログインユーザーにアクセス可能なキューを持つユーザーを削除します。
getAllQueues
 ProcessManagementQueueService
 getAllQueues
 ログインユーザーにアクセス可能なすべてのキュー（固有のキュー、共有キューおよびグループキュー）を取得します。
getOutOfOfficeSettings ProcessManagementOutOfOfficeService getOutOfOfficeSettings ユーザーの不在設定を取得します。
saveOutOfOfficeSettingsJson ProcessManagementOutOfOfficeService saveOutOfOfficeSettingsJson ユーザーの不在設定を保存します。
getAllProcesses ProcessManagementProcessService getAllProcesses すべてのプロセスのリストを返します。
getParticipatedProcesses ProcessManagementProcessService getParticipatedProcesses ログインユーザーが参加したすべてのプロセス名のリストを返します。
getProcessInstance
 ProcessManagementProcessService
 getProcessInstance
 プロセスインスタンスの詳細を取得します。
getProcessInstances ProcessManagementQueryService getProcessInstances プロセスのすべてのプロセスインスタンスを取得します。
getPendingTasksForProcessInstance ProcessManagementQueryService getPendingTasksForProcessInstance プロセスインスタンスの保留中のタスクを取得します。
getTasksForProcessInstance ProcessManagementQueryService getTasksForProcessInstance プロセスインスタンスのすべてのタスクを取得します。
getAllSearchTemplates ProcessManagementQueryService getAllSearchTemplates すべての検索テンプレートのリストを返します。
getTemplate ProcessManagementQueryService getTemplate 検索テンプレートの内容を返します。
findTasksJson
 ProcessManagementQueryService findTasksJson 検索テンプレートのすべての条件を満たすすべてのタスクを検索して返します。
getAssignmentsForTask ProcessManagementTaskService getAssignmentsForTask タスクのすべてのアサインを取得します。例えば、ユーザーがタスクを別のユーザーに転送または問い合わせする場合、それがタスクのアサインになります。
deleteAttachment TaskManagerService deleteAttachment 添付ファイルを削除します。
initialize ProcessManagementClientSessionService initialize 必要に応じてアサーションを更新します。ユーザーを認証します。サーバー / クライアント情報のセッションパラメータを設定します。ユーザー情報およびポーリング間隔を返します。
getTasksForDirectReports ProcessManagementTeamTasksService getTasksForDirectReports ログインしたマネージャーの直接レポートのすべてのタスクを返します。
getTaskOfDirectReport
 ProcessManagementTeamTasksService getTaskOfDirectReport ログインしたマネージャーの指定された直接レポートのタスクを返します。
forwardTaskOfDirectReport ProcessManagementTeamTasksService forwardTaskOfDirectReport 別のユーザーに直接レポートのタスクを転送します。
rejectTaskOfDirectReport ProcessManagementTeamTasksService rejectTaskOfDirectReport 前のユーザーに直接レポートのタスクを返します。
getProperty WorkspacePropertyService getProperty ユーザーのワークスペースプロパティを取得します。
removeProperty WorkspacePropertyService delete ユーザーのワークスペースプロパティを削除します。
getProperties WorkspacePropertyService getPropertiesAsMap ユーザーのすべてのワークスペースプロパティを返します。
setProperty WorkspacePropertyService setProperty ユーザーのワークスペースプロパティを設定します。
getCurrentUserImageUrl ProcessManagementClientSessionService getCurrentUserImageUrl ログインしたユーザーのユーザーの画像 URL を取得します。
getUserImageUrl ProcessManagementClientSessionService getUserImageUrl 指定したユーザーのユーザーの画像 URL を取得します。
uploadNote ProcessManagementDocumentHandlingService uploadNote タスクのメモをサーバーにアップロードします。
uploadRMAToServer （HTML テンプレートから直接呼び出すこともできます）
 ProcessManagementDocumentHandlingService uploadAttachment サーバーにタスクの添付ファイルをアップロードします。
getImageURL （HTML テンプレートから直接呼び出すこともできます） ProcessManagementDocumentHandlingService getImage プロセスの画像を取得します。

このページ