Freigeben über

Agilite (Vorschau)

Mit Agilit-e können Sie Ihre Geschäftslogik und -prozesse zentralisieren und als Microservices für neue oder vorhandene Anwendungen verfügbar machen. Mit dem Agilit-e Connector erhalten Sie Zugriff auf viele Dienste wie Business Process Management (BPM), Rollen, Schlüsselwörter, Vorlagen und vieles mehr.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Agilit-e Support-Team
URL https://agilite.io
Email support@agilite.io
Connectormetadaten
Herausgeber Agilit-e
Webseite https://agilite.io
Datenschutzrichtlinie https://agilite.io/privacy-policy/

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Freigabefähig

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumente

Name Typ Description Erforderlich
Geben Sie die URL des Agilit-e-API-Servers an. (Verwenden Von "https://api.agilite.io" für Agilit-e Cloud) Schnur Geben Sie die URL des Agilit-e-API-Servers an. (Verwenden Von "https://api.agilite.io" für Agilit-e Cloud) Richtig
API-Schlüssel (generiert in 'https://portal.agilite.io' unter Verwaltung) securestring API-Schlüssel (generiert in 'https://portal.agilite.io' unter Verwaltung) Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen nach Profilschlüssel (BPM)

Holen Sie sich das vollständige BPM-Profil mit Konfiguration und Optionen für den Prozess.
Beschriftung nach Wert abrufen (Schlüsselwörter)

Gibt eine Schlüsselwortbeschriftung basierend auf dem bereitgestellten 'Profilschlüssel' und 'Wertschlüssel' zurück.
BPM Record registrieren (BPM)

Registrieren Sie neuen BPM-Eintrag. Der Datensatz wird einer Datensatz-ID zugewiesen, die für den Datensatzlebenszyklus verwendet wird, um den Datensatz zu identifizieren, den Fortschritt, den Verlauf und den Status jederzeit zu identifizieren.
Datensatzstatus abrufen (BPM)

Abrufen des BPM-Datensatzstatus für einen oder mehrere Datensätze, um den aktuellen Status einzuschließen, der für den Datensatz verantwortlich ist, den Workflowverlauf und andere Informationen, um den aktuellen Status und die Regeln für den Datensatz zu beschreiben
Execute (BPM)

Sendet eine Option im aktuellen Workflowschritt. Abhängig von den Geschäftsregeln wird der Datensatz zum nächsten Schritt im Prozess ausgeführt und Gibt Informationen zum nächsten Schritt an die aufrufende API zurück.
Execute (Vorlagen)

Verarbeitet und gibt eine Vorlage von Agilit-e basierend auf dem bereitgestellten "Profilschlüssel" zurück.
Generieren einer Zahl (Nummerierung)

Generiert eine eindeutige Nummer basierend auf dem bereitgestellten Profilschlüssel.
Nach Profilschlüssel abrufen (Schlüsselwörter)

Gibt Schlüssel-Wert-Paare eines bestimmten Schlüsselwortprofils basierend auf dem bereitgestellten "Profilschlüssel" zurück.
Profilschlüssel nach Gruppe abrufen (Schlüsselwörter)

Gibt alle Schlüssel des Schlüsselwortprofils basierend auf dem bereitgestellten "Gruppennamen" zurück.
Rolle abrufen (Rollen)

Rufen Sie verantwortliche Personen ab, die Rollen im Agilit-e-Verwaltungsportal zugewiesen sind. Diese Rollen sind nicht nur für bestimmte Datensätze oder Geschäftsprozesse relevant und werden in der Regel für unternehmensweite Rollen in der Organisation verwendet.
Rolle zuweisen (Rollen)

Weisen Sie einem bestimmten Datensatz eine vom Benutzer angegebene Rolle zu. Ein Beispiel hierfür wäre ein Dokumentprüfer oder ein Genehmigenden verlassen
Wert nach Beschriftung abrufen (Schlüsselwörter)

Gibt einen Schlüsselwortwert basierend auf dem bereitgestellten 'Profilschlüssel' und 'Bezeichnungsschlüssel' zurück.
Zugewiesene Rollen abrufen (Rollen)

Abrufen von verantwortlichen Personen für zuvor zugewiesene Rollen für einen bestimmten Datensatz

Abrufen nach Profilschlüssel (BPM)

Vorgangs-ID:
getBPMByProfileKey

Holen Sie sich das vollständige BPM-Profil mit Konfiguration und Optionen für den Prozess.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Profilschlüssel
 profile-key True string

Eindeutiger Schlüssel für das zielorientierte Profil

Gibt zurück

Body
GetBPMProfile

Beschriftung nach Wert abrufen (Schlüsselwörter)

Vorgangs-ID:
getKeywordsLabelByValue

Gibt eine Schlüsselwortbeschriftung basierend auf dem bereitgestellten 'Profilschlüssel' und 'Wertschlüssel' zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Profilschlüssel
 profile-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
Wertschlüssel
 value-key True string

Der Wertschlüssel in der Bezeichnung/Wertauflistung für das Zielprofil

Gibt zurück

Body
StdJSONResponse

BPM Record registrieren (BPM)

Vorgangs-ID:
registerBPMRecord

Registrieren Sie neuen BPM-Eintrag. Der Datensatz wird einer Datensatz-ID zugewiesen, die für den Datensatzlebenszyklus verwendet wird, um den Datensatz zu identifizieren, den Fortschritt, den Verlauf und den Status jederzeit zu identifizieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Prozessschlüssel
 process-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
Aktueller Benutzer
 current-user True string

