Zwinność (wersja zapoznawcza)
Agile-e umożliwia scentralizowanie logiki biznesowej i procesów oraz uwidacznienie ich jako mikrousług dla nowych lub istniejących aplikacji. Dzięki łącznikowi Agile-e uzyskujesz dostęp do wielu usług, takich jak zarządzanie procesami biznesowymi (BPM), role, słowa kluczowe, szablony i inne.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | 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 | Premium | 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 | Premium | 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 | |
|---|---|
| Name | Zespół pomocy technicznej zwinności e |
| adres URL | https://agilite.io |
| support@agilite.io |
| Metadane łącznika | |
|---|---|
| Publisher | Zwinność e |
| Witryna internetowa | https://agilite.io |
| Zasady ochrony prywatności | https://agilite.io/privacy-policy/ |
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Udostępnialne |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz Omówienie łączników dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Określ adres URL serwera zwinności e API. (Użyj znaku "https://api.agilite.io" dla rozwiązania Agile-e Cloud) | ciąg | Określ adres URL serwera zwinności e API. (Użyj znaku "https://api.agilite.io" dla rozwiązania Agile-e Cloud) | Prawda |
| Klucz interfejsu API (wygenerowany w obszarze Administracjahttps://portal.agilite.io) | securestring | Klucz interfejsu API (wygenerowany w obszarze Administracjahttps://portal.agilite.io) | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Generuj liczbę (numerowanie) |
Generuje unikatową liczbę na podstawie podanego "profile-key" |
| Pobieranie etykiety według wartości (słów kluczowych) |
Zwraca etykietę słowa kluczowego na podstawie podanej wartości "profile-key" i "value-key" |
| Pobieranie kluczy profilu według grupy (słów kluczowych) |
Zwraca wszystkie klucze profilu słowa kluczowego na podstawie podanej nazwy grupy |
| Pobieranie stanu rekordu (BPM) |
Pobierz stan rekordu BPM dla co najmniej jednego rekordu, aby uwzględnić bieżący stan, który jest odpowiedzialny za rekord, historię przepływu pracy i inne informacje opisujące bieżący stan i reguły dla rekordu |
| Pobieranie wartości według etykiety (słów kluczowych) |
Zwraca wartość słowa kluczowego na podstawie podanej wartości "profile-key" i "label-key" |
| Pobieranie według klucza profilu (BPM) |
Uzyskaj pełny profil BPM z konfiguracją i opcjami procesu. |
| Pobieranie według klucza profilu (słów kluczowych) |
Zwraca pary klucz/wartość określonego profilu słowa kluczowego na podstawie podanego klucza profilu |
| Przypisywanie roli (ról) |
Przypisz określoną rolę użytkownika, która ma zastosowanie do określonego rekordu. Przykładem może być recenzent dokumentu lub osoba zatwierdzająca urlop |
| Rejestrowanie rekordu BPM (BPM) |
Zarejestruj nowy rekord BPM. Rekord jest przypisywany z identyfikatorem recordID używanym do cyklu życia rekordu w celu zidentyfikowania rekordu, postępu, historii i stanu przez cały czas |
| Uzyskiwanie przypisanych ról (ról) |
Pobieranie osób odpowiedzialnych za wcześniej przypisaną rolę dla określonego rekordu |
| Uzyskiwanie roli (ról) |
Uzyskaj osoby odpowiedzialne przypisane do ról w portalu administracyjnym Agile-e. Te role są nie tylko istotne dla określonych rekordów lub procesów biznesowych i są bardziej typowe dla ról dla całej firmy w organizacji |
| Wykonywanie (BPM) |
Przesyła opcję w bieżącym kroku przepływu pracy. W zależności od reguł biznesowych rekord będzie przechodził do następnego kroku w procesie i zwracał informacje o następnym kroku do wywołującego interfejsu API |
| Wykonywanie (szablony) |
Przetwarza i zwraca szablon z elementu Agilit-e na podstawie podanego "profile-key" |
Generuj liczbę (numerowanie)
Generuje unikatową liczbę na podstawie podanego "profile-key"
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz profilu
|
profile-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
|
object |
Zwraca
- Body
- StdJSONResponse
Pobieranie etykiety według wartości (słów kluczowych)
Zwraca etykietę słowa kluczowego na podstawie podanej wartości "profile-key" i "value-key"
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz profilu
|
profile-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
Klucz wartości
|
value-key | True | string |
Klucz wartość na liście Etykieta/Wartość dla profilu docelowego |
Zwraca
- Body
- StdJSONResponse
Pobieranie kluczy profilu według grupy (słów kluczowych)
Zwraca wszystkie klucze profilu słowa kluczowego na podstawie podanej nazwy grupy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa grupy
|
group-name | True | string |
Nazwa grupy używana do grupowania profilów słów kluczowych |
|
Sortuj
|
sort | string |
Opcjonalny parametr sortowania zwróconego wyniku klucza/wartości |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of string |
Pobieranie stanu rekordu (BPM)
Pobierz stan rekordu BPM dla co najmniej jednego rekordu, aby uwzględnić bieżący stan, który jest odpowiedzialny za rekord, historię przepływu pracy i inne informacje opisujące bieżący stan i reguły dla rekordu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucze procesu
|
process-keys | string |
Filtruj, aby zidentyfikować procesy biznesowe, dla których będą zwracane rekordy. Ten klucz można znaleźć w profilu BPM w portalu administracyjnym Agile-e — (oddzielnie przy użyciu przecinków) |
|
|
Identyfikatory rekordów BPM
|
bpm-record-ids | string |
filtruj, aby zwracać tylko rekordy z określonymi identyfikatorami rekordów. RecordId jest rejestrowany przez interfejs API registerBPMRecord dla nowych rekordów i można go znaleźć we właściwości recordID odpowiedzi interfejsu API BPM — (oddzielnie przy użyciu przecinków) |
|
|
Nazwy kroków
|
step-names | string |
Filtruj, aby zwracać tylko rekordy, które są obecnie do określonych kroków przepływu pracy — (oddzielne przy użyciu przecinków) |
|
|
Odpowiedzialni użytkownicy
|
responsible-users | string |
Filtruj, aby zwracać tylko rekordy, które są obecnie przypisane do określonego adresu e-mail (es) — (oddzielne przy użyciu przecinków) |
|
|
Odpowiedni użytkownicy
|
relevant-users | string |
Filtruj, aby zwracać tylko rekordy, które są istotne dla określonego adresu e-mail (es) — (oddzielne przy użyciu przecinków) |
|
|
Uwzględnij historię
|
include-history | boolean |
Określ, czy obiekt historii ma być zwracany z informacjami o stanie rekordu |
|
|
Opcje dołączania kroków
|
include-step-options | boolean |
Określ, czy obiekt opcji kroków powinien być zwracany z informacjami o stanie rekordu |
|
|
Uwzględnij widoczne obiekty
|
include-visible-objects | boolean |
Określ, czy obiekt widocznych obiektów ma być zwracany z informacjami o stanie rekordu |
Zwraca
- Przedmioty
- GetBPMRecordState
Pobieranie wartości według etykiety (słów kluczowych)
Zwraca wartość słowa kluczowego na podstawie podanej wartości "profile-key" i "label-key"
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz profilu
|
profile-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
Klucz etykiety
|
label-key | True | string |
Klucz Etykieta na liście Etykieta/Wartość dla profilu docelowego |
Zwraca
- Body
- StdJSONResponse
Pobieranie według klucza profilu (BPM)
Uzyskaj pełny profil BPM z konfiguracją i opcjami procesu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz profilu
|
profile-key | True | string |
Unikatowy klucz dla profilu docelowego |
Zwraca
- Body
- GetBPMProfile
Pobieranie według klucza profilu (słów kluczowych)
Zwraca pary klucz/wartość określonego profilu słowa kluczowego na podstawie podanego klucza profilu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz profilu
|
profile-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
Sortuj
|
sort | string |
Opcjonalny parametr sortowania zwróconego wyniku klucza/wartości |
Zwraca
- Przedmioty
- KeywordValues
Przypisywanie roli (ról)
Przypisz określoną rolę użytkownika, która ma zastosowanie do określonego rekordu. Przykładem może być recenzent dokumentu lub osoba zatwierdzająca urlop
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz procesu
|
process-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
Identyfikator rekordu BPM
|
bpm-record-id | True | string |
Określa rekord, dla którego jest ustawiana rola. Identyfikator jest zarejestrowany przez interfejs API registerBPMRecord dla nowych rekordów i można go znaleźć we właściwości recordID odpowiedzi interfejsu API BPM |
|
Bieżący użytkownik
|
current-user | True | string |
Adres e-mail użytkownika, który ustawia rolę. Zazwyczaj jest to użytkownik zalogowany podczas wywoływania interfejsu API |
|
Nazwa roli
|
role-name | True | string |
Nazwa przypisanej roli. Np. osoba zatwierdzająca lub recenzent |
|
Odpowiedzialni użytkownicy
|
responsible-users | True | string |
Adresy e-mail użytkowników, którzy są przypisani do tej roli — (rozdziel je przecinkami) |
Zwraca
dane
- dane
- object
Rejestrowanie rekordu BPM (BPM)
Zarejestruj nowy rekord BPM. Rekord jest przypisywany z identyfikatorem recordID używanym do cyklu życia rekordu w celu zidentyfikowania rekordu, postępu, historii i stanu przez cały czas
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz procesu
|
process-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
Bieżący użytkownik
|
current-user | True | string |
Adres e-mail użytkownika rejestrującego rekord. Zazwyczaj jest to użytkownik zalogowany podczas wywoływania interfejsu API |
Zwraca
- Body
- RegisterBPMRecord
Uzyskiwanie przypisanych ról (ról)
Pobieranie osób odpowiedzialnych za wcześniej przypisaną rolę dla określonego rekordu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz procesu
|
process-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
Identyfikator rekordu BPM
|
bpm-record-id | True | string |
Określa rekord, dla którego jest ustawiana rola. Identyfikator jest zarejestrowany przez interfejs API registerBPMRecord dla nowych rekordów i można go znaleźć we właściwości recordID odpowiedzi interfejsu API BPM |
|
Nazwa roli
|
role-names | True | string |
Zapytania o role (rozdzielane przecinkami) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
Name
|
name | string | |
|
Użytkownicy
|
users | array of object | |
|
Email
|
users.email | string |
Uzyskiwanie roli (ról)
Uzyskaj osoby odpowiedzialne przypisane do ról w portalu administracyjnym Agile-e. Te role są nie tylko istotne dla określonych rekordów lub procesów biznesowych i są bardziej typowe dla ról dla całej firmy w organizacji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwy ról
|
role-names | True | string |
Określ nazwy ról, dla których chcesz pobrać odpowiedzialnych użytkowników — (oddzielone przecinkami) |
|
Poziomy warunkowe
|
conditional-levels | string |
Określ dodatkowe poziomy, których można użyć do określenia odpowiedniej osoby dla roli. Przykładem poziomu może być nazwa działu (jeśli chcesz pobrać Menedżera działu) lub nazwa produktu (jeśli chcesz pobrać Menedżera produktu) — (oddzielnie przy użyciu przecinków) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
responsibleUsers
|
responsibleUsers | array of string |
responsibleUsers |
Wykonywanie (BPM)
Przesyła opcję w bieżącym kroku przepływu pracy. W zależności od reguł biznesowych rekord będzie przechodził do następnego kroku w procesie i zwracał informacje o następnym kroku do wywołującego interfejsu API
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz procesu
|
process-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
Identyfikator rekordu BPM
|
bpm-record-id | True | string |
Identyfikuje przesyłany rekord. Identyfikator jest zarejestrowany przez interfejs API registerBPMRecord dla nowych rekordów i można go znaleźć we właściwości recordID odpowiedzi interfejsu API BPM |
|
Wybrana opcja
|
option-selected | True | string |
Określa opcję wybraną przez użytkownika do wykonania w ramach procesu przesyłania. Ta wartość musi odpowiadać prawidłowej opcji kroku w profilu przepływu pracy |
|
Bieżący użytkownik
|
current-user | True | string |
Adres e-mail użytkownika, który przesyła krok BPM. Zazwyczaj jest to użytkownik zalogowany podczas wywoływania interfejsu API |
|
Komentarze kroków przepływu pracy
|
comments | string |
Przekazuje komentarze do procesu wykonywania, który zostanie sygnaturowany do historii przepływu pracy. Zwykle jest to używane, jeśli użytkownik odrzuca krok lub żąda więcej informacji |
|
|
|
object |
Zwraca
- Body
- ExecuteBPMResult
Wykonywanie (szablony)
Przetwarza i zwraca szablon z elementu Agilit-e na podstawie podanego "profile-key"
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Klucz profilu
|
profile-key | True | string |
Unikatowy klucz dla profilu docelowego |
|
|
object |
Zwraca
- Body
- StdJSONResponse
Definicje
ExecuteBPMResult
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Opis kroku procesu
|
description | string |
Krótki opis wyjaśniający krok procesu |
|
Czas trwania umowy SLA (godz.)
|
duration | string |
Czas trwania umowy SLA w godzinach. Podaj wartość 0, jeśli nie ma zastosowania |
|
Sygnatura zdarzeń kroku procesu
|
eventStamp | string |
Sygnatura zdarzeń dla bieżącego kroku procesu |
|
Instrukcje kroków
|
instructions | string |
Instrukcje dotyczące odpowiedzialnego użytkownika podczas kroku |
|
Klucz kroku procesu
|
key | string |
Unikatowy klucz do identyfikowania kroku procesu |
|
Nazwa kroku procesu
|
name | string |
Krótka nazwa kroku procesu |
|
Klucz profilu BPM
|
processKey | string |
Unikatowy klucz do identyfikowania profilu BPM |
|
Etap przetwarzania
|
processStage | string |
Klucz definiujący etap procesu bieżącego kroku |
|
Typ odpowiedzialności
|
responsibility | string |
Odpowiedzialność oparta na użytkownikach/rolach |
|
Rola odpowiedzialna za krok procesu
|
responsibleRole | string |
Rola odpowiedzialna za bieżący krok procesu |
|
Krok procesu Odpowiedzialny użytkownicy
|
responsibleUsers | array of string |
Użytkownicy odpowiedzialni za bieżący krok procesu |
|
stepOptions
|
stepOptions | array of object | |
|
Opis opcji kroku
|
stepOptions.description | string |
Krótki opis wyjaśniający opcję kroku |
|
Sygnatura zdarzeń opcji kroku
|
stepOptions.eventStamp | array of string |
Sygnatura zdarzeń dla bieżącej opcji kroku |
|
Nazwa opcji kroku
|
stepOptions.name | string |
Krótka nazwa opcji kroku |
|
Następny krok
|
stepOptions.nextStep | string |
Następnym krokiem procesu biznesowego będzie kierowany do. Pozostaw puste, jeśli nie ma dalszych kroków |
|
Uwagi dotyczące opcji kroku
|
stepOptions.notes | string |
Opcjonalne uwagi dotyczące opcji kroku |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Identyfikator obiektu opcji kroku
|
stepOptions.visibleObjects.id | string |
Identyfikator składnika, do którego odwołuje się interfejs użytkownika |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Etykieta typu wyboru
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Etykieta dla wybranego wyboru |
|
Wartość typu opcji
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Wartość wybranego wyboru |
|
Etykieta opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.label | string |
Etykieta definiująca pole wejściowe lub edytowalny składnik |
|
Komunikaty opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Komunikaty, które mają być używane, gdy sprawdzanie poprawności opcji wejściowych kończy się niepowodzeniem |
|
Typ opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.type | string |
Definiuje typ pola wejściowego lub edytowalnego składnika, który ma być używany |
|
Czy można edytować obiekt opcji kroku
|
stepOptions.visibleObjects.isEditable | boolean |
Czy składnik, do którego odwołuje się element, można edytować dla danych wejściowych użytkownika |
|
Jest obowiązkowy obiekt opcji kroku
|
stepOptions.visibleObjects.isMandatory | boolean |
Czy składnik, do którego odwołuje się odwołanie, wymaga danych wejściowych użytkownika |
|
visibleObjects
|
visibleObjects | array of object | |
|
Identyfikator obiektu kroku procesu
|
visibleObjects.id | string |
Identyfikator składnika, do którego odwołuje się interfejs użytkownika |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Etykieta typu wyboru
|
visibleObjects.inputOptions.choices.label | string |
Etykieta dla wybranego wyboru |
|
Wartość typu opcji
|
visibleObjects.inputOptions.choices.value | string |
Wartość wybranego wyboru |
|
Etykieta opcji wejściowych
|
visibleObjects.inputOptions.label | string |
Etykieta definiująca pole wejściowe lub edytowalny składnik |
|
Komunikaty opcji wejściowych
|
visibleObjects.inputOptions.messages | array of string |
Komunikaty, które mają być używane, gdy sprawdzanie poprawności opcji wejściowych kończy się niepowodzeniem |
|
Typ opcji wejściowych
|
visibleObjects.inputOptions.type | string |
Definiuje typ pola wejściowego lub edytowalnego składnika, który ma być używany |
|
Czy można edytować obiekt kroku procesu
|
visibleObjects.isEditable | boolean |
Czy składnik, do którego odwołuje się element, można edytować dla danych wejściowych użytkownika |
|
Czy obiekt kroku procesu jest obowiązkowy
|
visibleObjects.isMandatory | boolean |
Czy składnik, do którego odwołuje się odwołanie, wymaga danych wejściowych użytkownika |
GetBPMProfile
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
appAdmin
|
appAdmin | array of object | |
|
Adres e-mail administratora aplikacji
|
appAdmin.email | string |
Adres e-mail administratora bieżącego profilu BPM |
|
Adres URL aplikacji BPM
|
appUrl | string |
Opcjonalny adres URL aplikacji, który korzysta z bieżącego profilu NARZĘDZIA BPM |
|
Opis profilu BPM
|
description | string |
Krótki opis wyjaśniający profil BPM |
|
Nazwa grupy profilów BPM
|
groupName | string |
Opcjonalne grupowanie profilu BPM |
|
Klucz profilu BPM
|
key | string |
Unikatowy klucz do identyfikowania profilu BPM |
|
Nazwa profilu NARZĘDZIA BPM
|
name | string |
Krótka nazwa profilu BPM |
|
Uwagi dotyczące profilu narzędzia BPM
|
notes | string |
Opcjonalne uwagi dotyczące profilu BPM |
|
processSteps
|
processSteps | array of object | |
|
Opis kroku procesu
|
processSteps.description | string |
Krótki opis wyjaśniający krok procesu |
|
Czas trwania umowy SLA (godz.)
|
processSteps.duration | string |
Czas trwania umowy SLA w godzinach. Podaj wartość 0, jeśli nie ma zastosowania |
|
Pierwszy krok
|
processSteps.firstStep | boolean |
Określ, czy rekord krok procesu jest pierwszym krokiem w procesie biznesowym |
|
Instrukcje kroków
|
processSteps.instructions | string |
Instrukcje dotyczące odpowiedzialnego użytkownika podczas kroku |
|
Klucz kroku procesu
|
processSteps.key | string |
Unikatowy klucz do identyfikowania kroku procesu |
|
Nazwa kroku procesu
|
processSteps.name | string |
Krótka nazwa kroku procesu |
|
Etap przetwarzania
|
processSteps.processStage | string |
Klucz definiujący etap procesu bieżącego kroku |
|
Adres URL odwołania do kroku procesu
|
processSteps.referenceUrl | string |
Adres URL odwołania dla kroku procesu |
|
Typ odpowiedzialności
|
processSteps.responsibility | string |
Odpowiedzialność oparta na użytkownikach/rolach |
|
Rola odpowiedzialna za krok procesu
|
processSteps.responsibleRole | string |
Rola odpowiedzialna za bieżący krok |
|
roleLevels
|
processSteps.roleLevels | array of string |
Poziomy ról warunkowych |
|
stepOptions
|
processSteps.stepOptions | array of object | |
|
Opis opcji kroku
|
processSteps.stepOptions.description | string |
Krótki opis wyjaśniający opcję kroku |
|
Nazwa opcji kroku
|
processSteps.stepOptions.name | string |
Krótka nazwa opcji kroku |
|
Następny krok
|
processSteps.stepOptions.nextStep | string |
Następnym krokiem procesu biznesowego będzie kierowany do. Pozostaw puste, jeśli nie ma dalszych kroków |
|
Uwagi dotyczące opcji kroku
|
processSteps.stepOptions.notes | string |
Opcjonalne uwagi dotyczące opcji kroku |
|
visibleObjects
|
processSteps.stepOptions.visibleObjects | array of object | |
|
Identyfikator obiektu opcji kroku
|
processSteps.stepOptions.visibleObjects.id | string |
Identyfikator składnika, do którego odwołuje się interfejs użytkownika |
|
choices
|
processSteps.stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Etykieta typu wyboru
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.label | string |
Etykieta dla wybranego wyboru |
|
Wartość typu opcji
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.value | string |
Wartość wybranego wyboru |
|
Etykieta opcji wejściowych
|
processSteps.stepOptions.visibleObjects.inputOptions.label | string |
Etykieta definiująca pole wejściowe lub edytowalny składnik |
|
Komunikaty opcji wejściowych
|
processSteps.stepOptions.visibleObjects.inputOptions.messages | array of string |
Komunikaty, które mają być używane, gdy sprawdzanie poprawności opcji wejściowych kończy się niepowodzeniem |
|
Typ opcji wejściowych
|
processSteps.stepOptions.visibleObjects.inputOptions.type | string |
Definiuje typ pola wejściowego lub edytowalnego składnika, który ma być używany |
|
Czy można edytować obiekt opcji kroku
|
processSteps.stepOptions.visibleObjects.isEditable | boolean |
Czy składnik, do którego odwołuje się element, można edytować dla danych wejściowych użytkownika |
|
Jest obowiązkowy obiekt opcji kroku
|
processSteps.stepOptions.visibleObjects.isMandatory | boolean |
Czy składnik, do którego odwołuje się odwołanie, wymaga danych wejściowych użytkownika |
|
visibleObjects
|
processSteps.visibleObjects | array of object | |
|
Identyfikator obiektu kroku procesu
|
processSteps.visibleObjects.id | string |
Identyfikator składnika, do którego odwołuje się interfejs użytkownika |
|
choices
|
processSteps.visibleObjects.inputOptions.choices | array of object | |
|
Etykieta typu wyboru
|
processSteps.visibleObjects.inputOptions.choices.label | string |
Etykieta dla wybranego wyboru |
|
Wartość typu opcji
|
processSteps.visibleObjects.inputOptions.choices.value | string |
Wartość wybranego wyboru |
|
Etykieta opcji wejściowych
|
processSteps.visibleObjects.inputOptions.label | string |
Etykieta definiująca pole wejściowe lub edytowalny składnik |
|
Komunikaty opcji wejściowych
|
processSteps.visibleObjects.inputOptions.messages | array of string |
Komunikaty, które mają być używane, gdy sprawdzanie poprawności opcji wejściowych kończy się niepowodzeniem |
|
Typ opcji wejściowych
|
processSteps.visibleObjects.inputOptions.type | string |
Definiuje typ pola wejściowego lub edytowalnego składnika, który ma być używany |
|
Czy można edytować obiekt kroku procesu
|
processSteps.visibleObjects.isEditable | boolean |
Czy składnik, do którego odwołuje się element, można edytować dla danych wejściowych użytkownika |
|
Czy obiekt kroku procesu jest obowiązkowy
|
processSteps.visibleObjects.isMandatory | boolean |
Czy składnik, do którego odwołuje się odwołanie, wymaga danych wejściowych użytkownika |
|
Adres URL odwołania do profilu narzędzia BPM
|
referenceUrl | string |
Opcjonalny adres URL, do którego można się odwołać dla bieżącego profilu narzędzia BPM |
GetBPMRecordState
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Opis kroku procesu
|
description | string |
Krótki opis wyjaśniający krok procesu |
|
Czas trwania umowy SLA (godz.)
|
duration | string |
Czas trwania umowy SLA w godzinach. Podaj wartość 0, jeśli nie ma zastosowania |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Nazwa historii sygnatur zdarzeń
|
eventStampHistory.eventName | string |
Nazwa sygnatury zdarzeń |
|
Sygnatura czasowa historii sygnatury zdarzeń
|
eventStampHistory.timeStamp | date-time |
Sygnatura czasowa wystąpienia sygnatury zdarzeń |
|
historia
|
history | array of object | |
|
Komentarze historii
|
history.comments | string |
Opcjonalne komentarze dodane podczas tworzenia wpisu Historia |
|
Bieżąca rola historii
|
history.currentRole | string |
Bieżąca rola w momencie wpisu Historia |
|
Historia bieżącego użytkownika
|
history.currentUser | string |
Bieżący użytkownik w momencie wpisu Historia |
|
Czas trwania kroku
|
history.duration | string |
Czas (w minutach) rekord istniał w bieżącym kroku procesu przed wykonaniem akcji |
|
Sygnatura zdarzeń historii
|
history.eventStamp | array of string |
Sygnatury zdarzeń, które wystąpiły w momencie wpisu Historia |
|
Z kroku
|
history.fromStep | string |
Klucz kroku procesu rekord BPM pochodzi z w momencie wpisu Historia |
|
Z nazwy kroku
|
history.fromStepName | string |
Nazwa kroku procesu rekordu BPM pochodzi z wpisu Historia |
|
Wybrana opcja Historia
|
history.optionSelected | string |
Opcja wybrana podczas wykonywania akcji rekordu BPM |
|
Klucz procesu BPM historii
|
history.processKey | string |
Unikatowy klucz procesu BPM dla wpisu Historia |
|
Etap procesu historii
|
history.processStage | string |
Etap procesu w momencie wpisu Historia |
|
Identyfikator rekordu BPM historii
|
history.recordId | string |
Identyfikator rekordu dla rekordu powiązanego z narzędziem BPM wygenerowanego podczas procesu rejestrowania rekordu BPM |
|
Rola odpowiedzialna za historię
|
history.responsibleRole | string |
Odpowiedzialna rola rekordu BPM w momencie wpisu Historia |
|
Historia odpowiedzialnych użytkowników
|
history.responsibleUsers | array of string |
Odpowiedzialni użytkownicy w momencie wpisu Historia |
|
Data przesłania historii
|
history.submissionDate | date-time |
Data/godzina wykonania akcji rekordu BPM |
|
Etap przetwarzania
|
history.toProcessStage | string |
Etap procesu rekordu BPM w momencie wpisu Historia |
|
Do kroku
|
history.toStep | string |
Klucz kroku procesu dla rekordu BPM w momencie wpisu Historia |
|
Nazwa kroku
|
history.toStepName | string |
Nazwa kroku procesu rekordu BPM w momencie wpisu Historia |
|
Instrukcje kroków
|
instructions | string |
Instrukcje dotyczące odpowiedzialnego użytkownika podczas kroku |
|
Klucz kroku procesu
|
key | string |
Unikatowy klucz do identyfikowania kroku procesu |
|
Nazwa kroku procesu
|
name | string |
Krótka nazwa kroku procesu |
|
Klucz profilu BPM
|
processKey | string |
Unikatowy klucz do identyfikowania profilu BPM |
|
Etap przetwarzania
|
processStage | string |
Klucz definiujący etap procesu bieżącego kroku |
|
Identyfikator rekordu BPM
|
recordId | string |
Identyfikator rekordu wygenerowany przez moduł BPM podczas rejestrowania rekordu BPM |
|
Dokumentacja rekordów BPM
|
recordRef | string |
Liczba czytelna wygenerowana przez moduł BPM przy użyciu modułu Numerowanie podczas rejestrowania rekordu BPM |
|
Adres URL odwołania do kroku procesu
|
referenceUrl | string |
Adres URL odwołania dla kroku procesu |
|
Rola odpowiedzialna za krok procesu
|
responsibleRole | string |
Rola odpowiedzialna za bieżący krok |
|
Krok procesu Odpowiedzialny użytkownicy
|
responsibleUsers | array of string |
Odpowiedzialni użytkownicy dla bieżącego kroku procesu |
|
roles
|
roles | array of object | |
|
Nazwa roli
|
roles.name | string |
Nazwa roli |
|
users
|
roles.users | array of object | |
|
Adres e-mail roli
|
roles.users.email | string |
Adresy e-mail połączone z nazwą roli |
|
stepOptions
|
stepOptions | array of object | |
|
Opis opcji kroku
|
stepOptions.description | string |
Krótki opis wyjaśniający opcję kroku |
|
Sygnatura zdarzeń opcji kroku
|
stepOptions.eventStamp | array of string |
Sygnatura zdarzeń dla bieżącej opcji kroku |
|
Nazwa opcji kroku
|
stepOptions.name | string |
Krótka nazwa opcji kroku |
|
Następny krok
|
stepOptions.nextStep | string |
Następnym krokiem procesu biznesowego będzie kierowany do. Pozostaw puste, jeśli nie ma dalszych kroków |
|
Uwagi dotyczące opcji kroku
|
stepOptions.notes | string |
Opcjonalne uwagi dotyczące opcji kroku |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Identyfikator obiektu opcji kroku
|
stepOptions.visibleObjects.id | string |
Identyfikator składnika, do którego odwołuje się interfejs użytkownika |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Etykieta typu wyboru
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Etykieta dla wybranego wyboru |
|
Wartość typu opcji
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Wartość wybranego wyboru |
|
Etykieta opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.label | string |
Etykieta definiująca pole wejściowe lub edytowalny składnik |
|
Komunikaty opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Komunikaty, które mają być używane, gdy sprawdzanie poprawności opcji wejściowych kończy się niepowodzeniem |
|
Typ opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.type | string |
Definiuje typ pola wejściowego lub edytowalnego składnika, który ma być używany |
|
Czy można edytować obiekt opcji kroku
|
stepOptions.visibleObjects.isEditable | boolean |
Czy składnik, do którego odwołuje się element, można edytować dla danych wejściowych użytkownika |
|
Jest obowiązkowy obiekt opcji kroku
|
stepOptions.visibleObjects.isMandatory | boolean |
Czy składnik, do którego odwołuje się odwołanie, wymaga danych wejściowych użytkownika |
|
Przesłane do kroku
|
submittedIntoStep | date-time |
Data/godzina przesłania rekordu BPM do bieżącego kroku procesu |
|
Docelowy czas trwania
|
targetTimeDuration | date-time |
Data/godzina rekordu BPM musi być wykonywana na podstawie czasu trwania umowy SLA |
|
visibleObjects
|
visibleObjects | array of object | |
|
Identyfikator obiektu kroku procesu
|
visibleObjects.id | string |
Identyfikator składnika, do którego odwołuje się interfejs użytkownika |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Etykieta typu wyboru
|
visibleObjects.inputOptions.choices.label | string |
Etykieta dla wybranego wyboru |
|
Wartość typu opcji
|
visibleObjects.inputOptions.choices.value | string |
Wartość wybranego wyboru |
|
Etykieta opcji wejściowych
|
visibleObjects.inputOptions.label | string |
Etykieta definiująca pole wejściowe lub edytowalny składnik |
|
Komunikaty opcji wejściowych
|
visibleObjects.inputOptions.messages | array of string |
Komunikaty, które mają być używane, gdy sprawdzanie poprawności opcji wejściowych kończy się niepowodzeniem |
|
Typ opcji wejściowych
|
visibleObjects.inputOptions.type | string |
Definiuje typ pola wejściowego lub edytowalnego składnika, który ma być używany |
|
Czy można edytować obiekt kroku procesu
|
visibleObjects.isEditable | boolean |
Czy składnik, do którego odwołuje się element, można edytować dla danych wejściowych użytkownika |
|
Czy obiekt kroku procesu jest obowiązkowy
|
visibleObjects.isMandatory | boolean |
Czy składnik, do którego odwołuje się odwołanie, wymaga danych wejściowych użytkownika |
Słowa kluczoweValues
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Etykieta
|
label | string | |
|
Wartość
|
value | string |
RegisterBPMRecord
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Opis kroku procesu
|
description | string |
Krótki opis wyjaśniający krok procesu |
|
Czas trwania umowy SLA (godz.)
|
duration | string |
Czas trwania umowy SLA w godzinach. Podaj wartość 0, jeśli nie ma zastosowania |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Nazwa historii sygnatur zdarzeń
|
eventStampHistory.eventName | string |
Nazwa sygnatury zdarzeń |
|
Sygnatura czasowa historii sygnatury zdarzeń
|
eventStampHistory.timeStamp | date-time |
Sygnatura czasowa wystąpienia sygnatury zdarzeń |
|
historia
|
history | array of object | |
|
Komentarze historii
|
history.comments | string |
Opcjonalne komentarze dodane podczas tworzenia wpisu Historia |
|
Bieżąca rola historii
|
history.currentRole | string |
Bieżąca rola w momencie wpisu Historia |
|
Historia bieżącego użytkownika
|
history.currentUser | string |
Bieżący użytkownik w momencie wpisu Historia |
|
Czas trwania kroku
|
history.duration | string |
Czas (w minutach) rekord istniał w bieżącym kroku procesu przed wykonaniem akcji |
|
Sygnatura zdarzeń historii
|
history.eventStamp | array of string |
Sygnatury zdarzeń, które wystąpiły w momencie wpisu Historia |
|
Z kroku
|
history.fromStep | string |
Klucz kroku procesu rekord BPM pochodzi z w momencie wpisu Historia |
|
Z nazwy kroku
|
history.fromStepName | string |
Nazwa kroku procesu rekordu BPM pochodzi z wpisu Historia |
|
Wybrana opcja Historia
|
history.optionSelected | string |
Opcja wybrana podczas wykonywania akcji rekordu BPM |
|
Klucz procesu BPM historii
|
history.processKey | string |
Unikatowy klucz procesu BPM dla wpisu Historia |
|
Etap procesu historii
|
history.processStage | string |
Etap procesu w momencie wpisu Historia |
|
Identyfikator rekordu BPM historii
|
history.recordId | string |
Identyfikator rekordu dla rekordu powiązanego z narzędziem BPM wygenerowanego podczas procesu rejestrowania rekordu BPM |
|
Rola odpowiedzialna za historię
|
history.responsibleRole | string |
Odpowiedzialna rola rekordu BPM w momencie wpisu Historia |
|
Historia odpowiedzialnych użytkowników
|
history.responsibleUsers | array of string |
Odpowiedzialni użytkownicy w momencie wpisu Historia |
|
Data przesłania historii
|
history.submissionDate | date-time |
Data/godzina wykonania akcji rekordu BPM |
|
Etap przetwarzania
|
history.toProcessStage | string |
Etap procesu rekordu BPM w momencie wpisu Historia |
|
Do kroku
|
history.toStep | string |
Klucz kroku procesu dla rekordu BPM w momencie wpisu Historia |
|
Nazwa kroku
|
history.toStepName | string |
Nazwa kroku procesu rekordu BPM w momencie wpisu Historia |
|
Instrukcje kroków
|
instructions | string |
Instrukcje dotyczące odpowiedzialnego użytkownika podczas kroku |
|
Klucz kroku procesu
|
key | string |
Unikatowy klucz do identyfikowania kroku procesu |
|
Nazwa kroku procesu
|
name | string |
Krótka nazwa kroku procesu |
|
Klucz profilu BPM
|
processKey | string |
Unikatowy klucz do identyfikowania profilu BPM |
|
Etap przetwarzania
|
processStage | string |
Klucz definiujący etap procesu bieżącego kroku |
|
Identyfikator rekordu BPM
|
recordId | string |
Identyfikator rekordu wygenerowany przez moduł BPM podczas rejestrowania rekordu BPM |
|
Dokumentacja rekordów BPM
|
recordRef | string |
Liczba czytelna wygenerowana przez moduł BPM przy użyciu modułu Numerowanie podczas rejestrowania rekordu BPM |
|
Adres URL odwołania do kroku procesu
|
referenceUrl | string |
Adres URL odwołania dla kroku procesu |
|
Rola odpowiedzialna za krok procesu
|
responsibleRole | string |
Rola odpowiedzialna za bieżący krok procesu |
|
Krok procesu Odpowiedzialny użytkownicy
|
responsibleUsers | array of string |
Użytkownicy odpowiedzialni za bieżący krok procesu |
|
roles
|
roles | array of object | |
|
Nazwa roli
|
roles.name | string |
Nazwa roli |
|
users
|
roles.users | array of object | |
|
Adres e-mail roli
|
roles.users.email | string |
Adresy e-mail połączone z nazwą roli |
|
stepOptions
|
stepOptions | array of object | |
|
Opis opcji kroku
|
stepOptions.description | string |
Krótki opis wyjaśniający opcję kroku |
|
Sygnatura zdarzeń opcji kroku
|
stepOptions.eventStamp | array of string |
Sygnatura zdarzeń dla bieżącej opcji kroku |
|
Nazwa opcji kroku
|
stepOptions.name | string |
Krótka nazwa opcji kroku |
|
Następny krok
|
stepOptions.nextStep | string |
Następnym krokiem procesu biznesowego będzie kierowany do. Pozostaw puste, jeśli nie ma dalszych kroków |
|
Uwagi dotyczące opcji kroku
|
stepOptions.notes | string |
Opcjonalne uwagi dotyczące opcji kroku |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Identyfikator obiektu opcji kroku
|
stepOptions.visibleObjects.id | string |
Identyfikator składnika, do którego odwołuje się interfejs użytkownika |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Etykieta typu wyboru
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Etykieta dla wybranego wyboru |
|
Wartość typu opcji
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Wartość wybranego wyboru |
|
Etykieta opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.label | string |
Etykieta definiująca pole wejściowe lub edytowalny składnik |
|
Komunikaty opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Komunikaty, które mają być używane, gdy sprawdzanie poprawności opcji wejściowych kończy się niepowodzeniem |
|
Typ opcji wejściowych
|
stepOptions.visibleObjects.inputOptions.type | string |
Definiuje typ pola wejściowego lub edytowalnego składnika, który ma być używany |
|
Czy można edytować obiekt opcji kroku
|
stepOptions.visibleObjects.isEditable | boolean |
Czy składnik, do którego odwołuje się element, można edytować dla danych wejściowych użytkownika |
|
Jest obowiązkowy obiekt opcji kroku
|
stepOptions.visibleObjects.isMandatory | boolean |
Czy składnik, do którego odwołuje się odwołanie, wymaga danych wejściowych użytkownika |
|
visibleObjects
|
visibleObjects | array of object | |
|
Identyfikator obiektu kroku procesu
|
visibleObjects.id | string |
Identyfikator składnika, do którego odwołuje się interfejs użytkownika |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Etykieta typu wyboru
|
visibleObjects.inputOptions.choices.label | string |
Etykieta dla wybranego wyboru |
|
Wartość typu opcji
|
visibleObjects.inputOptions.choices.value | string |
Wartość wybranego wyboru |
|
Etykieta opcji wejściowych
|
visibleObjects.inputOptions.label | string |
Etykieta definiująca pole wejściowe lub edytowalny składnik |
|
Komunikaty opcji wejściowych
|
visibleObjects.inputOptions.messages | array of string |
Komunikaty, które mają być używane, gdy sprawdzanie poprawności opcji wejściowych kończy się niepowodzeniem |
|
Typ opcji wejściowych
|
visibleObjects.inputOptions.type | string |
Definiuje typ pola wejściowego lub edytowalnego składnika, który ma być używany |
|
Czy można edytować obiekt kroku procesu
|
visibleObjects.isEditable | boolean |
Czy składnik, do którego odwołuje się element, można edytować dla danych wejściowych użytkownika |
|
Czy obiekt kroku procesu jest obowiązkowy
|
visibleObjects.isMandatory | boolean |
Czy składnik, do którego odwołuje się odwołanie, wymaga danych wejściowych użytkownika |
StdJSONResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wynik
|
result | string |
Wynik |
obiekt
Jest to typ 'obiekt'.