APIs used in AEM Forms workspace

The following APIs are used in the AEM Forms workspace.

JavaScript Method Service Name API Name Comments
getGroups ProcessManagementUserProxyService getGroups Searches groups. it returns a list of all the groups if nothing specified, else returns groups with the specified name.
getUsersAndGroups ProcessManagementUserProxyService getUsersAndGroups Searches users and groups. It returns a list of all the users and groups if nothing specified, else returns users and groups with specified name.
prepareForSubmit ProcessManagementDocumentHandlingService prepareForSubmit It is called before submitting a form by way of DocumentSubmitServlet. It sets the task ID in a session variable (along with expiry time) which is retrieved during the actual submission.
submitTask ProcessManagementDocumentHandlingService submit It submits the document object associated with a task (and submit process in turn).
getRootEndpointCategories ProcessManagementStartpointService getRootEndpointCategories It fetches all root categories present on the server.
getDirectChildCategories ProcessManagementStartpointService getDirectChildCategories2 It fetches all direct children for a category.
getAllStartpoints ProcessManagementStartpointService getAllStartpoints It fetches all startpoints present on the server under all categories.
invokeStartpoint ProcessManagementStartpointService invokeStartpoint This invokes a Startpoint and creates a task corresponding to a starpoint
getAllTasks ProcessManagementTaskService getAllActionableTasks It fetches all tasks that are created and forwarded or consulted, saved, assigned, assigned, and saved for the logged in user.
getTask ProcessManagementTaskService getTask It fetches a specific task.
renderTask ProcessManagementTaskService render It renders a task and returns information needed to render the form like form url, form type, data url, if needed.
submitWithPriorData ProcessManagementTaskService submitWithPriorData It returns the result of TaskManager's submit API using the result key.
submitWithData ProcessManagementTaskService submitWithData It submits the form data (passed as string) associated with the task usingTaskManager's submit API. It is used for Flex forms which do not callTaskManager's submit API.
save ProcessManagementTaskService save It saves a task on the server.
complete ProcessManagementTaskService complete It completes a task and the task is passed to the next step as per process design.
getAttachment ProcessManagementTaskService getAttachment It returns a URL of an attachment where the attachment is available.
getAllAttachments ProcessManagementTaskService getAllActionableAttachments It fetches all attachments and notes for a task.
share ProcessManagementTaskService share It shares a task with another user. Another user can claim the task and becomes owner of the task.
forward ProcessManagementTaskService forward It forwards a task to another user.
consult ProcessManagementTaskService consult It consults a task with another user.
claim ProcessManagementTaskService claim It claims a task that is available in a shared queue.
unlock ProcessManagementTaskService unlock It unlocks a task.
lock ProcessManagementTaskService lock It locks a task and the task cannot be claimed by another user if shared.
reject ProcessManagementTaskService reject It returns a task to the previous owner of the task.
abandon ProcessManagementTaskService abandon It deletes a task.
setVisibility ProcessManagementTaskService setVisibility It sets visibility of a task. If visibility is set to false, the task is not visible to the user afterwards.
getUsers ProcessManagementUserProxyService getUsers It is used for searching users. It returns all users if no name is specified, or else it returns users with a specified name.
getUsersInGroup ProcessManagementUserProxyService getUsersInGroupByName It returns all users in a group.
grantQueueAccess ProcessManagementQueueService grantQueueAccess It grants access of the logged in user's queue to a specified user. It is basically sharing your own queue with another user.
requestQueueAccess ProcessManagementQueueService requestQueueAccess It makes the access request of a queue of a specified user for the logged in user. If the user approves the request, the user's queue is shared with the logged in user.
getGrantedUsers ProcessManagementQueueService getGrantedUsers It returns all users who have access to the queue of the logged in user.
getUsersForAccessibleQueues ProcessManagementQueueService getUsersForAccessibleQueues It returns all users whose queue is accessible to a user.
revokeQueueAccess ProcessManagementQueueService revokeQueueAccess It removes a user from the list of users who have access to the queue of the logged in user.
removeQueueAccess ProcessManagementQueueService removeQueueAccess It removes a user from the list of users whose queue is accessible to the logged in user.
It gets all queues (own, shared, and group queues) accessible to the logged in user.
getOutOfOfficeSettings ProcessManagementOutOfOfficeService getOutOfOfficeSettings It gets the out-of-office settings of a user.
saveOutOfOfficeSettingsJson ProcessManagementOutOfOfficeService saveOutOfOfficeSettingsJson It saves the out-of-office settings of a user.
getAllProcesses ProcessManagementProcessService getAllProcesses It returns a list of all the processes.
getParticipatedProcesses ProcessManagementProcessService getParticipatedProcesses It returns a list of all the process names participated by the logged in user.
It fetches details of a process instance.
getProcessInstances ProcessManagementQueryService getProcessInstances It fetches all process instances for a process.
getPendingTasksForProcessInstance ProcessManagementQueryService getPendingTasksForProcessInstance It gets pending tasks for a process instance.
getTasksForProcessInstance ProcessManagementQueryService getTasksForProcessInstance It gets all tasks for a process instance.
getAllSearchTemplates ProcessManagementQueryService getAllSearchTemplates It returns a list of all the search templates.
getTemplate ProcessManagementQueryService getTemplate It returns content for a search template.
ProcessManagementQueryService findTasksJson It searches and returns all the tasks that satisfy all the conditions of a search template.
getAssignmentsForTask ProcessManagementTaskService getAssignmentsForTask It gets all assignments for a task. For example, if a user forwards or consults a task with another user, then it is an assignment for a task.
deleteAttachment TaskManagerService deleteAttachment It deletes an attachment.
initialize ProcessManagementClientSessionService initialize It renews the assertion if necessary. Authenticates user. Sets session parameters for server / client information. Returns user information and polling interval.
getTasksForDirectReports ProcessManagementTeamTasksService getTasksForDirectReports It returns all the tasks of direct reports of the logged in manager.
ProcessManagementTeamTasksService getDirectReportTask It returns a task of a specified direct report of the logged in manager.
forwardTaskOfDirectReport ProcessManagementTeamTasksService forwardTaskOfDirectReport It forwards a task of a direct report to another user.
rejectTaskOfDirectReport ProcessManagementTeamTasksService rejectTaskOfDirectReport It returns a task of a direct report to the previous user.
getProperty WorkspacePropertyService getProperty It gets a Workspace property for a user.
removeProperty WorkspacePropertyService delete It removes a Workspace property for a user.
getProperties WorkspacePropertyService getPropertiesAsMap It returns all Workspace properties for a user.
setProperty WorkspacePropertyService setProperty It sets a Workspace property for a user.
getCurrentUserImageUrl ProcessManagementClientSessionService getCurrentUserImageUrl It gets the user's image URL for the logged in user.
getUserImageUrl ProcessManagementClientSessionService getUserImageUrl It gets the user's image URL for the specified user.
uploadNote ProcessManagementDocumentHandlingService uploadNote It uploads a note on the server for a task.
uploadRMAToServer (It's also called directly from html template)
ProcessManagementDocumentHandlingService uploadAttachment It uploads an attachment on the server for a task.
getImageURL (Also called directly from the HTML template) ProcessManagementDocumentHandlingService getImage It gets the image for a process.

On this page