Die E-Mail-Adresse des Benutzers, der den Datensatz registriert. Dies ist in der Regel der Benutzer, der zum Zeitpunkt des Aufrufs der API angemeldet ist.

Gibt zurück

Body
RegisterBPMRecord

Datensatzstatus abrufen (BPM)

Vorgangs-ID:
getBPMRecordState

Abrufen des BPM-Datensatzstatus für einen oder mehrere Datensätze, um den aktuellen Status einzuschließen, der für den Datensatz verantwortlich ist, den Workflowverlauf und andere Informationen, um den aktuellen Status und die Regeln für den Datensatz zu beschreiben

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Prozessschlüssel
 process-keys string

Filtern Sie, um die Geschäftsprozesse(en) zu identifizieren, für die Datensätze zurückgegeben werden. Dieser Schlüssel befindet sich im BPM-Profil im Agilit-e Admin Portal - (getrennt mit Kommas)
BPM-Datensatz-IDs
 bpm-record-ids string

filter to return records with specific recordIds. The recordId is registered by the registerBPMRecord api for new records and can be found in the recordID property of the BPM api responses - (separate using commas)
Schrittnamen
 step-names string

Filtern, um nur Datensätze zurückzugeben, die sich derzeit an den angegebenen Workflowschritten befinden – (getrennt mit Kommas)
Verantwortungsvolle Benutzer
 responsible-users string

Filtern, um nur Datensätze zurückzugeben, die derzeit der angegebenen E-Mail-Adresse (es) zugewiesen sind ( getrennt durch Kommas)
Relevante Benutzer
 relevant-users string

Filtern, um nur Datensätze zurückzugeben, die für die angegebene E-Mail-Adresse (es) relevant sind – (getrennt mit Kommas)
Verlauf einschließen
 include-history boolean

Geben Sie an, ob das Verlaufsobjekt mit den Datensatzstatusinformationen zurückgegeben werden soll.
Schrittoptionen einschließen
 include-step-options boolean

Geben Sie an, ob das Schrittoptionenobjekt mit den Datensatzstatusinformationen zurückgegeben werden soll.
Sichtbare Objekte einschließen
 include-visible-objects boolean

Geben Sie an, ob das sichtbare Objekt mit den Datensatzstatusinformationen zurückgegeben werden soll.

Gibt zurück

Gegenstände
GetBPMRecordState

Execute (BPM)

Vorgangs-ID:
executeBPM

Sendet eine Option im aktuellen Workflowschritt. Abhängig von den Geschäftsregeln wird der Datensatz zum nächsten Schritt im Prozess ausgeführt und Gibt Informationen zum nächsten Schritt an die aufrufende API zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Prozessschlüssel
 process-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
BPM-Datensatz-ID
 bpm-record-id True string

Gibt den Datensatz an, der übermittelt wird. Die ID wird von der registerBPMRecord-API für neue Datensätze registriert und kann in der RecordID-Eigenschaft der BPM-API-Antworten gefunden werden.
Option ausgewählt
 option-selected True string

Gibt die Option an, die vom Benutzer als Teil des Übermittlungsprozesses ausgeführt werden soll. Dieser Wert muss einer gültigen Schrittoption im Workflowprofil entsprechen.
Aktueller Benutzer
 current-user True string

Die E-Mail-Adresse des Benutzers, der den BPM-Schritt übermittelt. Dies ist in der Regel der Benutzer, der zum Zeitpunkt des Aufrufs der API angemeldet ist.
Workflowschrittkommentare
 comments string

Übergibt Kommentare an den Ausführungsprozess, der in den Workflowverlauf gestempelt wird. Dies wird in der Regel verwendet, wenn der Benutzer einen Schritt ablehnt oder weitere Informationen anfordert.
object

Gibt zurück

Body
ExecuteBPMResult

Execute (Vorlagen)

Vorgangs-ID:
executeTemplates

Verarbeitet und gibt eine Vorlage von Agilit-e basierend auf dem bereitgestellten "Profilschlüssel" zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Profilschlüssel
 profile-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
object

Gibt zurück

Body
StdJSONResponse

Generieren einer Zahl (Nummerierung)

Vorgangs-ID:
generateNumber

Generiert eine eindeutige Nummer basierend auf dem bereitgestellten Profilschlüssel.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Profilschlüssel
 profile-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
object

Gibt zurück

Body
StdJSONResponse

Nach Profilschlüssel abrufen (Schlüsselwörter)

Vorgangs-ID:
getKeywordsByProfileKey

Gibt Schlüssel-Wert-Paare eines bestimmten Schlüsselwortprofils basierend auf dem bereitgestellten "Profilschlüssel" zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Profilschlüssel
 profile-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
Sortieren
 sort string

Ein optionaler Parameter zum Sortieren des zurückgegebenen Schlüssel-/Wertergebnisses

Gibt zurück

Gegenstände
KeywordValues

Profilschlüssel nach Gruppe abrufen (Schlüsselwörter)

Vorgangs-ID:
getKeywordProfileKeysByGroup

Gibt alle Schlüssel des Schlüsselwortprofils basierend auf dem bereitgestellten "Gruppennamen" zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppenname
 group-name True string

Der Gruppenname, der zum Gruppieren von Schlüsselwortprofilen verwendet wird
Sortieren
 sort string

Ein optionaler Parameter zum Sortieren des zurückgegebenen Schlüssel-/Wertergebnisses

Gibt zurück

Name Pfad Typ Beschreibung
array of string

Rolle abrufen (Rollen)

