Przepływ pracy K2 (wersja zapoznawcza)
Użyj usługi interfejsu API przepływu pracy K2, aby zdalnie pracować z przepływami pracy i zadaniami.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Standard | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Standard | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| adres URL | https://portal.k2.com/ticket/default |
| Metadane łącznika | |
|---|---|
| Publisher | K2 |
| Witryna internetowa | https://www.k2.com |
| Zasady ochrony prywatności | https://www.k2.com/legal/privacy-policy |
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| K2 URL | ciąg | Adres URL K2 (przykład: https://[K2ID].onk2.com). | Prawda |
| Nazwa użytkownika | securestring | Nazwa użytkownika dla tego interfejsu API | Prawda |
| Hasło | securestring | Hasło dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobieranie akcji zadania |
Pobiera listę akcji zadania. |
| Pobieranie przepływu pracy |
Pobiera definicję przepływu pracy według identyfikatora. |
| Pobieranie przepływów pracy |
Pobierz listę dostępnych przepływów pracy. |
| Pobieranie zadań |
Uzyskaj listę zadań dostępnych dla połączonego użytkownika. |
| Pobieranie zdarzenia serwera |
Pobiera zdarzenie serwera według numeru seryjnego. |
| Pobierz zadanie |
Pobiera zadanie według numeru seryjnego. |
| Przypisywanie zadania |
Przypisuje zadanie bieżącemu użytkownikowi. |
| Uruchom przepływ pracy |
Tworzy i uruchamia nowe wystąpienie przepływu pracy. |
| Wznawianie zadania |
Budzi śpiące zadanie. |
| Zadanie akcji |
Wykonuje akcję przepływu pracy. |
| Zadanie przekierowania |
Wysyła zadanie do innej osoby. |
| Zadanie uśpienia |
Uśpienie zadania przez czas trwania, liczbę sekund lub do daty. |
| Zadanie wydania |
Zwalnia zadanie. |
| Zakończ zdarzenie serwera |
Wysyłanie odpowiedzi zakończenia do zadania serwera asynchronicznego w oczekiwaniu na odpowiedź |
Pobieranie akcji zadania
Pobiera listę akcji zadania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny
|
serialNumber | True | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
Zwraca
- Body
- TaskActionsResponse
Pobieranie przepływu pracy
Pobiera definicję przepływu pracy według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
id | True | integer |
Identyfikator przepływu pracy. |
Zwraca
- Body
- WorkflowDataResponse
Pobieranie przepływów pracy
Pobierz listę dostępnych przepływów pracy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ przepływu pracy
|
type | string |
Typ przepływu pracy. Możliwe do uruchomienia lub należące do niego. |
Zwraca
Pobieranie zadań
Uzyskaj listę zadań dostępnych dla połączonego użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wszystkie, przydzielone, śpiące, udostępnione, udostępnione
|
state | string |
Zwraca listę zadań dla połączonego użytkownika. |
Zwraca
- Body
- TasksResponse
Pobieranie zdarzenia serwera
Pobiera zdarzenie serwera według numeru seryjnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny zdarzenia serwera
|
serialNumber | True | string |
Numer seryjny zdarzenia serwera. Na przykład: 1234_5678. |
Zwraca
Pobierz zadanie
Pobiera zadanie według numeru seryjnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny
|
serialNumber | True | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
Zwraca
- Body
- Task
Przypisywanie zadania
Przypisuje zadanie bieżącemu użytkownikowi.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny
|
serialNumber | True | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
Zwraca
- response
- object
Uruchom przepływ pracy
Tworzy i uruchamia nowe wystąpienie przepływu pracy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
id | True | integer |
Określ identyfikator przepływu pracy, aby uruchomić wystąpienie. |
|
Szczegóły wystąpienia przepływu pracy
|
instance | True | dynamic |
Wyślij obiekt wystąpienia przepływu pracy, aby uruchomić przepływ pracy. |
Zwraca
- response
- integer
Wznawianie zadania
Budzi śpiące zadanie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny
|
serialNumber | True | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
Zwraca
- response
- object
Zadanie akcji
Wykonuje akcję przepływu pracy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny
|
serialNumber | True | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
|
Akcja niestandardowa
|
customAction | True | string |
Akcja zadania zdefiniowana przez przepływ pracy. |
|
Nazwa pola XML
|
name | string |
Nazwa pola XML. |
|
|
Wartość pola XML
|
value | string |
Wartość pola XML. |
|
|
Odwołania do elementów
|
ItemReferences | object |
Pola Odwołanie do elementu wystąpienia przepływu pracy. |
|
|
Pola danych
|
DataFields | object |
Pola danych wystąpienia przepływu pracy. |
Zadanie przekierowania
Wysyła zadanie do innej osoby.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny
|
serialNumber | True | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
|
Informacje o przekierowaniach
|
RedirectTo | True | string |
Osoba, do której zadanie jest przekierowywane. |
Zadanie uśpienia
Uśpienie zadania przez czas trwania, liczbę sekund lub do daty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny
|
serialNumber | True | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
|
Uśpienie dla
|
SleepFor | integer |
Liczba sekund uśpienia zadania. |
|
|
Śpij do
|
SleepUntil | date-time |
Data i godzina wznawiania zadania. Format: rrrr-MM-ddTHH:mm:ss:fffZ UTC |
Zadanie wydania
Zwalnia zadanie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny
|
serialNumber | True | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
Zakończ zdarzenie serwera
Wysyłanie odpowiedzi zakończenia do zadania serwera asynchronicznego w oczekiwaniu na odpowiedź
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer seryjny zdarzenia serwera
|
serialNumber | True | string |
Numer seryjny zdarzenia serwera. Na przykład: 1234_5678 |
|
Nazwa pola XML
|
name | string |
Nazwa pola XML. |
|
|
Wartość pola XML
|
value | string |
Wartość pola XML. |
|
|
Odwołania do elementów
|
ItemReferences | object |
Pola Odwołanie do elementu wystąpienia przepływu pracy. |
|
|
Pola danych
|
DataFields | object |
Pola danych wystąpienia przepływu pracy. |
Definicje
ServerEventDataResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Numer seryjny zdarzenia serwera
|
serialNumber | string |
Numer seryjny zdarzenia serwera. Na przykład: 1234_5678 |
|
Identyfikator przepływu pracy zdarzeń serwera
|
workflowID | integer |
Identyfikator przepływu pracy skojarzonego ze zdarzeniem serwera. |
|
Nazwa przepływu pracy zdarzeń serwera
|
workflowName | string |
Nazwa przepływu pracy skojarzonego ze zdarzeniem serwera. |
|
Nazwa wyświetlana przepływu pracy zdarzeń serwera
|
workflowDisplayName | string |
Nazwa wyświetlana przepływu pracy skojarzonego ze zdarzeniem serwera. |
|
Kategoria przepływu pracy zdarzeń serwera
|
workflowCategory | string |
Kategoria przepływu pracy skojarzonego ze zdarzeniem serwera. |
|
Identyfikator wystąpienia przepływu pracy zdarzeń serwera
|
workflowInstanceID | integer |
Identyfikator wystąpienia przepływu pracy skojarzonego ze zdarzeniem serwera. |
|
Folio przepływu pracy zdarzeń serwera
|
workflowInstanceFolio | string |
Folio wystąpienia przepływu pracy skojarzonego ze zdarzeniem serwera. |
|
Identyfikator wystąpienia działania zdarzenia serwera
|
activityInstanceID | integer |
Identyfikator wystąpienia działania zdarzenia serwera. |
|
Identyfikator docelowy działania zdarzenia serwera
|
activityInstanceDestinationID | integer |
Identyfikator docelowy wystąpienia działania zdarzenia serwera. |
|
Nazwa działania zdarzenia serwera
|
activityName | string |
Nazwa działania zdarzenia serwera. |
|
Nazwa zdarzenia serwera
|
eventName | string |
Nazwa zdarzenia serwera. |
|
Opis zdarzenia zdarzenia serwera
|
eventDescription | string |
Opis zdarzenia serwera. |
|
pomysłodawca
|
originator | User | |
|
eventInstance
|
eventInstance | EventInstanceWrapper | |
|
Pola danych działania zdarzeń serwera
|
dataFields | object |
Pola danych działania. |
|
Pola XML działania zdarzenia serwera
|
xmlFields | array of UserDefinedXmlField |
Pola XML działania. |
|
Odwołania do elementu zdarzenia serwera
|
itemReferences | object |
Element odwołuje się do wystąpienia przepływu pracy. |
|
Ciąg pól danych przepływu pracy zdarzeń serwera
|
workflowInstanceDataFieldsString | string |
Ciąg reprezentujący pola danych wystąpienia przepływu pracy. |
|
Ciąg odwołania do elementu zdarzenia serwera
|
itemReferencesString | string |
Ciąg reprezentujący odwołania do elementu wystąpienia przepływu pracy. |
|
viewFlowURL
|
viewFlowURL | string |
EventInstance
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Data rozpoczęcia wystąpienia zdarzenia
|
StartDate | date-time |
Data i godzina uruchomienia wystąpienia zdarzenia. |
|
Oczekiwany czas trwania wystąpienia zdarzenia
|
ExpectedDuration | integer |
Oczekiwany czas trwania wystąpienia zdarzenia. |
|
Priorytet wystąpienia zdarzenia
|
Priority | integer |
Priorytet wystąpienia zdarzenia. |
|
Metadane wystąpienia zdarzenia
|
MetaData | string |
Metadane dla wystąpienia zdarzenia. |
|
Opis wystąpienia zdarzenia
|
Description | string |
Opis wystąpienia zdarzenia. |
|
Nazwa wystąpienia zdarzenia
|
Name | string |
Nazwa wystąpienia zdarzenia. |
|
Identyfikator wystąpienia zdarzenia
|
ID | integer |
Identyfikator wystąpienia zdarzenia. |
UserDefinedXmlField
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa pola XML
|
name | string |
Nazwa pola XML. |
|
Wartość pola XML
|
value | string |
Wartość pola XML. |
ZadaniaResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba zadań
|
itemCount | integer |
Liczba zwróconych zadań. |
|
Tasks
|
tasks | array of TaskLite |
Co najmniej jedno zadanie. |
TaskLite
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Numer seryjny zadania
|
serialNumber | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
|
Stan zadania
|
status | string |
Stan zadania. Na przykład: Otwarte, Ukończone, Uśpienie, Przydzielone, Dostępne |
|
Data rozpoczęcia zadania
|
taskStartDate | date-time |
Data rozpoczęcia zadania. |
|
Czas trwania uśpienia zadania
|
sleepUntil | date-time |
Data i godzina wznawiania zadania. |
|
Priorytet zadania
|
priority | integer |
Priorytet zadania. |
|
Adres URL formularza zadania
|
formURL | string |
Adres URL formularza zadania. |
|
Adres URL przepływu widoku zadania
|
viewFlowURL | string |
Adres URL widoku przepływu zadania. |
|
Identyfikator przepływu pracy zadania
|
workflowID | integer |
Identyfikator przepływu pracy skojarzonego z zadaniem. |
|
Nazwa przepływu pracy zadania
|
workflowName | string |
Nazwa przepływu pracy skojarzonego z zadaniem. |
|
Nazwa wyświetlana przepływu pracy zadania
|
workflowDisplayName | string |
Nazwa wyświetlana przepływu pracy skojarzonego z zadaniem. |
|
Kategoria przepływu pracy zadania
|
workflowCategory | string |
Kategoria przepływu pracy skojarzonego z zadaniem. |
|
Identyfikator wystąpienia przepływu pracy zadania
|
workflowInstanceID | integer |
Identyfikator wystąpienia przepływu pracy skojarzonego z zadaniem. |
|
Folio przepływu pracy zadań
|
workflowInstanceFolio | string |
Folio wystąpienia przepływu pracy skojarzonego z zadaniem. |
|
Identyfikator wystąpienia zadania
|
activityInstanceID | integer |
Identyfikator wystąpienia działania zadania. |
|
Identyfikator docelowy działania zadania
|
activityInstanceDestinationID | integer |
Identyfikator docelowy wystąpienia działania zadania. |
|
Nazwa działania zadania
|
activityName | string |
Nazwa działania zadania. |
|
Nazwa zdarzenia zadania
|
eventName | string |
Nazwa zdarzenia zadania. |
|
Opis zdarzenia zadania
|
eventDescription | string |
Opis zdarzenia zadania. |
|
pomysłodawca
|
originator | User | |
|
działania
|
actions | TaskActionsResponse | |
|
Instrukcje dotyczące zadania
|
instruction | string |
Instrukcje skojarzone z zadaniem. |
User
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa użytkownika
|
username | string |
Nazwa użytkownika osoby. |
|
Nazwa FQN użytkownika
|
fqn | string |
W pełni kwalifikowane imię i nazwisko osoby. Na przykład: bob@denallix.com, K2:Denallix\Bob |
|
Adres e-mail użytkownika
|
string |
Adres e-mail osoby. |
|
|
Menedżer użytkowników
|
manager | string |
Kierownik osoby. |
|
Nazwa wyświetlana użytkownika
|
displayName | string |
Nazwa wyświetlana osoby. |
TaskActionsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Akcje nie do zniesienia
|
nonBatchableActions | array of string |
Lista akcji, których nie można wykonać bez przypisania zadania. |
|
Akcje z możliwością przetwarzania wsadowego
|
batchableActions | array of string |
Lista akcji, które można wykonać bez przypisywania zadania. |
|
Akcje systemowe
|
systemActions | array of string |
Lista akcji systemowych. |
Zadanie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Numer seryjny zadania
|
serialNumber | string |
Numer seryjny zadania. Na przykład: 1234_5678 |
|
Stan zadania
|
status | string |
Stan zadania. Na przykład: Otwarte, Ukończone, Uśpienie, Przydzielone, Dostępne |
|
Data rozpoczęcia zadania
|
taskStartDate | date-time |
Data rozpoczęcia zadania. |
|
Czas trwania uśpienia zadania
|
sleepUntil | date-time |
Data i godzina wznawiania zadania. |
|
Priorytet zadania
|
priority | integer |
Priorytet zadania. |
|
Adres URL formularza zadania
|
formURL | string |
Adres URL formularza zadania. |
|
Adres URL przepływu widoku zadania
|
viewFlowURL | string |
Adres URL widoku przepływu zadania. |
|
Identyfikator przepływu pracy zadania
|
workflowID | integer |
Identyfikator przepływu pracy skojarzonego z zadaniem. |
|
Nazwa przepływu pracy zadania
|
workflowName | string |
Nazwa przepływu pracy skojarzonego z zadaniem. |
|
Nazwa wyświetlana przepływu pracy zadania
|
workflowDisplayName | string |
Nazwa wyświetlana przepływu pracy skojarzonego z zadaniem. |
|
Kategoria przepływu pracy zadania
|
workflowCategory | string |
Kategoria przepływu pracy skojarzonego z zadaniem. |
|
Identyfikator wystąpienia przepływu pracy zadania
|
workflowInstanceID | integer |
Identyfikator wystąpienia przepływu pracy skojarzonego z zadaniem. |
|
Folio przepływu pracy zadań
|
workflowInstanceFolio | string |
Folio wystąpienia przepływu pracy skojarzonego z zadaniem. |
|
Identyfikator wystąpienia zadania
|
activityInstanceID | integer |
Identyfikator wystąpienia działania zadania. |
|
Identyfikator miejsca docelowego zadania
|
activityInstanceDestinationID | integer |
Identyfikator docelowy wystąpienia działania zadania. |
|
Nazwa działania zadania
|
activityName | string |
Nazwa działania zadania. |
|
Nazwa zdarzenia zadania
|
eventName | string |
Nazwa zdarzenia zadania. |
|
Opis zdarzenia zadania
|
eventDescription | string |
Opis zdarzenia zadania. |
|
pomysłodawca
|
originator | User | |
|
działania
|
actions | TaskActionsResponse | |
|
Pola danych przepływu pracy zadania
|
workflowInstanceDataFields | object |
Pola danych wystąpienia przepływu pracy. |
|
Pola danych działania zadania
|
activityDataFields | object |
Pola danych działania. |
|
Pola XML przepływu pracy zadania
|
workflowInstanceXmlFields | array of UserDefinedXmlField |
Pola XML wystąpienia przepływu pracy. |
|
Odwołania do elementu zadania
|
itemReferences | object |
Element odwołuje się do wystąpienia przepływu pracy. |
|
polecenie
|
instruction | string | |
|
Ciąg pól danych przepływu pracy zadania
|
workflowInstanceDataFieldsString | string |
Ciąg reprezentujący pola danych wystąpienia przepływu pracy. |
|
Ciąg odwołania do elementu zadania
|
itemReferencesString | string |
Ciąg reprezentujący odwołania do elementu wystąpienia przepływu pracy. |
WorkflowLabelsResponse[WorkflowLabel]
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba elementów
|
itemCount | integer |
Liczba przepływów pracy. |
|
Workflows
|
workflows | array of WorkflowLabel |
Lista przepływów pracy. |
Etykieta przepływu pracy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator przepływu pracy
|
id | integer |
Identyfikator przepływu pracy. |
|
Domyślna wersja przepływu pracy
|
defaultVersionId | integer |
Domyślna wersja przepływu pracy. |
|
Nazwa przepływu pracy
|
name | string |
Nazwa przepływu pracy. |
|
Folder przepływu pracy
|
folder | string |
Folder przepływu pracy. |
|
Nazwa systemu przepływu pracy
|
systemName | string |
Nazwa systemu przepływu pracy. |
WorkflowDataResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
workflowInfo
|
workflowInfo | WorkflowDefinition | |
|
Schemat przepływu pracy
|
workflowSchema | string |
Schemat przepływu pracy. |
Przepływ pracyDefinition
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa przepływu pracy
|
name | string |
Nazwa przepływu pracy. |
|
Opis przepływu pracy
|
description | string |
Opis przepływu pracy. |
|
Folder przepływu pracy
|
folder | string |
Folder (kategoria) przepływu pracy. |
|
Nazwa systemu przepływu pracy
|
systemName | string |
Nazwa systemu przepływu pracy. |
|
Oczekiwany czas trwania przepływu pracy
|
expectedDuration | integer |
Oczekiwany czas trwania przepływu pracy. |
EventInstanceWrapper
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
EventInstance
|
EventInstance | EventInstance | |
|
Opis wystąpienia zdarzenia
|
Description | string |
Opis wystąpienia zdarzenia. |
|
Oczekiwany czas trwania wystąpienia zdarzenia
|
ExpectedDuration | integer |
Oczekiwany czas trwania wystąpienia zdarzenia. |
|
Identyfikator wystąpienia zdarzenia
|
ID | integer |
Identyfikator wystąpienia zdarzenia. |
|
Metadane wystąpienia zdarzenia
|
MetaData | string |
Metadane dla wystąpienia zdarzenia. |
|
Nazwa wystąpienia zdarzenia
|
Name | string |
Nazwa wystąpienia zdarzenia. |
|
Priorytet wystąpienia zdarzenia
|
Priority | integer |
Priorytet wystąpienia zdarzenia. |
|
Data rozpoczęcia wystąpienia zdarzenia
|
StartDate | date-time |
Data i godzina uruchomienia wystąpienia zdarzenia. |
liczba całkowita
Jest to podstawowy typ danych "liczba całkowita".
obiekt
Jest to typ 'obiekt'.