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

注意

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

AEM Forms Workspace では次の API が使用されます。

Javascript メソッド サービス名 API 名 コメント
getGroups ProcessManagementUserProxyService getGroups グループを検索します。 何も指定しなかった場合は、すべてのグループのリストを返し、指定した名前のグループを返します。
getUsersAndGroups ProcessManagementUserProxyService getUsersAndGroups ユーザーとグループを検索します。 何も指定しなかった場合は、すべてのユーザーとグループのリストを返し、指定した名前のユーザーとグループを返します。
prepareForSubmit ProcessManagementDocumentHandlingService prepareForSubmit このメソッドは、DocumentSubmitServlet を介してフォームを送信する前に呼び出されます。 実際の送信中に取得されるタスク ID をセッション変数（有効期限と共に）に設定します。
submitTask ProcessManagementDocumentHandlingService 送信 タスクに関連付けられたドキュメントオブジェクトを送信します（そして、次にプロセスを送信します）。
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 タスクをサーバーに保存します。
完了 ProcessManagementTaskService 完了 タスクが完了し、プロセスデザインに従ってタスクが次のステップに渡されます。
getAttachment ProcessManagementTaskService getAttachment 添付ファイルが使用可能な添付ファイルの URL を返します。
getAllAttachments ProcessManagementTaskService getAllActionableAttachments タスクのすべての添付ファイルとメモを取得します。
share ProcessManagementTaskService share 別のユーザーとタスクを共有します。 別のユーザーがタスクを要求して、タスクの所有者になることができます。
送る ProcessManagementTaskService 送る タスクを別のユーザーに転送します。
consult ProcessManagementTaskService consult 別のユーザーにタスクを問い合わせます。
claim ProcessManagementTaskService claim 共有キューで使用可能なタスクを要求します。
ロック解除 ProcessManagementTaskService ロック解除 タスクのロックを解除します。
ロック ProcessManagementTaskService ロック タスクをロックします。共有している場合は、別のユーザーがタスクを要求することはできません。
reject ProcessManagementTaskService reject タスクの前の所有者にタスクを返します。
離脱 ProcessManagementTaskService 離脱 タスクを削除します。
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 すべてのプロセスのリストを返します。
getRenitedProcesses ProcessManagementProcessService getRenitedProcesses ログインしたユーザーが参加したすべてのプロセス名のリストを返します。
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 getDirectReportTask ログインしたマネージャーの指定した直属のレポートのタスクを返します。
forwardTaskOfDirectReport ProcessManagementTeamTasksService forwardTaskOfDirectReport 直属のレポートのタスクを別のユーザーに転送します。
rejectTaskOfDirectReport ProcessManagementTeamTasksService rejectTaskOfDirectReport 直属のレポートのタスクを前のユーザーに返します。
getProperty WorkspacePropertyService getProperty ユーザーの Workspace プロパティを取得します。
removeProperty WorkspacePropertyService delete ユーザーの Workspace プロパティを削除します。
getProperties WorkspacePropertyService getPropertiesAsMap ユーザーのすべての Workspace プロパティを返します。
setProperty WorkspacePropertyService setProperty ユーザーの Workspace プロパティを設定します。
getCurrentUserImageUrl ProcessManagementClientSessionService getCurrentUserImageUrl ログインしたユーザーの画像 URL を取得します。
getUserImageUrl ProcessManagementClientSessionService getUserImageUrl 指定されたユーザーのユーザーの画像 URL を取得します。
uploadNote ProcessManagementDocumentHandlingService uploadNote タスクのメモをサーバーにアップロードします。
uploadRMAToServer （html テンプレートから直接呼び出すこともできます）
 ProcessManagementDocumentHandlingService uploadAttachment タスクの添付ファイルをサーバーにアップロードします。
getImageURL （html テンプレートから直接呼び出すこともできます） ProcessManagementDocumentHandlingService getImage プロセスの画像を取得します。

このページ