Vorgangs-ID:
getRole

Rufen Sie verantwortliche Personen ab, die Rollen im Agilit-e-Verwaltungsportal zugewiesen sind. Diese Rollen sind nicht nur für bestimmte Datensätze oder Geschäftsprozesse relevant und werden in der Regel für unternehmensweite Rollen in der Organisation verwendet.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Rollennamen
 role-names True string

Geben Sie die Rollennamen an, für die Sie die verantwortlichen Benutzer abrufen möchten – (getrennt mit Kommas)
Bedingte Ebenen
 conditional-levels string

Geben Sie zusätzliche Ebenen an, die verwendet werden können, um die richtige Person für die Rolle zu bestimmen. Ein Beispiel für eine Ebene kann ein Abteilungsname sein (wenn Sie den Abteilungsleiter abrufen möchten) oder einen Produktnamen (wenn Sie den Product Manager abrufen möchten) – (getrennt mit Kommas)

Gibt zurück

Name Pfad Typ Beschreibung
responsibleUsers
 responsibleUsers array of string

responsibleUsers

Rolle zuweisen (Rollen)

Vorgangs-ID:
assignRole

Weisen Sie einem bestimmten Datensatz eine vom Benutzer angegebene Rolle zu. Ein Beispiel hierfür wäre ein Dokumentprüfer oder ein Genehmigenden verlassen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Prozessschlüssel
 process-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
BPM-Datensatz-ID
 bpm-record-id True string

Gibt den Datensatz an, für den die Rolle festgelegt wird. Die ID wird von der registerBPMRecord-API für neue Datensätze registriert und kann in der RecordID-Eigenschaft der BPM-API-Antworten gefunden werden.
Aktueller Benutzer
 current-user True string

Die E-Mail-Adresse des Benutzers, der die Rolle festlegt. Dies ist in der Regel der Benutzer, der zum Zeitpunkt des Aufrufs der API angemeldet ist.
Rollenname
 role-name True string

Der Name der Rolle, die zugewiesen wird. Z. B. Genehmigende Person oder Bearbeiter
Verantwortungsvolle Benutzer
 responsible-users True string

Die E-Mail-Adressen der Benutzer, denen diese Rolle zugewiesen ist – (getrennt durch Kommas)

Gibt zurück

Daten

Daten
object

Wert nach Beschriftung abrufen (Schlüsselwörter)

Vorgangs-ID:
getKeywordsValueByLabel

Gibt einen Schlüsselwortwert basierend auf dem bereitgestellten 'Profilschlüssel' und 'Bezeichnungsschlüssel' zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Profilschlüssel
 profile-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
Beschriftungsschlüssel
 label-key True string

Der Bezeichnungsschlüssel in der Bezeichnungs-/Wertauflistung für das zielorientierte Profil

Gibt zurück

Body
StdJSONResponse

Zugewiesene Rollen abrufen (Rollen)

Vorgangs-ID:
getAssignedRoles

Abrufen von verantwortlichen Personen für zuvor zugewiesene Rollen für einen bestimmten Datensatz

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Prozessschlüssel
 process-key True string

Eindeutiger Schlüssel für das zielorientierte Profil
BPM-Datensatz-ID
 bpm-record-id True string

Gibt den Datensatz an, für den die Rolle festgelegt wird. Die ID wird von der registerBPMRecord-API für neue Datensätze registriert und kann in der RecordID-Eigenschaft der BPM-API-Antworten gefunden werden.
Rollenname
 role-names True string

Die rolle(n), die abgefragt werden soll (getrennt mit Kommas)

Gibt zurück

Name Pfad Typ Beschreibung
array of object
Name
 name string
Benutzer
 users array of object
Email
 users.email string

Definitionen

ExecuteBPMResult

Name Pfad Typ Beschreibung
Beschreibung des Prozessschritts
 description string

Eine kurze Beschreibung, in der der Prozessschritt erläutert wird
SLA-Dauer (Stunden)
 duration string

Die SLA-Dauer in Stunden. Geben Sie einen Wert von 0 an, falls nicht zutreffend.
Prozessschritt-Ereignisstempel
 eventStamp string

Ein Ereignisstempel für den aktuellen Prozessschritt
Schrittanweisungen
 instructions string

Anweisungen für verantwortungsvolle Benutzer während des Schritts
Prozessschrittschlüssel
 key string

Ein eindeutiger Schlüssel zum Identifizieren des Prozessschritts
Prozessschrittname
 name string

Ein kurzer Name für den Prozessschritt
BPM-Profilschlüssel
 processKey string

Ein eindeutiger Schlüssel zum Identifizieren des BPM-Profils
Prozessphase
 processStage string

Ein Schlüssel, der die Prozessstufe des aktuellen Schritts definiert
Verantwortungstyp
 responsibility string

Benutzer-/Rollenbasierte Verantwortung
Verantwortungsvolle Rolle des Prozessschritts
 responsibleRole string

Die Rolle, die für den aktuellen Prozessschritt verantwortlich ist
Prozessschritt verantwortungsvolle Benutzer
 responsibleUsers array of string

Die für den aktuellen Prozessschritt verantwortlichen Benutzer
stepOptions
 stepOptions array of object
Beschreibung der Schrittoption
 stepOptions.description string

Eine kurze Beschreibung, in der die Schrittoption erläutert wird
Schrittoptionsereignisstempel
 stepOptions.eventStamp array of string

Ein Ereignisstempel für die aktuelle Schrittoption
Schrittoptionsname
 stepOptions.name string

