APIs in AEM Forms Workspace

Letzte Aktualisierung: 2023-12-19

Die folgenden APIs werden in AEM Forms Workspace verwendet.

JavaScript-Methode Service-Name API-Name Kommentare
getGroups ProcessManagementUserProxyService getGroups Sucht nach Gruppen. Gibt eine Liste aller Gruppen zurück, wenn kein Name angegeben ist. Andernfalls werden Gruppen mit dem angegebenen Namen zurückgegeben.
getUsersAndGroups ProcessManagementUserProxyService getUsersAndGroups Sucht nach Benutzenden und Gruppen. Gibt eine Liste aller Benutzenden und Gruppen zurück, wenn kein Name angegeben ist. Andernfalls werden Benutzende und Gruppen mit dem angegebenen Namen zurückgegeben.
prepareForSubmit ProcessManagementDocumentHandlingService prepareForSubmit Wird aufgerufen, bevor das Formular über DocumentSubmitServlet gesendet wird. Legt die Aufgaben-ID in einer Sitzungsvariablen fest (zusammen mit der Ablaufzeit), die beim tatsächlichen Senden abgerufen wird.
submitTask ProcessManagementDocumentHandlingService absenden Sendet das Dokumentobjekt, das einer Aufgabe zugeordnet ist (und damit einem Absendeprozess).
getRootEndpointCategories ProcessManagementStartpointService getRootEndpointCategories Ruft alle Stammkategorien ab, die auf dem Server vorhanden sind.
getDirectChildCategories ProcessManagementStartpointService getDirectChildCategories2 Ruft alle direkt untergeordneten Elemente für eine Kategorie ab.
getAllStartpoints ProcessManagementStartpointService getAllStartpoints Ruft alle Startpunkte ab, die auf dem Server in allen Kategorien vorhanden sind.
invokeStartpoint ProcessManagementStartpointService invokeStartpoint Dies ruft einen Startpunkt auf und erstellt eine Aufgabe, die einem Startpunkt zugeordnet ist.
getAllTasks ProcessManagementTaskService getAllActionableTasks Ruft alle Aufgaben auf, die für die angemeldete Person erstellt, weitergeleitet, verwendet, zugewiesen oder gespeichert werden.
getTask ProcessManagementTaskService getTask Ruft eine bestimmte Aufgabe ab.
renderTask ProcessManagementTaskService render Gibt eine Aufgabe wieder und gibt bei Bedarf Informationen zurück, die erforderlich sind, um das Formular zu rendern, wie Formular-URL, Formulartyp und Daten-URL.
submitWithPriorData ProcessManagementTaskService submitWithPriorData Gibt das Ergebnis der Submit-API von TaskManager mithilfe des Ergebnisschlüssels zurück.
submitWithData ProcessManagementTaskService submitWithData Sendet die mit der Aufgabe verknüpften Formulardaten (übergeben als Zeichenfolge) mithilfe der Submit-API von TaskManager. Wird für Flex-Formulare verwendet, die nicht die Submit-API von TaskManager aufrufen.
Speichern ProcessManagementTaskService Speichern Speichert eine Aufgabe auf dem Server.
complete ProcessManagementTaskService complete Schließt eine Aufgabe ab, die dann gemäß dem Prozess-Design an den nächsten Schritt übergeben wird.
getAttachment ProcessManagementTaskService getAttachment Gibt eine URL eines Anhangs zurück, unter der der Anhang verfügbar ist.
getAllAttachments ProcessManagementTaskService getAllActionableAttachments Ruft alle Anhänge und Hinweise für eine Aufgabe ab.
Netzwerkfreigabe, ProcessManagementTaskService Netzwerkfreigabe, Gibt eine Aufgabe für eine andere Person frei. Eine andere Person kann die Aufgabe anfordern und wird Eigentümerin bzw. Eigentümer der Aufgabe.
forward ProcessManagementTaskService forward Leitet eine Aufgabe an eine andere Person weiter.
consult ProcessManagementTaskService consult Stimmt eine Aufgabe mit einer anderen Person ab.
claim ProcessManagementTaskService claim Fordert eine Aufgabe an, die in einer freigegebenen Warteschlange verfügbar ist.
unlock ProcessManagementTaskService unlock Entsperrt eine Aufgabe.
lock ProcessManagementTaskService lock Sperrt eine Aufgabe, die dadurch von anderen Benutzenden nicht angefordert werden kann, wenn sie freigegeben wird.
Ablehnen der Bedingungen ProcessManagementTaskService Ablehnen der Bedingungen Gibt eine Aufgabe an die Person zurück, die zuvor deren Eigentümerin bzw. Eigentümer war.
abandon ProcessManagementTaskService abandon Löscht eine Aufgabe.
setVisibility ProcessManagementTaskService setVisibility Legt die Sichtbarkeit einer Aufgabe fest. Wenn die Sichtbarkeit auf „false“ gesetzt ist, ist die Aufgabe für die Person danach nicht mehr sichtbar.
getUsers ProcessManagementUserProxyService getUsers Wird für die Suche nach Benutzenden verwendet. Gibt alle Benutzenden zurück, wenn kein Name angegeben ist, sonst werden die Benutzenden mit dem angegebenen Namen zurückgegeben.
getUsersInGroup ProcessManagementUserProxyService getUsersInGroupByName Gibt alle Benutzenden in einer Gruppe zurück.
grantQueueAccess ProcessManagementQueueService grantQueueAccess Gewährt einer angegebenen Person Zugriff auf die Warteschlange der angemeldeten Person. Im Grunde wird dadurch Ihre eigene Warteschlange für eine andere Person freigegeben.
requestQueueAccess ProcessManagementQueueService requestQueueAccess Stellt für die angemeldete Person die Zugriffsanfrage für die Warteschlange einer bestimmten Person. Wenn die Person die Anfrage genehmigt, wird ihre Warteschlange für die angemeldete Person freigegeben.
getGrantedUsers ProcessManagementQueueService getGrantedUsers Gibt alle Benutzenden zurück, die Zugriff auf die Warteschlange der angemeldeten Person haben.
getUsersForAccessibleQueues ProcessManagementQueueService getUsersForAccessibleQueues Gibt alle Benutzenden zurück, deren Warteschlange für eine Person zugänglich ist.
cancelQueueAccess ProcessManagementQueueService cancelQueueAccess Entfernt eine Person aus der Liste der Benutzenden, die Zugriff auf die Warteschlange der angemeldeten Person haben.
removeQueueAccess ProcessManagementQueueService removeQueueAccess Entfernt eine Person aus der Liste der Benutzenden, deren Warteschlange für die angemeldete Person zugänglich ist.
getAllQueues
ProcessManagementQueueService
getAllQueues
Ruft alle Warteschlangen (eigene, freigegebene und Gruppenwarteschlangen) ab, die für die angemeldete Person zugänglich sind.
getOutOfOfficeSettings ProcessManagementOutOfOfficeService getOutOfOfficeSettings Ruft Abwesenheitseinstellungen einer Benutzerin oder eines Benutzers ab.
saveOutOfOfficeSettingsJson ProcessManagementOutOfOfficeService saveOutOfOfficeSettingsJson Speichert die Abwesenheitseinstellungen einer Benutzerin oder eines Benutzers.
getAllProcesses ProcessManagementProcessService getAllProcesses Gibt eine Liste aller Prozesse zurück.
getParticipatedProcesses ProcessManagementProcessService getParticipatedProcesses Gibt eine Liste aller Prozessnamen zurück, an denen die angemeldete Person beteiligt ist.
getProcessInstance
ProcessManagementProcessService
getProcessInstance
Ruft Details einer Prozessinstanz ab.
getProcessInstances ProcessManagementQueryService getProcessInstances Ruft alle Prozessinstanzen für einen Prozess ab.
getPendingTasksForProcessInstance ProcessManagementQueryService getPendingTasksForProcessInstance Ruft ausstehende Aufgaben für eine Prozessinstanz ab.
getTasksForProcessInstance ProcessManagementQueryService getTasksForProcessInstance Ruft alle Aufgaben für eine Prozessinstanz ab.
getAllSearchTemplates ProcessManagementQueryService getAllSearchTemplates Gibt eine Liste aller Suchvorlagen zurück.
getTemplate ProcessManagementQueryService getTemplate Gibt den Inhalt für eine Suchvorlage zurück.
findTasksJson
ProcessManagementQueryService findTasksJson Sucht und gibt alle Aufgaben zurück, die alle Bedingungen einer Suchvorlage erfüllen.
getAssignmentsForTask ProcessManagementTaskService getAssignmentsForTask Ruft alle Zuweisung für eine Aufgabe ab. Beispiel: Wenn eine Benutzerin oder ein Benutzer eine Aufgabe an eine andere Person weiterleitet oder sich mit ihr darüber abstimmt, dann handelt es sich dabei um eine Aufgabenzuweisung.
deleteAttachment TaskManagerService deleteAttachment Löscht einen Anhang.
initialize ProcessManagementClientSessionService initialize Erneuert die Assertion, falls erforderlich. Authentifiziert die Benutzerin bzw. den Benutzer. Legt Sitzungsparameter für Server-/Client-Informationen fest. Gibt Benutzerinformation und Abrufintervall zurück.
getTasksForDirectReports ProcessManagementTeamTasksService getTasksForDirectReports Gibt alle Aufgaben der Personen zurück, die dem angemeldeten Manager direkt unterstellt sind.
getTaskOfDirectReport
ProcessManagementTeamTasksService getDirectReportTask Gibt eine Aufgabe der angegebenen Person zurück, die dem angemeldeten Manager direkt unterstellt ist.
forwardTaskOfDirectReport ProcessManagementTeamTasksService forwardTaskOfDirectReport Leitet eine Aufgabe einer direkt unterstellten Person an eine andere Person weiter.
rejectTaskOfDirectReport ProcessManagementTeamTasksService rejectTaskOfDirectReport Gibt eine Aufgabe einer direkt unterstellten Person an die vorherige Person zurück.
getProperty WorkspacePropertyService getProperty Ruft eine Workspace-Eigenschaft für eine Person ab.
removeProperty WorkspacePropertyService Löschen Sie Löscht eine Workspace-Eigenschaft für eine Benutzerin bzw. einen Benutzer.
getProperties WorkspacePropertyService getPropertiesAsMap Gibt alle Workspace-Eigenschaften für eine Benutzerin bzw. einen Benutzer zurück.
setProperty WorkspacePropertyService setProperty Legt eine Workspace-Eigenschaft für eine Benutzerin bzw. einen Benutzer fest.
getCurrentUserImageUrl ProcessManagementClientSessionService getCurrentUserImageUrl Ruft die Bild-URL der Person für die angemeldete Person ab.
getUserImageUrl ProcessManagementClientSessionService getUserImageUrl Ruft die Bild-URL der Person für die angegebene Person ab.
uploadNote ProcessManagementDocumentHandlingService uploadNote Lädt eine Notiz für eine Aufgabe auf den Server hoch.
uploadRMAToServer (es wird auch direkt von der HTML-Vorlage aufgerufen)
ProcessManagementDocumentHandlingService uploadAttachment Lädt einen Anhang für eine Aufgabe auf den Server hoch.
getImageURL (wird auch direkt über die HTML-Vorlage aufgerufen) ProcessManagementDocumentHandlingService getImage Ruft das Bild für einen Prozess ab.

Auf dieser Seite