Freigeben über


K2-Workflow (Vorschau)

Verwenden Sie den K2-Workflow-API-Dienst, um remote mit Workflows und Aufgaben zu arbeiten.

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

Dienstleistung Class Regions
Copilot Studio Norm 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 Norm 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 Norm 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
URL https://portal.k2.com/ticket/default
Connectormetadaten
Herausgeber K2
Webseite https://www.k2.com
Datenschutzrichtlinie https://www.k2.com/legal/privacy-policy

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
K2-URL Schnur Ihre K2-URL (Beispiel: https://[K2ID].onk2.com). Richtig
Nutzername securestring Der Benutzername für diese API Richtig
Kennwort securestring Das Kennwort für diese API Richtig

Drosselungsgrenzwerte

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

Aktionen

Aktionsaufgabe

Führt eine Workflowaktion aus.

Aufgabe abrufen

Ruft einen Vorgang nach Seriennummer ab.

Aufgabe freigeben

Gibt eine Aufgabe frei.

Aufgabe im Energiesparmodus

Schläft einen Vorgang für eine Dauer, entweder eine Anzahl von Sekunden oder bis zu einem Datum.

Aufgabe zuweisen

Weist dem aktuellen Benutzer eine Aufgabe zu.

Aufgaben abrufen

Rufen Sie eine Liste der Aufgaben ab, die für den verbundenen Benutzer verfügbar sind.

Aufgabenaktionen abrufen

Ruft eine Liste der Aktionen für die Aufgabe ab.

Finish Server-Ereignis

Senden einer endenden Antwort an eine asynchrone Serveraufgabe, die auf eine Antwort wartet

Serverereignis abrufen

Ruft ein Serverereignis nach Seriennummer ab.

Umleitungsaufgabe

Sendet eine Aufgabe an eine andere Person.

Wake-Aufgabe

Weckt eine schlafende Aufgabe.

Workflow abrufen

Ruft eine Workflowdefinition nach ID ab.

Workflow starten

Erstellt und startet eine neue Workflowinstanz.

Workflows abrufen

Dient zum Abrufen einer Liste der verfügbaren Workflows.

Aktionsaufgabe

Führt eine Workflowaktion aus.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer
serialNumber True string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Benutzerdefinierte Aktion
customAction True string

Die Aufgabenaktion, die vom Workflow definiert wird.

XML-Feldname
name string

Der Name eines XML-Felds.

XML-Feldwert
value string

Der Wert des XML-Felds.

Elementverweise
ItemReferences object

Die Elementreferenzfelder der Workflowinstanz.

Datenfelder
DataFields object

Die Datenfelder der Workflowinstanz.

Aufgabe abrufen

Ruft einen Vorgang nach Seriennummer ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer
serialNumber True string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Gibt zurück

Body
Task

Aufgabe freigeben

Gibt eine Aufgabe frei.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer
serialNumber True string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Aufgabe im Energiesparmodus

Schläft einen Vorgang für eine Dauer, entweder eine Anzahl von Sekunden oder bis zu einem Datum.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer
serialNumber True string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Schlafen für
SleepFor integer

Die Anzahl der Sekunden, mit der ein Vorgang in den Ruhezustand geschlafen werden soll.

Ruhezustand bis
SleepUntil date-time

Das Datum und die Uhrzeit, zu dem die Aufgabe aktiviert werden soll. Format: yyyy-MM-ddTHH:mm:ss:fffZ UTC

Aufgabe zuweisen

Weist dem aktuellen Benutzer eine Aufgabe zu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer
serialNumber True string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Gibt zurück

response
object

Aufgaben abrufen

Rufen Sie eine Liste der Aufgaben ab, die für den verbundenen Benutzer verfügbar sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
All, Allocated, Sleeping, SharedFrom, SharedTo
state string

Gibt eine Liste der Aufgaben für den verbundenen Benutzer zurück.

Gibt zurück

Aufgabenaktionen abrufen

Ruft eine Liste der Aktionen für die Aufgabe ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer
serialNumber True string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Gibt zurück

Finish Server-Ereignis

Senden einer endenden Antwort an eine asynchrone Serveraufgabe, die auf eine Antwort wartet

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer des Serverereignisses
serialNumber True string

Die Seriennummer des Serverereignisses. Beispiel: 1234_5678

XML-Feldname
name string

Der Name eines XML-Felds.

XML-Feldwert
value string

Der Wert des XML-Felds.

Elementverweise
ItemReferences object

Die Elementreferenzfelder der Workflowinstanz.

Datenfelder
DataFields object

Die Datenfelder der Workflowinstanz.

Serverereignis abrufen

Ruft ein Serverereignis nach Seriennummer ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer des Serverereignisses
serialNumber True string

Die Seriennummer des Serverereignisses. Beispiel: 1234_5678.

Gibt zurück

Umleitungsaufgabe

Sendet eine Aufgabe an eine andere Person.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer
serialNumber True string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Umleitungsinformationen
RedirectTo True string

Die Person, an die die Aufgabe umgeleitet wird.

Wake-Aufgabe

Weckt eine schlafende Aufgabe.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seriennummer
serialNumber True string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Gibt zurück

response
object

Workflow abrufen

Ruft eine Workflowdefinition nach ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Workflow-ID
id True integer

Die ID des Workflows.

Gibt zurück

Workflow starten

Erstellt und startet eine neue Workflowinstanz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Workflow-ID
id True integer

Geben Sie eine Workflow-ID an, um die Instanz zu starten.

Workflowinstanzdetails
instance True dynamic

Senden des Workflowinstanzobjekts zum Starten des Workflows.

Gibt zurück

response
integer

Workflows abrufen

Dient zum Abrufen einer Liste der verfügbaren Workflows.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Workflowtyp
type string

Der Workflowtyp. Startbar oder besitzbar.

Gibt zurück

Definitionen

ServerEventDataResponse

Name Pfad Typ Beschreibung
Seriennummer des Serverereignisses
serialNumber string

Die Seriennummer des Serverereignisses. Beispiel: 1234_5678

Serverereignis-Workflow-ID
workflowID integer

Die ID des Workflows, der dem Serverereignis zugeordnet ist.

Name des Serverereignisworkflows
workflowName string

Der Name des Workflows, der dem Serverereignis zugeordnet ist.

Anzeigename des Serverereignisworkflows
workflowDisplayName string

Der Anzeigename des Workflows, der dem Serverereignis zugeordnet ist.

Serverereignis-Workflowkategorie
workflowCategory string

Die Kategorie des Workflows, der dem Serverereignis zugeordnet ist.

Serverereignis-Workflowinstanz-ID
workflowInstanceID integer

Die Instanz-ID des Workflows, der dem Serverereignis zugeordnet ist.

Serverereignisworkflow Folio
workflowInstanceFolio string

Die Folio der Workflowinstanz, die dem Serverereignis zugeordnet ist.

Serverereignisaktivitätsinstanz-ID
activityInstanceID integer

Die Aktivitätsinstanz-ID des Serverereignisses.

Ziel-ID der Serverereignisaktivität
activityInstanceDestinationID integer

Die Ziel-ID der Aktivitätsinstanz des Serverereignisses.

Serverereignisaktivitätsname
activityName string

Der Aktivitätsname des Serverereignisses.

Serverereignisname
eventName string

Der Ereignisname des Serverereignisses.

Serverereignisbeschreibung
eventDescription string

Die Ereignisbeschreibung des Serverereignisses.

Urheber
originator User
eventInstance
eventInstance EventInstanceWrapper
Serverereignisaktivitätsdatenfelder
dataFields object

Die Datenfelder der Aktivität.

XML-Felder für Serverereignisaktivität
xmlFields array of UserDefinedXmlField

Die XML-Felder der Aktivität.

Serverereigniselementverweise
itemReferences object

Die Elementverweise der Workflowinstanz.

Zeichenfolge für Serverereignisworkflow-Datenfelder
workflowInstanceDataFieldsString string

Zeichenfolgen-Darstellung der Datenfelder der Workflowinstanz.

Zeichenfolge für Serverereigniselementverweise
itemReferencesString string

Zeichenfolge, die die Elementverweise der Workflowinstanz darstellt.

viewFlowURL
viewFlowURL string

EventInstance

Name Pfad Typ Beschreibung
Startdatum der Ereignisinstanz
StartDate date-time

Datum und Uhrzeit, zu dem die Ereignisinstanz gestartet wurde.

Erwartete Dauer der Ereignisinstanz
ExpectedDuration integer

Erwartete Dauer der Ereignisinstanz.

Ereignisinstanzpriorität
Priority integer

Priorität der Ereignisinstanz.

Ereignisinstanzmetadaten
MetaData string

Metadaten für die Ereignisinstanz.

Ereignisinstanzbeschreibung
Description string

Beschreibung der Ereignisinstanz.

Ereignisinstanzname
Name string

Name der Ereignisinstanz.

Ereignisinstanz-ID
ID integer

ID der Ereignisinstanz.

UserDefinedXmlField

Name Pfad Typ Beschreibung
XML-Feldname
name string

Der Name eines XML-Felds.

XML-Feldwert
value string

Der Wert des XML-Felds.

TasksResponse

Name Pfad Typ Beschreibung
Vorgangsanzahl
itemCount integer

Die Anzahl der zurückgegebenen Vorgänge.

Aufgaben
tasks array of TaskLite

Mindestens eine Aufgabe.

TaskLite

Name Pfad Typ Beschreibung
Seriennummer des Vorgangs
serialNumber string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Aufgabenstatus
status string

Der Status des Vorgangs. Beispiel: Öffnen, Abgeschlossen, Ruhezustand, zugeordnet, verfügbar

Anfangstermin des Vorgangs
taskStartDate date-time

Der Anfangstermin des Vorgangs.

Vorgangsschlafdauer
sleepUntil date-time

Das Datum und die Uhrzeit, zu dem die Aufgabe aktiviert wird.

Vorgangspriorität
priority integer

Die Priorität des Vorgangs.

URL des Aufgabenformulars
formURL string

Die Formular-URL der Aufgabe.

Ablauf-URL der Vorgangsansicht
viewFlowURL string

Die Ansichtsfluss-URL der Aufgabe.

Aufgabenworkflow-ID
workflowID integer

Die ID des Workflows, der der Aufgabe zugeordnet ist.

Aufgabenworkflowname
workflowName string

Der Name des Workflows, der der Aufgabe zugeordnet ist.

Anzeigename des Aufgabenworkflows
workflowDisplayName string

Der Anzeigename des Workflows, der der Aufgabe zugeordnet ist.

Aufgabenworkflowkategorie
workflowCategory string

Die Kategorie des Workflows, der der Aufgabe zugeordnet ist.

Aufgabenworkflowinstanz-ID
workflowInstanceID integer

Die Instanz-ID des Workflows, der der Aufgabe zugeordnet ist.

Aufgabenworkflow Folio
workflowInstanceFolio string

Die Folio der Workflowinstanz, die der Aufgabe zugeordnet ist.

Vorgangsinstanz-ID
activityInstanceID integer

Die Aktivitätsinstanz-ID der Aufgabe.

Ziel-ID der Vorgangsaktivität
activityInstanceDestinationID integer

Die Ziel-ID der Aktivitätsinstanz des Vorgangs.

Vorgangsaktivitätsname
activityName string

Der Aktivitätsname der Aufgabe.

Vorgangsereignisname
eventName string

Der Ereignisname der Aufgabe.

Aufgabenereignisbeschreibung
eventDescription string

Die Ereignisbeschreibung der Aufgabe.

Urheber
originator User
Handlungen
actions TaskActionsResponse
Aufgabenanweisungen
instruction string

Die dem Vorgang zugeordneten Anweisungen.

Benutzer

Name Pfad Typ Beschreibung
Benutzername
username string

Benutzername der Person.

Benutzer-FQN
fqn string

Vollqualifizierter Name der Person. Ex: bob@denallix.com, K2:Denallix\Bob

Benutzer-E-Mail
email string

E-Mail-Adresse der Person.

Benutzer-Manager
manager string

Vorgesetzter der Person.

Anzeigename des Benutzers
displayName string

Anzeigename der Person.

TaskActionsResponse

Name Pfad Typ Beschreibung
Nicht diskutierte Aktionen
nonBatchableActions array of string

Liste der Aktionen, die nicht ausgeführt werden können, ohne die Aufgabe zuzuweisen.

Batchfähige Aktionen
batchableActions array of string

Liste der Aktionen, die ausgeführt werden können, ohne die Aufgabe zuzuweisen.

Systemaktionen
systemActions array of string

Liste der Systemaktionen.

Aufgabe

Name Pfad Typ Beschreibung
Seriennummer des Vorgangs
serialNumber string

Die Seriennummer des Vorgangs. Beispiel: 1234_5678

Aufgabenstatus
status string

Der Status des Vorgangs. Beispiel: Öffnen, Abgeschlossen, Ruhezustand, zugeordnet, verfügbar

Anfangstermin des Vorgangs
taskStartDate date-time

Der Anfangstermin des Vorgangs.

Vorgangsschlafdauer
sleepUntil date-time

Das Datum und die Uhrzeit, zu dem die Aufgabe aktiviert wird.

Vorgangspriorität
priority integer

Die Priorität des Vorgangs.

URL des Aufgabenformulars
formURL string

Die Formular-URL der Aufgabe.

Ablauf-URL der Vorgangsansicht
viewFlowURL string

Die Ansichtsfluss-URL der Aufgabe.

Aufgabenworkflow-ID
workflowID integer

Die ID des Workflows, der der Aufgabe zugeordnet ist.

Aufgabenworkflowname
workflowName string

Der Name des Workflows, der der Aufgabe zugeordnet ist.

Anzeigename des Aufgabenworkflows
workflowDisplayName string

Der Anzeigename des Workflows, der der Aufgabe zugeordnet ist.

Aufgabenworkflowkategorie
workflowCategory string

Die Kategorie des Workflows, der der Aufgabe zugeordnet ist.

Aufgabenworkflowinstanz-ID
workflowInstanceID integer

Die Instanz-ID des Workflows, der der Aufgabe zugeordnet ist.

Aufgabenworkflow Folio
workflowInstanceFolio string

Die Folio der Workflowinstanz, die der Aufgabe zugeordnet ist.

Vorgangsinstanz-ID
activityInstanceID integer

Die Aktivitätsinstanz-ID der Aufgabe.

Ziel-ID des Vorgangs
activityInstanceDestinationID integer

Die Ziel-ID der Aktivitätsinstanz des Vorgangs.

Vorgangsaktivitätsname
activityName string

Der Aktivitätsname der Aufgabe.

Vorgangsereignisname
eventName string

Der Ereignisname der Aufgabe.

Aufgabenereignisbeschreibung
eventDescription string

Die Ereignisbeschreibung der Aufgabe.

Urheber
originator User
Handlungen
actions TaskActionsResponse
Aufgabenworkflow-Datenfelder
workflowInstanceDataFields object

Die Datenfelder der Workflowinstanz.

Vorgangsaktivitätsdatenfelder
activityDataFields object

Die Datenfelder der Aktivität.

Aufgabenworkflow-XML-Felder
workflowInstanceXmlFields array of UserDefinedXmlField

Die XML-Felder der Workflowinstanz.

Aufgabenelementverweise
itemReferences object

Die Elementverweise der Workflowinstanz.

Anweisung
instruction string
Zeichenfolge für Vorgangsworkflowdatenfelder
workflowInstanceDataFieldsString string

Zeichenfolgen-Darstellung der Datenfelder der Workflowinstanz.

Zeichenfolge für Vorgangselementverweise
itemReferencesString string

Zeichenfolge, die die Elementverweise der Workflowinstanz darstellt.

WorkflowLabelsResponse[WorkflowLabel]

Name Pfad Typ Beschreibung
Anzahl der Elemente
itemCount integer

Die Anzahl der Workflows.

Workflows
workflows array of WorkflowLabel

Eine Liste der Workflows.

WorkflowLabel

Name Pfad Typ Beschreibung
Workflow-ID
id integer

Die ID des Workflows.

Workflowstandardversion
defaultVersionId integer

Die Standardworkflowversion.

Workflowname
name string

Der Workflowname.

Workflowordner
folder string

Der Workflowordner.

Workflowsystemname
systemName string

Der Name des Workflowsystems.

WorkflowDataResponse

Name Pfad Typ Beschreibung
workflowInfo
workflowInfo WorkflowDefinition
Workflowschema
workflowSchema string

Das Schema des Workflows.

WorkflowDefinition

Name Pfad Typ Beschreibung
Workflowname
name string

Der Name des Workflows.

Workflowbeschreibung
description string

Die Beschreibung des Workflows.

Workflowordner
folder string

Der Ordner (Kategorie) des Workflows.

Workflowsystemname
systemName string

Der Systemname des Workflows.

Workflowdauer erwartet
expectedDuration integer

Die erwartete Dauer des Workflows.

EventInstanceWrapper

Name Pfad Typ Beschreibung
EventInstance
EventInstance EventInstance
Ereignisinstanzbeschreibung
Description string

Beschreibung der Ereignisinstanz.

Erwartete Dauer der Ereignisinstanz
ExpectedDuration integer

Erwartete Dauer der Ereignisinstanz.

Ereignisinstanz-ID
ID integer

ID der Ereignisinstanz.

Ereignisinstanzmetadaten
MetaData string

Metadaten für die Ereignisinstanz.

Ereignisinstanzname
Name string

Name der Ereignisinstanz.

Ereignisinstanzpriorität
Priority integer

Priorität der Ereignisinstanz.

Startdatum der Ereignisinstanz
StartDate date-time

Datum und Uhrzeit, zu dem die Ereignisinstanz gestartet wurde.

Integer

Dies ist der grundlegende Datentyp "integer".

Objekt

Dies ist der Typ „Objekt“.