Ein kurzer Name für die Option "Schritt"
Nächster Schritt
 stepOptions.nextStep string

Im nächsten Schritt wird der Geschäftsprozess weitergeleitet. Leer lassen, wenn keine weiteren Schritte ausgeführt werden
Schrittoptionshinweise
 stepOptions.notes string

Optionale Notizen für Schrittoption
visibleObjects
 stepOptions.visibleObjects array of object
Step Option-Objekt-ID
 stepOptions.visibleObjects.id string

Die ID der Komponente, auf die in der Benutzeroberfläche verwiesen wird
choices
 stepOptions.visibleObjects.inputOptions.choices array of object
Auswahltypbezeichnung
 stepOptions.visibleObjects.inputOptions.choices.label string

Eine Beschriftung für die ausgewählte Auswahl
Auswahltypwert
 stepOptions.visibleObjects.inputOptions.choices.value string

Ein Wert für die ausgewählte Auswahl
Bezeichnung für Eingabeoptionen
 stepOptions.visibleObjects.inputOptions.label string

Eine Bezeichnung, die das Eingabefeld oder die bearbeitbare Komponente definiert
Eingabeoptionennachrichten
 stepOptions.visibleObjects.inputOptions.messages array of string

Meldungen, die verwendet werden sollen, wenn die Überprüfung der Eingabeoptionen fehlschlägt
Eingabeoptionentyp
 stepOptions.visibleObjects.inputOptions.type string

Definiert den Typ des zu verwendenden Eingabefelds oder der bearbeitbaren Komponente.
Is Step Option Object Editable
 stepOptions.visibleObjects.isEditable boolean

Ist die Komponente, auf die verwiesen wird, für benutzereingaben bearbeitbar
Ist Step Option-Objekt obligatorisch
 stepOptions.visibleObjects.isMandatory boolean

Erfordert die Komponente, auf die verwiesen wird, benutzereingaben
visibleObjects
 visibleObjects array of object
Process Step-Objekt-ID
 visibleObjects.id string

Die ID der Komponente, auf die in der Benutzeroberfläche verwiesen wird
choices
 visibleObjects.inputOptions.choices array of object
Auswahltypbezeichnung
 visibleObjects.inputOptions.choices.label string

Eine Beschriftung für die ausgewählte Auswahl
Auswahltypwert
 visibleObjects.inputOptions.choices.value string

Ein Wert für die ausgewählte Auswahl
Bezeichnung für Eingabeoptionen
 visibleObjects.inputOptions.label string

Eine Bezeichnung, die das Eingabefeld oder die bearbeitbare Komponente definiert
Eingabeoptionennachrichten
 visibleObjects.inputOptions.messages array of string

Meldungen, die verwendet werden sollen, wenn die Überprüfung der Eingabeoptionen fehlschlägt
Eingabeoptionentyp
 visibleObjects.inputOptions.type string

Definiert den Typ des zu verwendenden Eingabefelds oder der bearbeitbaren Komponente.
Ist Process Step-Objekt bearbeitbar
 visibleObjects.isEditable boolean

Ist die Komponente, auf die verwiesen wird, für benutzereingaben bearbeitbar
Ist Process Step-Objekt obligatorisch
 visibleObjects.isMandatory boolean

Erfordert die Komponente, auf die verwiesen wird, benutzereingaben

GetBPMProfile

Name Pfad Typ Beschreibung
appAdmin
 appAdmin array of object
App-Administrator-E-Mail
 appAdmin.email string

Eine E-Mail-Adresse für den Administrator des aktuellen BPM-Profils
BPM-App-URL
 appUrl string

Eine optionale URL für die App, die das aktuelle BPM-Profil verwendet
BPM-Profilbeschreibung
 description string

Eine kurze Beschreibung, in der das BPM-Profil erläutert wird
BPM-Profilgruppenname
 groupName string

Eine optionale Gruppierung für das BPM-Profil
BPM-Profilschlüssel
 key string

Ein eindeutiger Schlüssel zum Identifizieren des BPM-Profils
BPM-Profilname
 name string

Ein kurzer Name für das BPM-Profil
BPM-Profilnotizen
 notes string

Optionale Hinweise für BPM-Profil
processSteps
 processSteps array of object
Beschreibung des Prozessschritts
 processSteps.description string

Eine kurze Beschreibung, in der der Prozessschritt erläutert wird
SLA-Dauer (Stunden)
 processSteps.duration string

Die SLA-Dauer in Stunden. Geben Sie einen Wert von 0 an, falls nicht zutreffend.
Ist der erste Schritt
 processSteps.firstStep boolean

Geben Sie an, ob der Prozessschritt-Datensatz der erste Schritt im Geschäftsprozess ist.
Schrittanweisungen
 processSteps.instructions string

Anweisungen für verantwortungsvolle Benutzer während des Schritts
Prozessschrittschlüssel
 processSteps.key string

Ein eindeutiger Schlüssel zum Identifizieren des Prozessschritts
Prozessschrittname
 processSteps.name string

Ein kurzer Name für den Prozessschritt
Prozessphase
 processSteps.processStage string

Ein Schlüssel, der die Prozessstufe des aktuellen Schritts definiert
Prozessschritt-Referenz-URL
 processSteps.referenceUrl string

Eine Referenz-URL für den Prozessschritt
Verantwortungstyp
 processSteps.responsibility string

Benutzer-/Rollenbasierte Verantwortung
Verantwortungsvolle Rolle des Prozessschritts
 processSteps.responsibleRole string

