Pracovní postup K2 (Preview)
Pomocí služby rozhraní API pracovního postupu K2 můžete vzdáleně pracovat s pracovními postupy a úlohami.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Standard | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Standard | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| URL | https://portal.k2.com/ticket/default |
| Metadata konektoru | |
|---|---|
| Vydavatel | K2 |
| Internetová stránka | https://www.k2.com |
| Zásady ochrany osobních údajů | https://www.k2.com/legal/privacy-policy |
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Nesdílitelné |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| K2 URL | řetězec | Vaše adresa URL K2 (příklad: https://[K2ID].onk2.com). | Pravdivé |
| Uživatelské jméno | securestring | Uživatelské jméno pro toto rozhraní API | Pravdivé |
| Heslo | securestring | Heslo pro toto rozhraní API | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Dokončení události serveru |
Odeslání odpovědi na dokončení úlohy asynchronního serveru čekající na odpověď |
| Přiřadit úkol |
Přiřadí úkol aktuálnímu uživateli. |
| Spustit pracovní postup |
Vytvoří a spustí novou instanci pracovního postupu. |
| Wake – úloha |
Probouzí spící úkol. |
| Získat pracovní postup |
Získá definici pracovního postupu podle ID. |
| Získat úkol |
Získá úkol podle sériového čísla. |
| Získání akcí úkolů |
Získá seznam akcí pro úkol. |
| Získání pracovních postupů |
Získejte seznam dostupných pracovních postupů. |
| Získání události serveru |
Získá událost serveru podle sériového čísla. |
| Získání úkolů |
Získejte seznam úkolů dostupných pro připojeného uživatele. |
| Úkol akce |
Provede akci pracovního postupu. |
| Úkol přesměrování |
Odešle úkol jiné osobě. |
| Úloha spánku |
Uspí úkol po dobu trvání, buď počet sekund, nebo do data. |
| Úloha vydání |
Uvolní úkol. |
Dokončení události serveru
Odeslání odpovědi na dokončení úlohy asynchronního serveru čekající na odpověď
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo události serveru
|
serialNumber | True | string |
Sériové číslo události serveru. Příklad: 1234_5678 |
|
Název pole XML
|
name | string |
Název pole XML. |
|
|
Hodnota pole XML
|
value | string |
Hodnota pole XML. |
|
|
Odkazy na položky
|
ItemReferences | object |
Pole Odkaz na položku instance pracovního postupu. |
|
|
Datová pole
|
DataFields | object |
Datová pole instance pracovního postupu. |
Přiřadit úkol
Přiřadí úkol aktuálnímu uživateli.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo
|
serialNumber | True | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
Návraty
- response
- object
Spustit pracovní postup
Vytvoří a spustí novou instanci pracovního postupu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
id | True | integer |
Zadejte ID pracovního postupu pro spuštění instance. |
|
Podrobnosti instance pracovního postupu
|
instance | True | dynamic |
Odeslání objektu instance pracovního postupu pro spuštění pracovního postupu |
Návraty
- response
- integer
Wake – úloha
Probouzí spící úkol.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo
|
serialNumber | True | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
Návraty
- response
- object
Získat pracovní postup
Získá definici pracovního postupu podle ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
id | True | integer |
ID pracovního postupu. |
Návraty
- Body
- WorkflowDataResponse
Získat úkol
Získá úkol podle sériového čísla.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo
|
serialNumber | True | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
Návraty
- Body
- Task
Získání akcí úkolů
Získá seznam akcí pro úkol.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo
|
serialNumber | True | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
Návraty
- Body
- TaskActionsResponse
Získání pracovních postupů
Získejte seznam dostupných pracovních postupů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ pracovního postupu
|
type | string |
Typ pracovního postupu. Spustitelný nebo vlastněný |
Návraty
Získání události serveru
Získá událost serveru podle sériového čísla.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo události serveru
|
serialNumber | True | string |
Sériové číslo události serveru. Příklad: 1234_5678. |
Návraty
Získání úkolů
Získejte seznam úkolů dostupných pro připojeného uživatele.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Vše, Přiděleno, Spící, SharedFrom, SharedTo
|
state | string |
Vrátí seznam úkolů pro připojeného uživatele. |
Návraty
- Body
- TasksResponse
Úkol akce
Provede akci pracovního postupu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo
|
serialNumber | True | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
|
Vlastní akce
|
customAction | True | string |
Akce úkolu definovaná pracovním postupem. |
|
Název pole XML
|
name | string |
Název pole XML. |
|
|
Hodnota pole XML
|
value | string |
Hodnota pole XML. |
|
|
Odkazy na položky
|
ItemReferences | object |
Pole Odkaz na položku instance pracovního postupu. |
|
|
Datová pole
|
DataFields | object |
Datová pole instance pracovního postupu. |
Úkol přesměrování
Odešle úkol jiné osobě.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo
|
serialNumber | True | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
|
Informace o přesměrování
|
RedirectTo | True | string |
Osoba, na kterou je úkol přesměrován. |
Úloha spánku
Uspí úkol po dobu trvání, buď počet sekund, nebo do data.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo
|
serialNumber | True | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
|
Režim spánku pro
|
SleepFor | integer |
Počet sekund, po které má být úkol v režimu spánku. |
|
|
Do režimu spánku
|
SleepUntil | date-time |
Datum a čas, kdy se má úkol probudit. Formát: rrrr-MM-ddTHH:mm:ss:fffZ UTC |
Úloha vydání
Uvolní úkol.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Sériové číslo
|
serialNumber | True | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
Definice
ServerEventDataResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Sériové číslo události serveru
|
serialNumber | string |
Sériové číslo události serveru. Příklad: 1234_5678 |
|
ID pracovního postupu události serveru
|
workflowID | integer |
ID pracovního postupu přidruženého k události serveru. |
|
Název pracovního postupu události serveru
|
workflowName | string |
Název pracovního postupu přidruženého k události serveru. |
|
Zobrazovaný název pracovního postupu události serveru
|
workflowDisplayName | string |
Zobrazovaný název pracovního postupu přidruženého k události serveru. |
|
Kategorie pracovního postupu události serveru
|
workflowCategory | string |
Kategorie pracovního postupu přidruženého k události serveru. |
|
ID instance pracovního postupu události serveru
|
workflowInstanceID | integer |
ID instance pracovního postupu přidruženého k události serveru. |
|
Pracovní postup události serveru – folio
|
workflowInstanceFolio | string |
Folio instance pracovního postupu přidružené k události serveru. |
|
ID instance aktivity události serveru
|
activityInstanceID | integer |
ID instance aktivity události serveru. |
|
ID cíle aktivity události serveru
|
activityInstanceDestinationID | integer |
ID cílové instance aktivity události serveru. |
|
Název aktivity události serveru
|
activityName | string |
Název aktivity události serveru. |
|
Název události serveru
|
eventName | string |
Název události serveru. |
|
Popis události serveru
|
eventDescription | string |
Popis události serveru. |
|
původce
|
originator | User | |
|
instance eventInstance
|
eventInstance | EventInstanceWrapper | |
|
Pole dat o aktivitě události serveru
|
dataFields | object |
Datová pole aktivity. |
|
Pole XML aktivity serveru
|
xmlFields | array of UserDefinedXmlField |
Pole XML aktivity. |
|
Odkazy na položku události serveru
|
itemReferences | object |
Odkazy na položku instance pracovního postupu. |
|
Řetězec datových polí pracovního postupu událostí serveru
|
workflowInstanceDataFieldsString | string |
Řetězec představuje datová pole instance pracovního postupu. |
|
Řetězec odkazů na položku události serveru
|
itemReferencesString | string |
Řetězec představující odkazy na položku instance pracovního postupu |
|
viewFlowURL
|
viewFlowURL | string |
Instance EventInstance
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Počáteční datum instance události
|
StartDate | date-time |
Datum a čas spuštění instance události |
|
Očekávaná doba trvání instance události
|
ExpectedDuration | integer |
Očekávaná doba trvání instance události |
|
Priorita instance události
|
Priority | integer |
Priorita instance události |
|
Metadata instance událostí
|
MetaData | string |
Metadata instance události. |
|
Popis instance události
|
Description | string |
Popis instance události |
|
Název instance události
|
Name | string |
Název instance události. |
|
ID instance události
|
ID | integer |
ID instance události. |
UserDefinedXmlField
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název pole XML
|
name | string |
Název pole XML. |
|
Hodnota pole XML
|
value | string |
Hodnota pole XML. |
TasksResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Počet úkolů
|
itemCount | integer |
Počet vrácených úkolů. |
|
Tasks
|
tasks | array of TaskLite |
Jeden nebo více úkolů. |
TaskLite
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Sériové číslo úkolu
|
serialNumber | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
|
Stav úlohy
|
status | string |
Stav úkolu. Příklad: Otevření, Dokončeno, Režim spánku, Přiděleno, K dispozici |
|
Datum zahájení úkolu
|
taskStartDate | date-time |
Počáteční datum úkolu. |
|
Doba spánku úkolu
|
sleepUntil | date-time |
Datum a čas, kdy se úkol probouzí. |
|
Priorita úkolu
|
priority | integer |
Priorita úkolu. |
|
Adresa URL formuláře úkolu
|
formURL | string |
Adresa URL formuláře úkolu. |
|
Adresa URL toku zobrazení úloh
|
viewFlowURL | string |
Adresa URL toku zobrazení úlohy. |
|
ID pracovního postupu úkolu
|
workflowID | integer |
ID pracovního postupu přidruženého k úkolu. |
|
Název pracovního postupu úkolu
|
workflowName | string |
Název pracovního postupu přidruženého k úkolu. |
|
Zobrazovaný název pracovního postupu úkolu
|
workflowDisplayName | string |
Zobrazovaný název pracovního postupu přidruženého k úkolu. |
|
Kategorie pracovního postupu úkolu
|
workflowCategory | string |
Kategorie pracovního postupu přidruženého k úkolu. |
|
ID instance pracovního postupu úkolu
|
workflowInstanceID | integer |
ID instance pracovního postupu přidruženého k úkolu. |
|
Folio pracovního postupu úkolu
|
workflowInstanceFolio | string |
Folio instance pracovního postupu přidružené k úkolu. |
|
ID instance úlohy
|
activityInstanceID | integer |
ID instance aktivity úkolu. |
|
ID cíle aktivity úkolu
|
activityInstanceDestinationID | integer |
ID cílové instance aktivity úkolu. |
|
Název aktivity úkolu
|
activityName | string |
Název aktivity úkolu. |
|
Název události úkolu
|
eventName | string |
Název události úkolu. |
|
Popis události úkolu
|
eventDescription | string |
Popis události úkolu. |
|
původce
|
originator | User | |
|
Akce
|
actions | TaskActionsResponse | |
|
Pokyny k úkolu
|
instruction | string |
Pokyny přidružené k úkolu. |
Uživatel
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Uživatelské jméno
|
username | string |
Uživatelské jméno osoby. |
|
Plně kvalifikovaný název uživatele
|
fqn | string |
Plně kvalifikované jméno osoby. Příklad: bob@denallix.com, K2:Denallix\Bob |
|
E-mail uživatele
|
string |
E-mailová adresa osoby. |
|
|
Správce uživatelů
|
manager | string |
Nadřízený osoby. |
|
Zobrazované jméno uživatele
|
displayName | string |
Zobrazované jméno osoby. |
TaskActionsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Akce, které se nedají odložit
|
nonBatchableActions | array of string |
Seznam akcí, které nelze provést bez přiřazení úkolu |
|
Dávkové akce
|
batchableActions | array of string |
Seznam akcí, které lze provést bez přiřazení úkolu |
|
Systémové akce
|
systemActions | array of string |
Seznam systémových akcí |
Task
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Sériové číslo úkolu
|
serialNumber | string |
Sériové číslo úkolu. Příklad: 1234_5678 |
|
Stav úlohy
|
status | string |
Stav úkolu. Příklad: Otevření, Dokončeno, Režim spánku, Přiděleno, K dispozici |
|
Datum zahájení úkolu
|
taskStartDate | date-time |
Počáteční datum úkolu. |
|
Doba spánku úkolu
|
sleepUntil | date-time |
Datum a čas, kdy se úkol probouzí. |
|
Priorita úkolu
|
priority | integer |
Priorita úkolu. |
|
Adresa URL formuláře úkolu
|
formURL | string |
Adresa URL formuláře úkolu. |
|
Adresa URL toku zobrazení úloh
|
viewFlowURL | string |
Adresa URL toku zobrazení úlohy. |
|
ID pracovního postupu úkolu
|
workflowID | integer |
ID pracovního postupu přidruženého k úkolu. |
|
Název pracovního postupu úkolu
|
workflowName | string |
Název pracovního postupu přidruženého k úkolu. |
|
Zobrazovaný název pracovního postupu úkolu
|
workflowDisplayName | string |
Zobrazovaný název pracovního postupu přidruženého k úkolu. |
|
Kategorie pracovního postupu úkolu
|
workflowCategory | string |
Kategorie pracovního postupu přidruženého k úkolu. |
|
ID instance pracovního postupu úkolu
|
workflowInstanceID | integer |
ID instance pracovního postupu přidruženého k úkolu. |
|
Folio pracovního postupu úkolu
|
workflowInstanceFolio | string |
Folio instance pracovního postupu přidružené k úkolu. |
|
ID instance úlohy
|
activityInstanceID | integer |
ID instance aktivity úkolu. |
|
ID cíle úkolu
|
activityInstanceDestinationID | integer |
ID cílové instance aktivity úkolu. |
|
Název aktivity úkolu
|
activityName | string |
Název aktivity úkolu. |
|
Název události úkolu
|
eventName | string |
Název události úkolu. |
|
Popis události úkolu
|
eventDescription | string |
Popis události úkolu. |
|
původce
|
originator | User | |
|
Akce
|
actions | TaskActionsResponse | |
|
Pole dat pracovního postupu úkolů
|
workflowInstanceDataFields | object |
Datová pole instance pracovního postupu. |
|
Pole dat aktivit úkolů
|
activityDataFields | object |
Datová pole aktivity. |
|
Pole XML pracovního postupu úkolu
|
workflowInstanceXmlFields | array of UserDefinedXmlField |
Pole XML instance pracovního postupu. |
|
Odkazy na položky úkolu
|
itemReferences | object |
Odkazy na položku instance pracovního postupu. |
|
instrukce
|
instruction | string | |
|
Řetězec datových polí pracovního postupu úkolu
|
workflowInstanceDataFieldsString | string |
Řetězec představuje datová pole instance pracovního postupu. |
|
Řetězec odkazů na položku úkolu
|
itemReferencesString | string |
Řetězec představující odkazy na položku instance pracovního postupu |
WorkflowLabelsResponse[WorkflowLabel]
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Počet položek
|
itemCount | integer |
Počet pracovních postupů. |
|
Pracovní postupy
|
workflows | array of WorkflowLabel |
Seznam pracovních postupů |
WorkflowLabel
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID pracovního postupu
|
id | integer |
ID pracovního postupu. |
|
Výchozí verze pracovního postupu
|
defaultVersionId | integer |
Výchozí verze pracovního postupu. |
|
Název pracovního postupu
|
name | string |
Název pracovního postupu. |
|
Složka pracovního postupu
|
folder | string |
Složka pracovního postupu. |
|
Název systému pracovního postupu
|
systemName | string |
Název systému pracovního postupu. |
WorkflowDataResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
workflowInfo
|
workflowInfo | WorkflowDefinition | |
|
Schéma pracovního postupu
|
workflowSchema | string |
Schéma pracovního postupu. |
WorkflowDefinition
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název pracovního postupu
|
name | string |
Název pracovního postupu. |
|
Popis pracovního postupu
|
description | string |
Popis pracovního postupu. |
|
Složka pracovního postupu
|
folder | string |
Složka (kategorie) pracovního postupu. |
|
Název systému pracovního postupu
|
systemName | string |
Název systému pracovního postupu. |
|
Očekávaná doba trvání pracovního postupu
|
expectedDuration | integer |
Očekávaná doba trvání pracovního postupu. |
EventInstanceWrapper
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Instance EventInstance
|
EventInstance | EventInstance | |
|
Popis instance události
|
Description | string |
Popis instance události |
|
Očekávaná doba trvání instance události
|
ExpectedDuration | integer |
Očekávaná doba trvání instance události |
|
ID instance události
|
ID | integer |
ID instance události. |
|
Metadata instance událostí
|
MetaData | string |
Metadata instance události. |
|
Název instance události
|
Name | string |
Název instance události. |
|
Priorita instance události
|
Priority | integer |
Priorita instance události |
|
Počáteční datum instance události
|
StartDate | date-time |
Datum a čas spuštění instance události |
integer
Toto je základní datový typ integer.
objekt
Toto je typ "object".