ドキュメントAEM 6.5ユーザーガイド

AEM Forms ワークスペースで使用する API apis-used-in-aem-forms-workspace

Last update: Wed Mar 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

AEM Forms ワークスペースでは次の 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 を呼び出さない Flex フォームに使用されます。
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
getDirectReportTask
ログインしたマネージャーの指定された直属の部下のタスクを返します。
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
プロセスの画像を取得します。
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2