Die für den aktuellen Schritt zuständige Rolle
roleLevels
 processSteps.roleLevels array of string

Bedingte Rollenebenen
stepOptions
 processSteps.stepOptions array of object
Beschreibung der Schrittoption
 processSteps.stepOptions.description string

Eine kurze Beschreibung, in der die Schrittoption erläutert wird
Schrittoptionsname
 processSteps.stepOptions.name string

Ein kurzer Name für die Option "Schritt"
Nächster Schritt
 processSteps.stepOptions.nextStep string

Im nächsten Schritt wird der Geschäftsprozess weitergeleitet. Leer lassen, wenn keine weiteren Schritte ausgeführt werden
Schrittoptionshinweise
 processSteps.stepOptions.notes string

Optionale Notizen für Schrittoption
visibleObjects
 processSteps.stepOptions.visibleObjects array of object
Step Option-Objekt-ID
 processSteps.stepOptions.visibleObjects.id string

Die ID der Komponente, auf die in der Benutzeroberfläche verwiesen wird
choices
 processSteps.stepOptions.visibleObjects.inputOptions.choices array of object
Auswahltypbezeichnung
 processSteps.stepOptions.visibleObjects.inputOptions.choices.label string

Eine Beschriftung für die ausgewählte Auswahl
Auswahltypwert
 processSteps.stepOptions.visibleObjects.inputOptions.choices.value string

Ein Wert für die ausgewählte Auswahl
Bezeichnung für Eingabeoptionen
 processSteps.stepOptions.visibleObjects.inputOptions.label string

Eine Bezeichnung, die das Eingabefeld oder die bearbeitbare Komponente definiert
Eingabeoptionennachrichten
 processSteps.stepOptions.visibleObjects.inputOptions.messages array of string

Meldungen, die verwendet werden sollen, wenn die Überprüfung der Eingabeoptionen fehlschlägt
Eingabeoptionentyp
 processSteps.stepOptions.visibleObjects.inputOptions.type string

Definiert den Typ des zu verwendenden Eingabefelds oder der bearbeitbaren Komponente.
Is Step Option Object Editable
 processSteps.stepOptions.visibleObjects.isEditable boolean

Ist die Komponente, auf die verwiesen wird, für benutzereingaben bearbeitbar
Ist Step Option-Objekt obligatorisch
 processSteps.stepOptions.visibleObjects.isMandatory boolean

Erfordert die Komponente, auf die verwiesen wird, benutzereingaben
visibleObjects
 processSteps.visibleObjects array of object
Process Step-Objekt-ID
 processSteps.visibleObjects.id string

Die ID der Komponente, auf die in der Benutzeroberfläche verwiesen wird
choices
 processSteps.visibleObjects.inputOptions.choices array of object
Auswahltypbezeichnung
 processSteps.visibleObjects.inputOptions.choices.label string

Eine Beschriftung für die ausgewählte Auswahl
Auswahltypwert
 processSteps.visibleObjects.inputOptions.choices.value string

Ein Wert für die ausgewählte Auswahl
Bezeichnung für Eingabeoptionen
 processSteps.visibleObjects.inputOptions.label string

Eine Bezeichnung, die das Eingabefeld oder die bearbeitbare Komponente definiert
Eingabeoptionennachrichten
 processSteps.visibleObjects.inputOptions.messages array of string

Meldungen, die verwendet werden sollen, wenn die Überprüfung der Eingabeoptionen fehlschlägt
Eingabeoptionentyp
 processSteps.visibleObjects.inputOptions.type string

Definiert den Typ des zu verwendenden Eingabefelds oder der bearbeitbaren Komponente.
Ist Process Step-Objekt bearbeitbar
 processSteps.visibleObjects.isEditable boolean

Ist die Komponente, auf die verwiesen wird, für benutzereingaben bearbeitbar
Ist Process Step-Objekt obligatorisch
 processSteps.visibleObjects.isMandatory boolean

Erfordert die Komponente, auf die verwiesen wird, benutzereingaben
BPM-Profilreferenz-URL
 referenceUrl string

Eine optionale URL, auf die für das aktuelle BPM-Profil verwiesen werden kann

GetBPMRecordState

Name Pfad Typ Beschreibung
Beschreibung des Prozessschritts
 description string

Eine kurze Beschreibung, in der der Prozessschritt erläutert wird
SLA-Dauer (Stunden)
 duration string

Die SLA-Dauer in Stunden. Geben Sie einen Wert von 0 an, falls nicht zutreffend.
eventStampHistory
 eventStampHistory array of object
Ereignisstempelverlaufsname
 eventStampHistory.eventName string

Name des Ereignisstempels
Zeitstempel des Ereignisstempelverlaufs
 eventStampHistory.timeStamp date-time

Der Zeitstempel, zu dem der Ereignisstempel aufgetreten ist
history
 history array of object
Verlaufskommentare
 history.comments string

Optionale Kommentare, die zum Zeitpunkt der Erstellung des Verlaufseintrags hinzugefügt wurden
Aktuelle Rolle "Verlauf"
 history.currentRole string

Die aktuelle Rolle zum Zeitpunkt des Verlaufseintrags
Verlauf aktueller Benutzer
 history.currentUser string

Der aktuelle Benutzer zum Zeitpunkt des Verlaufseintrags
Schrittdauer
 history.duration string

Die Zeit (in Minuten) des Datensatzes im aktuellen Prozessschritt vor der Aktion
Verlaufsereignisstempel
 history.eventStamp array of string

Ereignisstempel, die zum Zeitpunkt des Verlaufseintrags aufgetreten sind
Von Schritt zu Schritt
 history.fromStep string

