Dela via

K2-arbetsflöde (förhandsversion)

Använd K2 Workflow API-tjänsten för att fjärransluta till att arbeta med arbetsflöden och uppgifter.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster Class Regioner
Copilot Studio Norm Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Norm Alla Logic Apps-regioner utom följande:
     – Azure Government-regioner
     – Regioner i Azure Kina
     - US Department of Defense (DoD)
Power Apps Norm Alla Power Apps-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Norm Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Kontakt
URL https://portal.k2.com/ticket/default
Metadata för anslutningsprogram
Utgivare K2
Webbplats https://www.k2.com
Sekretesspolicy https://www.k2.com/legal/privacy-policy

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:
Standardinställning Parametrar för att skapa anslutning. Alla regioner Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn Typ Description Krävs
K2-URL snöre Din K2-URL (exempel: https://[K2ID].onk2.com). Sann
Användarnamn securestring Användarnamnet för det här API:et Sann
Lösenord securestring Lösenordet för det här API:et Sann

Begränsningsgränser

Name Anrop Förnyelseperiod
API-anrop per anslutning 100 60 sekunder

Åtgärder

Aktiveringsaktivitet

Väcker en sovande uppgift.
Hämta aktivitetsåtgärder

Hämtar en lista över åtgärder för uppgiften.
Hämta arbetsflöde

Hämtar en arbetsflödesdefinition efter ID.
Hämta arbetsflöden

Hämta en lista över tillgängliga arbetsflöden.
Hämta serverhändelse

Hämtar en serverhändelse efter serienummer.
Hämta uppgift

Hämtar en uppgift efter serienummer.
Hämta uppgifter

Hämta en lista över uppgifter som är tillgängliga för den anslutna användaren.
Omdirigeringsaktivitet

Skickar en uppgift till en annan person.
Slutför serverhändelse

Skicka ett avslutssvar till en asynkron serveraktivitet som väntar på ett svar
Starta arbetsflöde

Skapar och startar en ny arbetsflödesinstans.
Tilldela aktivitet

Tilldelar en uppgift till den aktuella användaren.
Versionsuppgift

Släpper en uppgift.
Vilolägesaktivitet

Viloläge för en aktivitet under en varaktighet, antingen antal sekunder eller till ett datum.
Åtgärdsaktivitet

Utför en arbetsflödesåtgärd.

Aktiveringsaktivitet

Åtgärds-ID:
Tasks_PostWakeAction

Väcker en sovande uppgift.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer
 serialNumber True string

Aktivitetens serienummer. Ex: 1234_5678

Returer

response
object

Hämta aktivitetsåtgärder

Åtgärds-ID:
Tasks_GetTaskActions

Hämtar en lista över åtgärder för uppgiften.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer
 serialNumber True string

Aktivitetens serienummer. Ex: 1234_5678

Returer

Body
TaskActionsResponse

Hämta arbetsflöde

Åtgärds-ID:
GetWorkflow

Hämtar en arbetsflödesdefinition efter ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
Arbetsflödes-ID
 id True integer

ID:t för arbetsflödet.

Returer

Body
WorkflowDataResponse

Hämta arbetsflöden

Åtgärds-ID:
GetWorkflows

Hämta en lista över tillgängliga arbetsflöden.

Parametrar

Name Nyckel Obligatorisk Typ Description
Arbetsflödestyp
 type string

Typen av arbetsflöde. Startbar eller ägd.

Returer

Body
WorkflowLabelsResponse[WorkflowLabel]

Hämta serverhändelse

Åtgärds-ID:
ServerEvent_Get

Hämtar en serverhändelse efter serienummer.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer för serverhändelse
 serialNumber True string

Serverhändelsens serienummer. Ex: 1234_5678.

Returer

Body
ServerEventDataResponse

Hämta uppgift

Åtgärds-ID:
Tasks_GetTask

Hämtar en uppgift efter serienummer.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer
 serialNumber True string

Aktivitetens serienummer. Ex: 1234_5678

Returer

Body
Task

Hämta uppgifter

Åtgärds-ID:
Tasks_Get

Hämta en lista över uppgifter som är tillgängliga för den anslutna användaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Alla, allokerade, sovande, deladeFrom, SharedTo
 state string

Returnerar en lista över uppgifter för den anslutna användaren.

Returer

Body
TasksResponse

Omdirigeringsaktivitet

Åtgärds-ID:
Tasks_PostRedirectAction

Skickar en uppgift till en annan person.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer
 serialNumber True string

Aktivitetens serienummer. Ex: 1234_5678
Omdirigeringsinformation
 RedirectTo True string

Den person som uppgiften omdirigeras till.

Slutför serverhändelse

Åtgärds-ID:
ServerEvent_Finish

Skicka ett avslutssvar till en asynkron serveraktivitet som väntar på ett svar

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer för serverhändelse
 serialNumber True string

Serverhändelsens serienummer. Ex: 1234_5678
XML-fältnamn
 name string

Namnet på ett XML-fält.
XML-fältvärde
 value string

Värdet för XML-fältet.
Objektreferenser
 ItemReferences object

Fälten Objektreferens i arbetsflödesinstansen.
Datafält
 DataFields object

Datafälten i arbetsflödesinstansen.

Starta arbetsflöde

Åtgärds-ID:
StartWorkflow

Skapar och startar en ny arbetsflödesinstans.

Parametrar

Name Nyckel Obligatorisk Typ Description
Arbetsflödes-ID
 id True integer

Ange ett arbetsflödes-ID för att starta instansen.
Information om arbetsflödesinstans
 instance True dynamic

Skicka arbetsflödesinstansobjekt för att starta arbetsflödet.

Returer

response
integer

Tilldela aktivitet

Åtgärds-ID:
Tasks_PostAssignAction

Tilldelar en uppgift till den aktuella användaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer
 serialNumber True string

Aktivitetens serienummer. Ex: 1234_5678

Returer

response
object

Versionsuppgift

Åtgärds-ID:
Tasks_PostReleaseAction

Släpper en uppgift.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer
 serialNumber True string

Aktivitetens serienummer. Ex: 1234_5678

Vilolägesaktivitet

Åtgärds-ID:
Tasks_PostSleepAction

Viloläge för en aktivitet under en varaktighet, antingen antal sekunder eller till ett datum.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer
 serialNumber True string

Aktivitetens serienummer. Ex: 1234_5678
Viloläge för
 SleepFor integer

Antalet sekunder som en uppgift ska viloläge.
Viloläge tills
 SleepUntil date-time

Datum och tid för att aktivera aktiviteten. Format: åååå-MM-ddTHH:mm:ss:fffZ UTC

Åtgärdsaktivitet

Åtgärds-ID:
Tasks_TaskCustomAction

Utför en arbetsflödesåtgärd.

Parametrar

Name Nyckel Obligatorisk Typ Description
Serienummer
 serialNumber True string

Aktivitetens serienummer. Ex: 1234_5678
Anpassad åtgärd
 customAction True string

Uppgiftsåtgärden som definieras av arbetsflödet.
XML-fältnamn
 name string

Namnet på ett XML-fält.
XML-fältvärde
 value string

Värdet för XML-fältet.
Objektreferenser
 ItemReferences object

Fälten Objektreferens i arbetsflödesinstansen.
Datafält
 DataFields object

Datafälten i arbetsflödesinstansen.

Definitioner

ServerEventDataResponse

Name Sökväg Typ Description
Serienummer för serverhändelse
 serialNumber string

Serverhändelsens serienummer. Ex: 1234_5678
Arbetsflödes-ID för serverhändelse
 workflowID integer

ID:t för arbetsflödet som är associerat med serverhändelsen.
Namn på serverhändelsearbetsflöde
 workflowName string

Namnet på arbetsflödet som är associerat med serverhändelsen.
Visningsnamn för serverhändelsearbetsflöde
 workflowDisplayName string

Visningsnamnet för arbetsflödet som är associerat med serverhändelsen.
Arbetsflödeskategori för serverhändelse
 workflowCategory string

Kategorin för arbetsflödet som är associerat med serverhändelsen.
Instans-ID för serverhändelsearbetsflöde
 workflowInstanceID integer

Instans-ID för arbetsflödet som är associerat med serverhändelsen.
Folio för serverhändelsearbetsflöde
 workflowInstanceFolio string

Folio för arbetsflödesinstansen som är associerad med serverhändelsen.
Instans-ID för serverhändelseaktivitet
 activityInstanceID integer

Aktivitetsinstansens ID för serverhändelsen.
Mål-ID för serverhändelseaktivitet
 activityInstanceDestinationID integer

Aktivitetsinstansens mål-ID för serverhändelsen.
Namn på serverhändelseaktivitet
 activityName string

Serverhändelsens aktivitetsnamn.
Händelsenamn för serverhändelse
 eventName string

Händelsenamnet för serverhändelsen.
Händelsebeskrivning för serverhändelse
 eventDescription string

Händelsebeskrivningen för serverhändelsen.
upphovsman
 originator User
eventInstance
 eventInstance EventInstanceWrapper
Datafält för serverhändelseaktivitet
 dataFields object

Aktivitetens datafält.
XML-fält för serverhändelseaktivitet
 xmlFields array of UserDefinedXmlField

XML-fälten för aktiviteten.
Referenser för serverhändelseobjekt
 itemReferences object

Objektreferenserna för arbetsflödesinstansen.
Datafältsträng för serverhändelsearbetsflöde
 workflowInstanceDataFieldsString string

Strängrepresentation av datafälten i arbetsflödesinstansen.
Referenssträng för serverhändelseobjekt
 itemReferencesString string

Sträng som representerar objektreferenserna för arbetsflödesinstansen.
viewFlowURL
 viewFlowURL string

EventInstance

Name Sökväg Typ Description
Startdatum för händelseinstans
 StartDate date-time

Datum och tid då händelseinstansen startade.
Förväntad varaktighet för händelseinstans
 ExpectedDuration integer

Förväntad varaktighet för händelseinstansen.
Prioritet för händelseinstans
 Priority integer

Prioritet för händelseinstansen.
Metadata för händelseinstans
 MetaData string

Metadata för händelseinstansen.
Beskrivning av händelseinstans
 Description string

Beskrivning av händelseinstansen.
Namn på händelseinstans
 Name string

Namn på händelseinstansen.
Händelseinstans-ID
 ID integer

ID för händelseinstansen.

UserDefinedXmlField

Name Sökväg Typ Description
XML-fältnamn
 name string

Namnet på ett XML-fält.
XML-fältvärde
 value string

Värdet för XML-fältet.

TasksResponse

Name Sökväg Typ Description
Antal aktiviteter
 itemCount integer

Antalet returnerade uppgifter.
Tasks
 tasks array of TaskLite

En eller flera uppgifter.

TaskLite

Name Sökväg Typ Description
Aktivitetsserienummer
 serialNumber string

Aktivitetens serienummer. Ex: 1234_5678
Aktivitetsstatus
 status string

Status för uppgiften. Exempel: Öppen, Slutförd, Strömsparläge, Allokerad, Tillgänglig
Startdatum för aktivitet
 taskStartDate date-time

Aktivitetens startdatum.
Varaktighet för aktivitetssparläge
 sleepUntil date-time

Datum och tid då aktiviteten aktiveras.
Aktivitetsprioritet
 priority integer

Uppgiftens prioritet.
URL för uppgiftsformulär
 formURL string

Uppgiftens form-URL.
URL för aktivitetsvyflöde
 viewFlowURL string

Visa flödets URL för uppgiften.
Uppgiftsarbetsflödes-ID
 workflowID integer

ID:t för arbetsflödet som är associerat med uppgiften.
Namn på uppgiftsarbetsflöde
 workflowName string

Namnet på arbetsflödet som är associerat med uppgiften.
Visningsnamn för uppgiftsarbetsflöde
 workflowDisplayName string

Visningsnamnet för arbetsflödet som är associerat med uppgiften.
Uppgiftsarbetsflödeskategori
 workflowCategory string

Kategorin för arbetsflödet som är associerat med uppgiften.
Instans-ID för uppgiftsarbetsflöde
 workflowInstanceID integer

Instans-ID för arbetsflödet som är associerat med uppgiften.
Folio för uppgiftsarbetsflöde
 workflowInstanceFolio string

Folio för arbetsflödesinstansen som är associerad med uppgiften.
Aktivitetsinstans-ID
 activityInstanceID integer

Aktivitetens aktivitetsinstans-ID.
Mål-ID för aktivitetsaktivitet
 activityInstanceDestinationID integer

Aktivitetens mål-ID för aktivitetsinstansen.
Aktivitetsaktivitetsnamn
 activityName string

Aktivitetens aktivitetsnamn.
Aktivitetshändelsenamn
 eventName string

Aktivitetens händelsenamn.
Beskrivning av aktivitetshändelse
 eventDescription string

Händelsebeskrivningen för aktiviteten.
upphovsman
 originator User
Åtgärder
 actions TaskActionsResponse
Uppgiftsinstruktioner
 instruction string

Instruktionerna som är associerade med uppgiften.

User

Name Sökväg Typ Description
Användarnamn
 username string

Användarens användarnamn.
Användar-FQN
 fqn string

Fullständigt kvalificerat namn på personen. Ex: bob@denallix.com, K2:Denallix\Bob
E-post för användare
 email string

Personens e-postadress.
Användarhanteraren
 manager string

Ansvarig för personen.
Användarens visningsnamn
 displayName string

Personens visningsnamn.

TaskActionsResponse

Name Sökväg Typ Description
Icke-diskutabla åtgärder
 nonBatchableActions array of string

Lista över åtgärder som inte kan vidtas utan att uppgiften tilldelas.
Batchbara åtgärder
 batchableActions array of string

Lista över åtgärder som kan vidtas utan att uppgiften tilldelas.
Systemåtgärder
 systemActions array of string

Lista över systemåtgärder.

Task

Name Sökväg Typ Description
Aktivitetsserienummer
 serialNumber string

Aktivitetens serienummer. Ex: 1234_5678
Aktivitetsstatus
 status string

Status för uppgiften. Exempel: Öppen, Slutförd, Strömsparläge, Allokerad, Tillgänglig
Startdatum för aktivitet
 taskStartDate date-time

Aktivitetens startdatum.
Varaktighet för aktivitetssparläge
 sleepUntil date-time

Datum och tid då aktiviteten aktiveras.
Aktivitetsprioritet
 priority integer

Uppgiftens prioritet.
URL för uppgiftsformulär
 formURL string

Uppgiftens form-URL.
URL för aktivitetsvyflöde
 viewFlowURL string

Visa flödets URL för uppgiften.
Uppgiftsarbetsflödes-ID
 workflowID integer

ID:t för arbetsflödet som är associerat med uppgiften.
Namn på uppgiftsarbetsflöde
 workflowName string

Namnet på arbetsflödet som är associerat med uppgiften.
Visningsnamn för uppgiftsarbetsflöde
 workflowDisplayName string

Visningsnamnet för arbetsflödet som är associerat med uppgiften.
Uppgiftsarbetsflödeskategori
 workflowCategory string

Kategorin för arbetsflödet som är associerat med uppgiften.
Instans-ID för uppgiftsarbetsflöde
 workflowInstanceID integer

Instans-ID för arbetsflödet som är associerat med uppgiften.
Folio för uppgiftsarbetsflöde
 workflowInstanceFolio string

Folio för arbetsflödesinstansen som är associerad med uppgiften.
Aktivitetsinstans-ID
 activityInstanceID integer

Aktivitetens aktivitetsinstans-ID.
Mål-ID för uppgift
 activityInstanceDestinationID integer

Aktivitetens mål-ID för aktivitetsinstansen.
Aktivitetsaktivitetsnamn
 activityName string

Aktivitetens aktivitetsnamn.
Aktivitetshändelsenamn
 eventName string

Aktivitetens händelsenamn.
Beskrivning av aktivitetshändelse
 eventDescription string

Händelsebeskrivningen för aktiviteten.
upphovsman
 originator User
Åtgärder
 actions TaskActionsResponse
Datafält för uppgiftsarbetsflöde
 workflowInstanceDataFields object

Datafälten i arbetsflödesinstansen.
Datafält för aktivitetsaktivitet
 activityDataFields object

Aktivitetens datafält.
XML-fält för uppgiftsarbetsflöde
 workflowInstanceXmlFields array of UserDefinedXmlField

XML-fälten i arbetsflödesinstansen.
Referenser till aktivitetsobjekt
 itemReferences object

Objektreferenserna för arbetsflödesinstansen.
undervisning
 instruction string
Datafältsträng för uppgiftsarbetsflöde
 workflowInstanceDataFieldsString string

Strängrepresentation av datafälten i arbetsflödesinstansen.
Referenssträng för aktivitetsobjekt
 itemReferencesString string

Sträng som representerar objektreferenserna för arbetsflödesinstansen.

WorkflowLabelsResponse[WorkflowLabel]

Name Sökväg Typ Description
Antal objekt
 itemCount integer

Antalet arbetsflöden.
Arbetsflöden
 workflows array of WorkflowLabel

En lista över arbetsflöden.

WorkflowLabel

Name Sökväg Typ Description
Arbetsflödes-ID
 id integer

ID:t för arbetsflödet.
Standardversion för arbetsflöde
 defaultVersionId integer

Standardarbetsflödesversionen.
Arbetsflödesnamn
 name string

Arbetsflödets namn.
Arbetsflödesmapp
 folder string

Arbetsflödesmappen.
Systemnamn för arbetsflöde
 systemName string

Namnet på arbetsflödessystemet.

WorkflowDataResponse

Name Sökväg Typ Description
workflowInfo
 workflowInfo WorkflowDefinition
Arbetsflödesschema
 workflowSchema string

Schemat för arbetsflödet.

WorkflowDefinition

Name Sökväg Typ Description
Arbetsflödesnamn
 name string

Namnet på arbetsflödet.
Arbetsflödesbeskrivning
 description string

Beskrivningen av arbetsflödet.
Arbetsflödesmapp
 folder string

Mappen (kategorin) för arbetsflödet.
Systemnamn för arbetsflöde
 systemName string

Arbetsflödets systemnamn.
Förväntad varaktighet för arbetsflöde
 expectedDuration integer

Arbetsflödets förväntade varaktighet.

EventInstanceWrapper

Name Sökväg Typ Description
EventInstance
 EventInstance EventInstance
Beskrivning av händelseinstans
 Description string

Beskrivning av händelseinstansen.
Förväntad varaktighet för händelseinstans
 ExpectedDuration integer

Förväntad varaktighet för händelseinstansen.
Händelseinstans-ID
 ID integer

ID för händelseinstansen.
Metadata för händelseinstans
 MetaData string

Metadata för händelseinstansen.
Namn på händelseinstans
 Name string

Namn på händelseinstansen.
Prioritet för händelseinstans
 Priority integer

Prioritet för händelseinstansen.
Startdatum för händelseinstans
 StartDate date-time

Datum och tid då händelseinstansen startade.

integer

Det här är den grundläggande datatypen heltal.

objekt

Detta är typen 'objekt'.