Der Schlüssel des Prozessschritts, aus dem der BPM-Eintrag zum Zeitpunkt des Verlaufseintrags stammt.
Aus Schrittname
 history.fromStepName string

Der Name des Prozessschritts, aus dem der BPM-Eintrag zum Zeitpunkt des Verlaufseintrags stammt.
Option "Verlauf" ausgewählt
 history.optionSelected string

Die Option, die beim Ausführen des BPM-Eintrags ausgewählt wurde
BPM-Prozessschlüssel der Geschichte
 history.processKey string

Der eindeutige BPM-Prozessschlüssel für den Verlaufseintrag
Verlaufsprozessphase
 history.processStage string

Die Prozessphase zum Zeitpunkt des Verlaufseintrags
BPM-Datensatz-ID des Verlaufs
 history.recordId string

Die Datensatz-ID für den BPM-bezogenen Datensatz, der während des Prozess "BPM-Datensatz registrieren" generiert wurde.
Verantwortungsvolle Rolle des Verlaufs
 history.responsibleRole string

Die verantwortungsvolle Rolle des BPM Record zum Zeitpunkt des Verlaufseintrags
Verlauf verantwortlicher Benutzer
 history.responsibleUsers array of string

Verantwortliche Benutzer zum Zeitpunkt des Verlaufseintrags
Übermittlungsdatum des Verlaufs
 history.submissionDate date-time

Das Datum/die Uhrzeit, zu dem der BPM-Eintrag ausgeführt wurde
So verarbeiten Sie die Phase
 history.toProcessStage string

Die Prozessstufe für den BPM-Eintrag zum Zeitpunkt des Verlaufseintrags
In Schritt
 history.toStep string

Der Schlüssel des Prozessschritts für den BPM-Eintrag zum Zeitpunkt des Verlaufseintrags
In Schrittname
 history.toStepName string

Der Name des Prozessschritts für den BPM-Eintrag zum Zeitpunkt des Verlaufseintrags
Schrittanweisungen
 instructions string

Anweisungen für verantwortungsvolle Benutzer während des Schritts
Prozessschrittschlüssel
 key string

Ein eindeutiger Schlüssel zum Identifizieren des Prozessschritts
Prozessschrittname
 name string

Ein kurzer Name für den Prozessschritt
BPM-Profilschlüssel
 processKey string

Ein eindeutiger Schlüssel zum Identifizieren des BPM-Profils
Prozessphase
 processStage string

Ein Schlüssel, der die Prozessstufe des aktuellen Schritts definiert
BPM-Datensatz-ID
 recordId string

Die vom BPM-Modul generierte Datensatz-ID beim Registrieren eines BPM-Eintrags
BPM-Datensatzreferenz
 recordRef string

Eine lesbare Zahl, die vom BPM-Modul mithilfe des Nummerierungsmoduls beim Registrieren eines BPM-Eintrags generiert wird
Prozessschritt-Referenz-URL
 referenceUrl string

Eine Referenz-URL für den Prozessschritt
Verantwortungsvolle Rolle des Prozessschritts
 responsibleRole string

Die für den aktuellen Schritt zuständige Rolle
Prozessschritt verantwortungsvolle Benutzer
 responsibleUsers array of string

Verantwortliche Benutzer für den aktuellen Prozessschritt
roles
 roles array of object
Rollenname
 roles.name string

Name der Rolle
Nutzer
 roles.users array of object
Rollen-E-Mail
 roles.users.email string

Mit dem Rollennamen verknüpfte E-Mail-Adresse(en)
stepOptions
 stepOptions array of object
Beschreibung der Schrittoption
 stepOptions.description string

Eine kurze Beschreibung, in der die Schrittoption erläutert wird
Schrittoptionsereignisstempel
 stepOptions.eventStamp array of string

Ein Ereignisstempel für die aktuelle Schrittoption
Schrittoptionsname
 stepOptions.name string

Ein kurzer Name für die Option "Schritt"
Nächster Schritt
 stepOptions.nextStep string

Im nächsten Schritt wird der Geschäftsprozess weitergeleitet. Leer lassen, wenn keine weiteren Schritte ausgeführt werden
Schrittoptionshinweise
 stepOptions.notes string

Optionale Notizen für Schrittoption
visibleObjects
 stepOptions.visibleObjects array of object
Step Option-Objekt-ID
 stepOptions.visibleObjects.id string

Die ID der Komponente, auf die in der Benutzeroberfläche verwiesen wird
choices
 stepOptions.visibleObjects.inputOptions.choices array of object
Auswahltypbezeichnung
 stepOptions.visibleObjects.inputOptions.choices.label string

Eine Beschriftung für die ausgewählte Auswahl
Auswahltypwert
 stepOptions.visibleObjects.inputOptions.choices.value string

Ein Wert für die ausgewählte Auswahl
Bezeichnung für Eingabeoptionen
 stepOptions.visibleObjects.inputOptions.label string

Eine Bezeichnung, die das Eingabefeld oder die bearbeitbare Komponente definiert
Eingabeoptionennachrichten
 stepOptions.visibleObjects.inputOptions.messages array of string

Meldungen, die verwendet werden sollen, wenn die Überprüfung der Eingabeoptionen fehlschlägt
Eingabeoptionentyp
 stepOptions.visibleObjects.inputOptions.type string

Definiert den Typ des zu verwendenden Eingabefelds oder der bearbeitbaren Komponente.
Is Step Option Object Editable
 stepOptions.visibleObjects.isEditable boolean

Ist die Komponente, auf die verwiesen wird, für benutzereingaben bearbeitbar
Ist Step Option-Objekt obligatorisch
 stepOptions.visibleObjects.isMandatory boolean

Erfordert die Komponente, auf die verwiesen wird, benutzereingaben
In Schritt übermittelt
 submittedIntoStep date-time

Datum/Uhrzeit der Übermittlung des BPM-Datensatzes an den aktuellen Prozessschritt
Zielzeitdauer
 targetTimeDuration date-time

Das Datum/die Uhrzeit, an dem der BPM-Eintrag basierend auf der SLA-Dauer ausgeführt werden muss.
visibleObjects
 visibleObjects array of object
Process Step-Objekt-ID
 visibleObjects.id string

Die ID der Komponente, auf die in der Benutzeroberfläche verwiesen wird
choices
 visibleObjects.inputOptions.choices array of object
Auswahltypbezeichnung
 visibleObjects.inputOptions.choices.label string

Eine Beschriftung für die ausgewählte Auswahl
Auswahltypwert
 visibleObjects.inputOptions.choices.value string

Ein Wert für die ausgewählte Auswahl
Bezeichnung für Eingabeoptionen
 visibleObjects.inputOptions.label string

Eine Bezeichnung, die das Eingabefeld oder die bearbeitbare Komponente definiert
Eingabeoptionennachrichten
 visibleObjects.inputOptions.messages array of string

Meldungen, die verwendet werden sollen, wenn die Überprüfung der Eingabeoptionen fehlschlägt
Eingabeoptionentyp
 visibleObjects.inputOptions.type string

Definiert den Typ des zu verwendenden Eingabefelds oder der bearbeitbaren Komponente.
Ist Process Step-Objekt bearbeitbar
 visibleObjects.isEditable boolean

Ist die Komponente, auf die verwiesen wird, für benutzereingaben bearbeitbar
Ist Process Step-Objekt obligatorisch
 visibleObjects.isMandatory boolean

Erfordert die Komponente, auf die verwiesen wird, benutzereingaben

KeywordValues

Name Pfad Typ Beschreibung
Etikett
 label string
Wert
 value string

RegisterBPMRecord

Name Pfad Typ Beschreibung
Beschreibung des Prozessschritts
 description string

Eine kurze Beschreibung, in der der Prozessschritt erläutert wird
SLA-Dauer (Stunden)
 duration string

Die SLA-Dauer in Stunden. Geben Sie einen Wert von 0 an, falls nicht zutreffend.
eventStampHistory
 eventStampHistory array of object
Ereignisstempelverlaufsname
 eventStampHistory.eventName string

Name des Ereignisstempels
Zeitstempel des Ereignisstempelverlaufs
 eventStampHistory.timeStamp date-time

Der Zeitstempel, zu dem der Ereignisstempel aufgetreten ist
history
 history array of object
Verlaufskommentare
 history.comments string

Optionale Kommentare, die zum Zeitpunkt der Erstellung des Verlaufseintrags hinzugefügt wurden
Aktuelle Rolle "Verlauf"
 history.currentRole string

Die aktuelle Rolle zum Zeitpunkt des Verlaufseintrags
Verlauf aktueller Benutzer
 history.currentUser string

Der aktuelle Benutzer zum Zeitpunkt des Verlaufseintrags
Schrittdauer
 history.duration string

Die Zeit (in Minuten) des Datensatzes im aktuellen Prozessschritt vor der Aktion
Verlaufsereignisstempel
 history.eventStamp array of string

Ereignisstempel, die zum Zeitpunkt des Verlaufseintrags aufgetreten sind
Von Schritt zu Schritt
 history.fromStep string

Der Schlüssel des Prozessschritts, aus dem der BPM-Eintrag zum Zeitpunkt des Verlaufseintrags stammt.
Aus Schrittname
 history.fromStepName string

Der Name des Prozessschritts, aus dem der BPM-Eintrag zum Zeitpunkt des Verlaufseintrags stammt.
Option "Verlauf" ausgewählt
 history.optionSelected string

Die Option, die beim Ausführen des BPM-Eintrags ausgewählt wurde
BPM-Prozessschlüssel der Geschichte
 history.processKey string

Der eindeutige BPM-Prozessschlüssel für den Verlaufseintrag
Verlaufsprozessphase
 history.processStage string

Die Prozessphase zum Zeitpunkt des Verlaufseintrags
BPM-Datensatz-ID des Verlaufs
 history.recordId string

Die Datensatz-ID für den BPM-bezogenen Datensatz, der während des Prozess "BPM-Datensatz registrieren" generiert wurde.
Verantwortungsvolle Rolle des Verlaufs
 history.responsibleRole string

Die verantwortungsvolle Rolle des BPM Record zum Zeitpunkt des Verlaufseintrags
Verlauf verantwortlicher Benutzer
 history.responsibleUsers array of string

Verantwortliche Benutzer zum Zeitpunkt des Verlaufseintrags
Übermittlungsdatum des Verlaufs
 history.submissionDate date-time

Das Datum/die Uhrzeit, zu dem der BPM-Eintrag ausgeführt wurde
So verarbeiten Sie die Phase
 history.toProcessStage string

Die Prozessstufe für den BPM-Eintrag zum Zeitpunkt des Verlaufseintrags
In Schritt
 history.toStep string

Der Schlüssel des Prozessschritts für den BPM-Eintrag zum Zeitpunkt des Verlaufseintrags
In Schrittname
 history.toStepName string

Der Name des Prozessschritts für den BPM-Eintrag zum Zeitpunkt des Verlaufseintrags
Schrittanweisungen
 instructions string

Anweisungen für verantwortungsvolle Benutzer während des Schritts
Prozessschrittschlüssel
 key string

Ein eindeutiger Schlüssel zum Identifizieren des Prozessschritts
Prozessschrittname
 name string

Ein kurzer Name für den Prozessschritt
BPM-Profilschlüssel
 processKey string

Ein eindeutiger Schlüssel zum Identifizieren des BPM-Profils
Prozessphase
 processStage string

Ein Schlüssel, der die Prozessstufe des aktuellen Schritts definiert
BPM-Datensatz-ID
 recordId string

Die vom BPM-Modul generierte Datensatz-ID beim Registrieren eines BPM-Eintrags
BPM-Datensatzreferenz
 recordRef string

Eine lesbare Zahl, die vom BPM-Modul mithilfe des Nummerierungsmoduls beim Registrieren eines BPM-Eintrags generiert wird
Prozessschritt-Referenz-URL
 referenceUrl string

Eine Referenz-URL für den Prozessschritt
Verantwortungsvolle Rolle des Prozessschritts
 responsibleRole string

Die Rolle, die für den aktuellen Prozessschritt verantwortlich ist
Prozessschritt verantwortungsvolle Benutzer
 responsibleUsers array of string

Die für den aktuellen Prozessschritt verantwortlichen Benutzer
roles
 roles array of object
Rollenname
 roles.name string

Name der Rolle
Nutzer
 roles.users array of object
Rollen-E-Mail
 roles.users.email string

Mit dem Rollennamen verknüpfte E-Mail-Adresse(en)
stepOptions
 stepOptions array of object
Beschreibung der Schrittoption
 stepOptions.description string

Eine kurze Beschreibung, in der die Schrittoption erläutert wird
Schrittoptionsereignisstempel
 stepOptions.eventStamp array of string

Ein Ereignisstempel für die aktuelle Schrittoption
Schrittoptionsname
 stepOptions.name string

Ein kurzer Name für die Option "Schritt"
Nächster Schritt
 stepOptions.nextStep string

Im nächsten Schritt wird der Geschäftsprozess weitergeleitet. Leer lassen, wenn keine weiteren Schritte ausgeführt werden
Schrittoptionshinweise
 stepOptions.notes string

Optionale Hinweise für die Schrittoption
visibleObjects
 stepOptions.visibleObjects array of object
Step Option-Objekt-ID
 stepOptions.visibleObjects.id string

Die ID der Komponente, auf die in der Benutzeroberfläche verwiesen wird
choices
 stepOptions.visibleObjects.inputOptions.choices array of object
Auswahltypbezeichnung
 stepOptions.visibleObjects.inputOptions.choices.label string

Eine Beschriftung für die ausgewählte Auswahl
Auswahltypwert
 stepOptions.visibleObjects.inputOptions.choices.value string

Ein Wert für die ausgewählte Auswahl
Bezeichnung für Eingabeoptionen
 stepOptions.visibleObjects.inputOptions.label string

Eine Bezeichnung, die das Eingabefeld oder die bearbeitbare Komponente definiert
Eingabeoptionennachrichten
 stepOptions.visibleObjects.inputOptions.messages array of string

Meldungen, die verwendet werden sollen, wenn die Überprüfung der Eingabeoptionen fehlschlägt
Eingabeoptionentyp
 stepOptions.visibleObjects.inputOptions.type string

Definiert den Typ des zu verwendenden Eingabefelds oder der bearbeitbaren Komponente.
Is Step Option Object Editable
 stepOptions.visibleObjects.isEditable boolean

Ist die Komponente, auf die verwiesen wird, für benutzereingaben bearbeitbar
Ist Step Option-Objekt obligatorisch
 stepOptions.visibleObjects.isMandatory boolean

Erfordert die Komponente, auf die verwiesen wird, benutzereingaben
visibleObjects
 visibleObjects array of object
Process Step-Objekt-ID
 visibleObjects.id string

Die ID der Komponente, auf die in der Benutzeroberfläche verwiesen wird
choices
 visibleObjects.inputOptions.choices array of object
Auswahltypbezeichnung
 visibleObjects.inputOptions.choices.label string

Eine Beschriftung für die ausgewählte Auswahl
Auswahltypwert
 visibleObjects.inputOptions.choices.value string

Ein Wert für die ausgewählte Auswahl
Bezeichnung für Eingabeoptionen
 visibleObjects.inputOptions.label string

Eine Bezeichnung, die das Eingabefeld oder die bearbeitbare Komponente definiert
Eingabeoptionennachrichten
 visibleObjects.inputOptions.messages array of string

Meldungen, die verwendet werden sollen, wenn die Überprüfung der Eingabeoptionen fehlschlägt
Eingabeoptionentyp
 visibleObjects.inputOptions.type string

Definiert den Typ des zu verwendenden Eingabefelds oder der bearbeitbaren Komponente.
Ist Process Step-Objekt bearbeitbar
 visibleObjects.isEditable boolean

Ist die Komponente, auf die verwiesen wird, für benutzereingaben bearbeitbar
Ist Process Step-Objekt obligatorisch
 visibleObjects.isMandatory boolean

Erfordert die Komponente, auf die verwiesen wird, benutzereingaben

StdJSONResponse

Name Pfad Typ Beschreibung
Ergebnis
 result string

Ergebnis

Objekt

Dies ist der Typ 'object'.