Agilite (Preview)

Agilit-e umožňuje centralizovat obchodní logiku a procesy a vystavit je jako mikroslužby novým nebo existujícím aplikacím. S konektorem Agilit-e získáte přístup k mnoha službám, včetně správy obchodních procesů (BPM), rolí, klíčových slov, šablon a dalších.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	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	Premium	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	Premium	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
Název	Tým podpory Agilit-e
URL	https://agilite.io
Email	support@agilite.io

Metadata konektoru
Vydavatel	Agilit-e
Internetová stránka	https://agilite.io
Zásady ochrany osobních údajů	https://agilite.io/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	Sdíletelný

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení je možné sdílet. Pokud se power app sdílí s jiným uživatelem, sdílí se i připojení. Další informace najdete v přehledu konektorů pro aplikace plátna – Power Apps | Microsoft Docs

Název	Typ	Description	Povinné
Zadejte adresu URL serveru Agilit-e API. (Použití 'https://api.agilite.io' pro Agilit-e Cloud)	řetězec	Zadejte adresu URL serveru Agilit-e API. (Použití 'https://api.agilite.io' pro Agilit-e Cloud)	Pravdivé
Klíč rozhraní API (vygenerovaný vhttps://portal.agilite.io části Správa)	securestring	Klíč rozhraní API (vygenerovaný vhttps://portal.agilite.io části Správa)	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Přiřazení role (rolí)	Přiřaďte uživatelem zadanou roli, která se vztahuje na konkrétní záznam. Příkladem může být kontrolor dokumentu nebo schvalovatel
Registrace záznamu BPM (BPM)	Zaregistrujte nový záznam BPM. Záznam je přiřazený id záznamu, který se používá pro životní cyklus záznamu k identifikaci záznamu, jeho průběhu, historie a stavu najednou.
Spustit (BPM)	Odešle možnost v aktuálním kroku pracovního postupu. V závislosti na obchodních pravidlech se záznam provede dalším krokem procesu a vrátí informace o dalším kroku do volajícího rozhraní API.
Spustit (šablony)	Zpracovává a vrací šablonu z Agilit-e na základě zadaného klíče profilu.
Vygenerovat číslo (číslování)	Vygeneruje jedinečné číslo na základě zadaného klíče profilu.
Získat podle klíče profilu (klíčová slova)	Vrátí páry klíč/hodnota konkrétního profilu klíčového slova na základě zadané hodnoty profile-key.
Získání hodnoty podle popisku (klíčová slova)	Vrátí hodnotu klíčového slova na základě zadané hodnoty profile-key a label-key.
Získání klíčů profilu podle skupiny (klíčová slova)	Vrátí všechny klíče profilu klíčového slova na základě zadaného názvu skupiny.
Získání podle klíče profilu (BPM)	Získejte úplný profil BPM s konfigurací a možnostmi procesu.
Získání popisku podle hodnoty (klíčová slova)	Vrátí popisek klíčového slova na základě zadané hodnoty profile-key a value-key.
Získání přiřazených rolí (rolí)	Získání zodpovědných osob za dříve přiřazenou roli pro konkrétní záznam
Získání role (rolí)	Získejte zodpovědné osoby, které jsou přiřazené k rolím na portálu pro správu Agilit-e. Tyto role nejsou relevantní jenom pro konkrétní záznamy nebo obchodní procesy a obvykle se používají pro role celé společnosti v organizaci.
Získání stavu záznamu (BPM)	Získání stavu záznamu BPM pro jeden nebo více záznamů, aby zahrnoval aktuální stav, který je zodpovědný za záznam, historii pracovního postupu a další informace pro popis aktuálního stavu a pravidel záznamu

Přiřazení role (rolí)

ID operace:

assignRole

Přiřaďte uživatelem zadanou roli, která se vztahuje na konkrétní záznam. Příkladem může být kontrolor dokumentu nebo schvalovatel

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč procesu	process-key	True	string	Jedinečný klíč pro cílový profil
ID záznamu BPM	bpm-record-id	True	string	Identifikuje záznam, pro který se role nastavuje. ID je registrováno rozhraním API registerBPMRecord pro nové záznamy a lze ho najít ve vlastnosti recordID odpovědí rozhraní API BPM.
Aktuální uživatel	current-user	True	string	E-mailová adresa uživatele, který roli nastavuje. Obvykle se jedná o uživatele, který je přihlášený v době volání rozhraní API.
Název role	role-name	True	string	Název přiřazené role. Např. schvalovatel nebo revidujícím
Zodpovědní uživatelé	responsible-users	True	string	E-mailové adresy uživatelů, kteří jsou přiřazeni k této roli – (oddělené čárkami)

Návraty

data

data

object

Registrace záznamu BPM (BPM)

ID operace:

registerBPMRecord

Zaregistrujte nový záznam BPM. Záznam je přiřazený id záznamu, který se používá pro životní cyklus záznamu k identifikaci záznamu, jeho průběhu, historie a stavu najednou.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč procesu	process-key	True	string	Jedinečný klíč pro cílový profil
Aktuální uživatel	current-user	True	string	E-mailová adresa uživatele, který záznam registruje. Obvykle se jedná o uživatele, který je přihlášený v době volání rozhraní API.

Návraty

Body

RegisterBPMRecord

Spustit (BPM)

ID operace:

executeBPM

Odešle možnost v aktuálním kroku pracovního postupu. V závislosti na obchodních pravidlech se záznam provede dalším krokem procesu a vrátí informace o dalším kroku do volajícího rozhraní API.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč procesu	process-key	True	string	Jedinečný klíč pro cílový profil
ID záznamu BPM	bpm-record-id	True	string	Identifikuje odeslaný záznam. ID je registrováno rozhraním API registerBPMRecord pro nové záznamy a lze ho najít ve vlastnosti recordID odpovědí rozhraní API BPM.
Vybraná možnost	option-selected	True	string	Identifikuje možnost vybranou uživatelem, která se má spustit jako součást procesu odeslání. Tato hodnota musí odpovídat platné možnosti kroku v profilu pracovního postupu.
Aktuální uživatel	current-user	True	string	E-mailová adresa uživatele, který odesílá krok BPM. Obvykle se jedná o uživatele, který je přihlášený v době volání rozhraní API.
Komentáře ke kroku pracovního postupu	comments		string	Předá komentáře do procesu provádění, který se označí do historie pracovního postupu. To se obvykle použije, pokud uživatel odmítne nějaký krok nebo požádá o další informace.
			object

Návraty

Body

ExecuteBPMResult

Spustit (šablony)

ID operace:

executeTemplates

Zpracovává a vrací šablonu z Agilit-e na základě zadaného klíče profilu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč profilu	profile-key	True	string	Jedinečný klíč pro cílový profil
			object

Návraty

Body

StdJSONResponse

Vygenerovat číslo (číslování)

ID operace:

generateNumber

Vygeneruje jedinečné číslo na základě zadaného klíče profilu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč profilu	profile-key	True	string	Jedinečný klíč pro cílový profil
			object

Návraty

Body

StdJSONResponse

Získat podle klíče profilu (klíčová slova)

ID operace:

getKeywordsByProfileKey

Vrátí páry klíč/hodnota konkrétního profilu klíčového slova na základě zadané hodnoty profile-key.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč profilu	profile-key	True	string	Jedinečný klíč pro cílový profil
Seřadit	sort		string	Volitelný parametr pro seřazení vráceného výsledku klíče a hodnoty

Návraty

Položky

KeywordValues

Získání hodnoty podle popisku (klíčová slova)

ID operace:

getKeywordsValueByLabel

Vrátí hodnotu klíčového slova na základě zadané hodnoty profile-key a label-key.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč profilu	profile-key	True	string	Jedinečný klíč pro cílový profil
Klíč popisku	label-key	True	string	Klíč Popisek v seznamu Popisek/Hodnota pro cílový profil

Návraty

Body

StdJSONResponse

Získání klíčů profilu podle skupiny (klíčová slova)

ID operace:

getKeywordProfileKeysByGroup

Vrátí všechny klíče profilu klíčového slova na základě zadaného názvu skupiny.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název skupiny	group-name	True	string	Název skupiny použitý k seskupení profilů klíčových slov
Seřadit	sort		string	Volitelný parametr pro seřazení vráceného výsledku klíče a hodnoty

Návraty

Name	Cesta	Typ	Description
		array of string

Získání podle klíče profilu (BPM)

ID operace:

getBPMByProfileKey

Získejte úplný profil BPM s konfigurací a možnostmi procesu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč profilu	profile-key	True	string	Jedinečný klíč pro cílový profil

Návraty

Body

GetBPMProfile

Získání popisku podle hodnoty (klíčová slova)

ID operace:

getKeywordsLabelByValue

Vrátí popisek klíčového slova na základě zadané hodnoty profile-key a value-key.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč profilu	profile-key	True	string	Jedinečný klíč pro cílový profil
Klíč hodnoty	value-key	True	string	Klíč hodnoty v seznamu Popisek/Hodnota pro cílový profil

Návraty

Body

StdJSONResponse

Získání přiřazených rolí (rolí)

ID operace:

getAssignedRoles

Získání zodpovědných osob za dříve přiřazenou roli pro konkrétní záznam

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíč procesu	process-key	True	string	Jedinečný klíč pro cílový profil
ID záznamu BPM	bpm-record-id	True	string	Identifikuje záznam, pro který se role nastavuje. ID je registrováno rozhraním API registerBPMRecord pro nové záznamy a lze ho najít ve vlastnosti recordID odpovědí rozhraní API BPM.
Název role	role-names	True	string	Role, které se mají dotazovat (oddělené čárkami)

Návraty

Name	Cesta	Typ	Description
		array of object
Název	name	string
Uživatelé	users	array of object
Email	users.email	string

Získání role (rolí)

ID operace:

getRole

Získejte zodpovědné osoby, které jsou přiřazené k rolím na portálu pro správu Agilit-e. Tyto role nejsou relevantní jenom pro konkrétní záznamy nebo obchodní procesy a obvykle se používají pro role celé společnosti v organizaci.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Názvy rolí	role-names	True	string	Zadejte názvy rolí, za které chcete načíst zodpovědné uživatele ( oddělte je čárkami).
Podmíněné úrovně	conditional-levels		string	Zadejte další úrovně, které lze použít k určení správné osoby pro danou roli. Příkladem úrovně může být název oddělení (pokud chcete načíst správce oddělení) nebo název produktu (pokud chcete načíst Produktový manažer) – (oddělené čárkami)

Návraty

Name	Cesta	Typ	Description
responsibleUsers	responsibleUsers	array of string	responsibleUsers

Získání stavu záznamu (BPM)

ID operace:

getBPMRecordState

Získání stavu záznamu BPM pro jeden nebo více záznamů, aby zahrnoval aktuální stav, který je zodpovědný za záznam, historii pracovního postupu a další informace pro popis aktuálního stavu a pravidel záznamu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Klíče procesu	process-keys		string	Filtr pro identifikaci obchodních procesů, pro které budou vráceny záznamy. Tento klíč najdete v profilu BPM na portálu pro správu Agilit-e – (oddělené čárkami)
ID záznamů BPM	bpm-record-ids		string	filtruje pouze záznamy s konkrétními ID záznamů. Id záznamu je registrováno rozhraním API registerBPMRecord pro nové záznamy a lze jej najít ve vlastnosti recordID odpovědí rozhraní API BPM – (oddělené čárkami)
Názvy kroků	step-names		string	Filtrovat tak, aby vracely jenom záznamy, které jsou aktuálně v zadaných krocích pracovního postupu – (oddělené čárkami)
Zodpovědní uživatelé	responsible-users		string	Filtrovat tak, aby se vracely jenom záznamy, které jsou aktuálně přiřazené k zadaným e-mailovým adresám – (oddělte je čárkami).
Relevantní uživatelé	relevant-users		string	Filtrovat tak, aby se vracely jenom záznamy, které jsou relevantní pro zadanou e-mailovou adresu ( (oddělené čárkami)
Zahrnout historii	include-history		boolean	Určete, jestli se má objekt historie vrátit s informacemi o stavu záznamu.
Zahrnout možnosti kroku	include-step-options		boolean	Určete, jestli se má objekt možností kroku vrátit s informacemi o stavu záznamu.
Zahrnout viditelné objekty	include-visible-objects		boolean	Určete, jestli se má objekt viditelných objektů vrátit s informacemi o stavu záznamu.

Návraty

Položky

GetBPMRecordState

Definice

ExecuteBPMResult

Name	Cesta	Typ	Description
Popis kroku procesu	description	string	Stručný popis vysvětlující krok procesu
Doba trvání smlouvy SLA (Hrs)	duration	string	Doba trvání smlouvy SLA v hodinách. Zadejte hodnotu 0, pokud není k dispozici.
Razítko události kroku procesu	eventStamp	string	Razítko události pro aktuální krok procesu
Pokyny k krokům	instructions	string	Pokyny pro zodpovědného uživatele během kroku
Klíč kroku procesu	key	string	Jedinečný klíč pro identifikaci kroku procesu
Název kroku procesu	name	string	Krátký název kroku procesu
Klíč profilu BPM	processKey	string	Jedinečný klíč pro identifikaci profilu BPM
Fáze procesu	processStage	string	Klíč, který definuje fázi procesu aktuálního kroku
Typ odpovědnosti	responsibility	string	Odpovědnost na základě uživatele nebo role
Zodpovědná role kroku procesu	responsibleRole	string	Role zodpovědná za aktuální krok procesu
Zpracování kroku zodpovědného za uživatele	responsibleUsers	array of string	Uživatelé odpovědní za aktuální krok procesu
stepOptions	stepOptions	array of object
Popis možnosti kroku	stepOptions.description	string	Stručný popis vysvětlující možnost kroku
Razítko události možnosti kroku	stepOptions.eventStamp	array of string	Razítko události pro aktuální možnost kroku
Název možnosti kroku	stepOptions.name	string	Krátký název možnosti kroku
Další krok	stepOptions.nextStep	string	Další krok, na který bude obchodní proces směrován. Ponechejte prázdné, pokud žádné další kroky
Poznámky k možnostem kroku	stepOptions.notes	string	Volitelné poznámky pro možnost kroku
visibleObjects	stepOptions.visibleObjects	array of object
ID objektu možnosti kroku	stepOptions.visibleObjects.id	string	ID komponenty, na kterou se odkazuje v uživatelském rozhraní
choices	stepOptions.visibleObjects.inputOptions.choices	array of object
Popisek typu voleb	stepOptions.visibleObjects.inputOptions.choices.label	string	Popisek pro vybranou volbu
Hodnota typu volby	stepOptions.visibleObjects.inputOptions.choices.value	string	Hodnota pro vybranou volbu
Popisek vstupních možností	stepOptions.visibleObjects.inputOptions.label	string	Popisek definující vstupní pole nebo upravitelnou komponentu
Zprávy možností zadávání	stepOptions.visibleObjects.inputOptions.messages	array of string	Zprávy, které se mají použít, když se ověření možností vstupu nezdaří
Typ vstupních možností	stepOptions.visibleObjects.inputOptions.type	string	Definuje typ vstupního pole nebo upravitelné komponenty, které se mají použít.
Je možné upravit objekt možnosti kroku.	stepOptions.visibleObjects.isEditable	boolean	Je komponenta odkazovaná na úpravy pro uživatelský vstup.
Je povinný objekt možnosti kroku	stepOptions.visibleObjects.isMandatory	boolean	Vyžaduje odkazovaná komponenta uživatelský vstup.
visibleObjects	visibleObjects	array of object
ID objektu kroku procesu	visibleObjects.id	string	ID komponenty, na kterou se odkazuje v uživatelském rozhraní
choices	visibleObjects.inputOptions.choices	array of object
Popisek typu voleb	visibleObjects.inputOptions.choices.label	string	Popisek pro vybranou volbu
Hodnota typu volby	visibleObjects.inputOptions.choices.value	string	Hodnota pro vybranou volbu
Popisek vstupních možností	visibleObjects.inputOptions.label	string	Popisek definující vstupní pole nebo upravitelnou komponentu
Zprávy možností zadávání	visibleObjects.inputOptions.messages	array of string	Zprávy, které se mají použít, když se ověření možností vstupu nezdaří
Typ vstupních možností	visibleObjects.inputOptions.type	string	Definuje typ vstupního pole nebo upravitelné komponenty, které se mají použít.
Je možné upravit objekt kroku procesu.	visibleObjects.isEditable	boolean	Je komponenta odkazovaná na úpravy pro uživatelský vstup.
Je povinný objekt kroku procesu	visibleObjects.isMandatory	boolean	Vyžaduje odkazovaná komponenta uživatelský vstup.

GetBPMProfile

Name	Cesta	Typ	Description
appAdmin	appAdmin	array of object
E-mail správce aplikace	appAdmin.email	string	E-mailová adresa pro správce aktuálního profilu BPM
Adresa URL aplikace BPM	appUrl	string	Volitelná adresa URL aplikace, která využívá aktuální profil BPM
Popis profilu BPM	description	string	Stručný popis vysvětlující profil BPM
Název skupiny profilů BPM	groupName	string	Volitelné seskupení profilu BPM
Klíč profilu BPM	key	string	Jedinečný klíč pro identifikaci profilu BPM
Název profilu BPM	name	string	Krátký název profilu BPM
Poznámky k profilu BPM	notes	string	Volitelné poznámky pro profil BPM
processSteps	processSteps	array of object
Popis kroku procesu	processSteps.description	string	Stručný popis vysvětlující krok procesu
Doba trvání smlouvy SLA (Hrs)	processSteps.duration	string	Doba trvání smlouvy SLA v hodinách. Zadejte hodnotu 0, pokud není k dispozici.
Je prvním krokem	processSteps.firstStep	boolean	Určete, jestli je záznam kroku procesu prvním krokem v obchodním procesu.
Pokyny k krokům	processSteps.instructions	string	Pokyny pro zodpovědného uživatele během kroku
Klíč kroku procesu	processSteps.key	string	Jedinečný klíč pro identifikaci kroku procesu
Název kroku procesu	processSteps.name	string	Krátký název kroku procesu
Fáze procesu	processSteps.processStage	string	Klíč, který definuje fázi procesu aktuálního kroku
Referenční adresa URL kroku procesu	processSteps.referenceUrl	string	Referenční adresa URL kroku procesu
Typ odpovědnosti	processSteps.responsibility	string	Odpovědnost na základě uživatele nebo role
Zodpovědná role kroku procesu	processSteps.responsibleRole	string	Role zodpovědná za aktuální krok
roleLevels	processSteps.roleLevels	array of string	Úrovně podmíněné role
stepOptions	processSteps.stepOptions	array of object
Popis možnosti kroku	processSteps.stepOptions.description	string	Stručný popis vysvětlující možnost kroku
Název možnosti kroku	processSteps.stepOptions.name	string	Krátký název možnosti kroku
Další krok	processSteps.stepOptions.nextStep	string	Další krok, na který bude obchodní proces směrován. Ponechejte prázdné, pokud žádné další kroky
Poznámky k možnostem kroku	processSteps.stepOptions.notes	string	Volitelné poznámky pro možnost kroku
visibleObjects	processSteps.stepOptions.visibleObjects	array of object
ID objektu možnosti kroku	processSteps.stepOptions.visibleObjects.id	string	ID komponenty, na kterou se odkazuje v uživatelském rozhraní
choices	processSteps.stepOptions.visibleObjects.inputOptions.choices	array of object
Popisek typu voleb	processSteps.stepOptions.visibleObjects.inputOptions.choices.label	string	Popisek pro vybranou volbu
Hodnota typu volby	processSteps.stepOptions.visibleObjects.inputOptions.choices.value	string	Hodnota pro vybranou volbu
Popisek vstupních možností	processSteps.stepOptions.visibleObjects.inputOptions.label	string	Popisek definující vstupní pole nebo upravitelnou komponentu
Zprávy možností zadávání	processSteps.stepOptions.visibleObjects.inputOptions.messages	array of string	Zprávy, které se mají použít, když se ověření možností vstupu nezdaří
Typ vstupních možností	processSteps.stepOptions.visibleObjects.inputOptions.type	string	Definuje typ vstupního pole nebo upravitelné komponenty, které se mají použít.
Je možné upravit objekt možnosti kroku.	processSteps.stepOptions.visibleObjects.isEditable	boolean	Je komponenta odkazovaná na úpravy pro uživatelský vstup.
Je povinný objekt možnosti kroku	processSteps.stepOptions.visibleObjects.isMandatory	boolean	Vyžaduje odkazovaná komponenta uživatelský vstup.
visibleObjects	processSteps.visibleObjects	array of object
ID objektu kroku procesu	processSteps.visibleObjects.id	string	ID komponenty, na kterou se odkazuje v uživatelském rozhraní
choices	processSteps.visibleObjects.inputOptions.choices	array of object
Popisek typu voleb	processSteps.visibleObjects.inputOptions.choices.label	string	Popisek pro vybranou volbu
Hodnota typu volby	processSteps.visibleObjects.inputOptions.choices.value	string	Hodnota pro vybranou volbu
Popisek vstupních možností	processSteps.visibleObjects.inputOptions.label	string	Popisek definující vstupní pole nebo upravitelnou komponentu
Zprávy možností zadávání	processSteps.visibleObjects.inputOptions.messages	array of string	Zprávy, které se mají použít, když se ověření možností vstupu nezdaří
Typ vstupních možností	processSteps.visibleObjects.inputOptions.type	string	Definuje typ vstupního pole nebo upravitelné komponenty, které se mají použít.
Je možné upravit objekt kroku procesu.	processSteps.visibleObjects.isEditable	boolean	Je komponenta odkazovaná na úpravy pro uživatelský vstup.
Je povinný objekt kroku procesu	processSteps.visibleObjects.isMandatory	boolean	Vyžaduje odkazovaná komponenta uživatelský vstup.
Referenční adresa URL profilu BPM	referenceUrl	string	Volitelná adresa URL, na kterou lze odkazovat pro aktuální profil BPM

GetBPMRecordState

Name	Cesta	Typ	Description
Popis kroku procesu	description	string	Stručný popis vysvětlující krok procesu
Doba trvání smlouvy SLA (Hrs)	duration	string	Doba trvání smlouvy SLA v hodinách. Zadejte hodnotu 0, pokud není k dispozici.
eventStampHistory	eventStampHistory	array of object
Název historie razítka události	eventStampHistory.eventName	string	Název razítka události
Časové razítko historie událostí	eventStampHistory.timeStamp	date-time	Časové razítko, kdy došlo k razítku události
historie	history	array of object
Komentáře k historii	history.comments	string	Volitelné komentáře přidané v okamžiku vytvoření položky Historie
Aktuální role historie	history.currentRole	string	Aktuální role v době položky Historie
Aktuální uživatel historie	history.currentUser	string	Aktuální uživatel v době položky Historie
Doba trvání kroku	history.duration	string	Čas (v minutách) existoval záznam v aktuálním kroku procesu před akcí.
Razítko události historie	history.eventStamp	array of string	Razítka událostí, ke kterým došlo v okamžiku položky Historie
Z kroku	history.fromStep	string	Klíč kroku procesu, ze které záznam BPM pochází v době položky Historie.
Z názvu kroku	history.fromStepName	string	Název kroku procesu, ze které záznam BPM pochází v době položky Historie.
Vybraná možnost Historie	history.optionSelected	string	Vybraná možnost při akci záznamu BPM
Klíč procesu BPM historie	history.processKey	string	Jedinečný klíč procesu BPM pro položku Historie
Fáze procesu historie	history.processStage	string	Fáze procesu v době položky Historie
ID záznamu BPM historie	history.recordId	string	ID záznamu souvisejícího se záznamem BPM vygenerovaným během procesu registrace záznamu BPM
Zodpovědná role historie	history.responsibleRole	string	Zodpovědná role záznamu BPM v době položky Historie
Historie zodpovědných uživatelů	history.responsibleUsers	array of string	Zodpovědné uživatele v době položky Historie
Datum odeslání historie	history.submissionDate	date-time	Datum a čas akce záznamu BPM
Fáze procesu	history.toProcessStage	string	Fáze procesu záznamu BPM v době položky Historie
Postup	history.toStep	string	Klíč kroku procesu záznamu BPM v době položky Historie
Název kroku	history.toStepName	string	Název kroku procesu záznamu BPM v době položky Historie
Pokyny k krokům	instructions	string	Pokyny pro zodpovědného uživatele během kroku
Klíč kroku procesu	key	string	Jedinečný klíč pro identifikaci kroku procesu
Název kroku procesu	name	string	Krátký název kroku procesu
Klíč profilu BPM	processKey	string	Jedinečný klíč pro identifikaci profilu BPM
Fáze procesu	processStage	string	Klíč, který definuje fázi procesu aktuálního kroku
ID záznamu BPM	recordId	string	ID záznamu generované modulem BPM při registraci záznamu BPM
Referenční dokumentace k záznamu BPM	recordRef	string	Čitelné číslo vygenerované modulem BPM pomocí modulu Číslování při registraci záznamu BPM
Referenční adresa URL kroku procesu	referenceUrl	string	Referenční adresa URL kroku procesu
Zodpovědná role kroku procesu	responsibleRole	string	Role zodpovědná za aktuální krok
Zpracování kroku zodpovědného za uživatele	responsibleUsers	array of string	Zodpovědné uživatele za aktuální krok procesu
roles	roles	array of object
Název role	roles.name	string	Název role
users	roles.users	array of object
E-mail role	roles.users.email	string	E-mailové adresy propojené s názvem role
stepOptions	stepOptions	array of object
Popis možnosti kroku	stepOptions.description	string	Stručný popis vysvětlující možnost kroku
Razítko události možnosti kroku	stepOptions.eventStamp	array of string	Razítko události pro aktuální možnost kroku
Název možnosti kroku	stepOptions.name	string	Krátký název možnosti kroku
Další krok	stepOptions.nextStep	string	Další krok, na který bude obchodní proces směrován. Ponechejte prázdné, pokud žádné další kroky
Poznámky k možnostem kroku	stepOptions.notes	string	Volitelné poznámky pro možnost kroku
visibleObjects	stepOptions.visibleObjects	array of object
ID objektu možnosti kroku	stepOptions.visibleObjects.id	string	ID komponenty, na kterou se odkazuje v uživatelském rozhraní
choices	stepOptions.visibleObjects.inputOptions.choices	array of object
Popisek typu voleb	stepOptions.visibleObjects.inputOptions.choices.label	string	Popisek pro vybranou volbu
Hodnota typu volby	stepOptions.visibleObjects.inputOptions.choices.value	string	Hodnota pro vybranou volbu
Popisek vstupních možností	stepOptions.visibleObjects.inputOptions.label	string	Popisek definující vstupní pole nebo upravitelnou komponentu
Zprávy možností zadávání	stepOptions.visibleObjects.inputOptions.messages	array of string	Zprávy, které se mají použít, když se ověření možností vstupu nezdaří
Typ vstupních možností	stepOptions.visibleObjects.inputOptions.type	string	Definuje typ vstupního pole nebo upravitelné komponenty, které se mají použít.
Je možné upravit objekt možnosti kroku.	stepOptions.visibleObjects.isEditable	boolean	Je komponenta odkazovaná na úpravy pro uživatelský vstup.
Je povinný objekt možnosti kroku	stepOptions.visibleObjects.isMandatory	boolean	Vyžaduje odkazovaná komponenta uživatelský vstup.
Odesláno do kroku	submittedIntoStep	date-time	Datum a čas odeslání záznamu BPM do aktuálního kroku procesu
Doba trvání cílového času	targetTimeDuration	date-time	Datum a čas, kdy musí být záznam BPM akční na základě doby trvání smlouvy SLA.
visibleObjects	visibleObjects	array of object
ID objektu kroku procesu	visibleObjects.id	string	ID komponenty, na kterou se odkazuje v uživatelském rozhraní
choices	visibleObjects.inputOptions.choices	array of object
Popisek typu voleb	visibleObjects.inputOptions.choices.label	string	Popisek pro vybranou volbu
Hodnota typu volby	visibleObjects.inputOptions.choices.value	string	Hodnota pro vybranou volbu
Popisek vstupních možností	visibleObjects.inputOptions.label	string	Popisek definující vstupní pole nebo upravitelnou komponentu
Zprávy možností zadávání	visibleObjects.inputOptions.messages	array of string	Zprávy, které se mají použít, když se ověření možností vstupu nezdaří
Typ vstupních možností	visibleObjects.inputOptions.type	string	Definuje typ vstupního pole nebo upravitelné komponenty, které se mají použít.
Je možné upravit objekt kroku procesu.	visibleObjects.isEditable	boolean	Je komponenta odkazovaná na úpravy pro uživatelský vstup.
Je povinný objekt kroku procesu	visibleObjects.isMandatory	boolean	Vyžaduje odkazovaná komponenta uživatelský vstup.

KeywordValues

Name	Cesta	Typ	Description
Označení	label	string
Hodnota	value	string

RegisterBPMRecord

Name	Cesta	Typ	Description
Popis kroku procesu	description	string	Stručný popis vysvětlující krok procesu
Doba trvání smlouvy SLA (Hrs)	duration	string	Doba trvání smlouvy SLA v hodinách. Zadejte hodnotu 0, pokud není k dispozici.
eventStampHistory	eventStampHistory	array of object
Název historie razítka události	eventStampHistory.eventName	string	Název razítka události
Časové razítko historie událostí	eventStampHistory.timeStamp	date-time	Časové razítko, kdy došlo k razítku události
historie	history	array of object
Komentáře k historii	history.comments	string	Volitelné komentáře přidané v okamžiku vytvoření položky Historie
Aktuální role historie	history.currentRole	string	Aktuální role v době položky Historie
Aktuální uživatel historie	history.currentUser	string	Aktuální uživatel v době položky Historie
Doba trvání kroku	history.duration	string	Čas (v minutách) existoval záznam v aktuálním kroku procesu před akcí.
Razítko události historie	history.eventStamp	array of string	Razítka událostí, ke kterým došlo v okamžiku položky Historie
Z kroku	history.fromStep	string	Klíč kroku procesu, ze které záznam BPM pochází v době položky Historie.
Z názvu kroku	history.fromStepName	string	Název kroku procesu, ze které záznam BPM pochází v době položky Historie.
Vybraná možnost Historie	history.optionSelected	string	Vybraná možnost při akci záznamu BPM
Klíč procesu BPM historie	history.processKey	string	Jedinečný klíč procesu BPM pro položku Historie
Fáze procesu historie	history.processStage	string	Fáze procesu v době položky Historie
ID záznamu BPM historie	history.recordId	string	ID záznamu souvisejícího se záznamem BPM vygenerovaným během procesu registrace záznamu BPM
Zodpovědná role historie	history.responsibleRole	string	Zodpovědná role záznamu BPM v době položky Historie
Historie zodpovědných uživatelů	history.responsibleUsers	array of string	Zodpovědné uživatele v době položky Historie
Datum odeslání historie	history.submissionDate	date-time	Datum a čas akce záznamu BPM
Fáze procesu	history.toProcessStage	string	Fáze procesu záznamu BPM v době položky Historie
Postup	history.toStep	string	Klíč kroku procesu záznamu BPM v době položky Historie
Název kroku	history.toStepName	string	Název kroku procesu záznamu BPM v době položky Historie
Pokyny k krokům	instructions	string	Pokyny pro zodpovědného uživatele během kroku
Klíč kroku procesu	key	string	Jedinečný klíč pro identifikaci kroku procesu
Název kroku procesu	name	string	Krátký název kroku procesu
Klíč profilu BPM	processKey	string	Jedinečný klíč pro identifikaci profilu BPM
Fáze procesu	processStage	string	Klíč, který definuje fázi procesu aktuálního kroku
ID záznamu BPM	recordId	string	ID záznamu generované modulem BPM při registraci záznamu BPM
Referenční dokumentace k záznamu BPM	recordRef	string	Čitelné číslo vygenerované modulem BPM pomocí modulu Číslování při registraci záznamu BPM
Referenční adresa URL kroku procesu	referenceUrl	string	Referenční adresa URL kroku procesu
Zodpovědná role kroku procesu	responsibleRole	string	Role zodpovědná za aktuální krok procesu
Zpracování kroku zodpovědného za uživatele	responsibleUsers	array of string	Uživatelé odpovědní za aktuální krok procesu
roles	roles	array of object
Název role	roles.name	string	Název role
users	roles.users	array of object
E-mail role	roles.users.email	string	E-mailové adresy propojené s názvem role
stepOptions	stepOptions	array of object
Popis možnosti kroku	stepOptions.description	string	Stručný popis vysvětlující možnost kroku
Razítko události možnosti kroku	stepOptions.eventStamp	array of string	Razítko události pro aktuální možnost kroku
Název možnosti kroku	stepOptions.name	string	Krátký název možnosti kroku
Další krok	stepOptions.nextStep	string	Další krok, na který bude obchodní proces směrován. Ponechejte prázdné, pokud žádné další kroky
Poznámky k možnostem kroku	stepOptions.notes	string	Volitelné poznámky pro možnost kroku
visibleObjects	stepOptions.visibleObjects	array of object
ID objektu možnosti kroku	stepOptions.visibleObjects.id	string	ID komponenty, na kterou se odkazuje v uživatelském rozhraní
choices	stepOptions.visibleObjects.inputOptions.choices	array of object
Popisek typu voleb	stepOptions.visibleObjects.inputOptions.choices.label	string	Popisek pro vybranou volbu
Hodnota typu volby	stepOptions.visibleObjects.inputOptions.choices.value	string	Hodnota pro vybranou volbu
Popisek vstupních možností	stepOptions.visibleObjects.inputOptions.label	string	Popisek definující vstupní pole nebo upravitelnou komponentu
Zprávy možností zadávání	stepOptions.visibleObjects.inputOptions.messages	array of string	Zprávy, které se mají použít, když se ověření možností vstupu nezdaří
Typ vstupních možností	stepOptions.visibleObjects.inputOptions.type	string	Definuje typ vstupního pole nebo upravitelné komponenty, které se mají použít.
Je možné upravit objekt možnosti kroku.	stepOptions.visibleObjects.isEditable	boolean	Je komponenta odkazovaná na úpravy pro uživatelský vstup.
Je povinný objekt možnosti kroku	stepOptions.visibleObjects.isMandatory	boolean	Vyžaduje odkazovaná komponenta uživatelský vstup.
visibleObjects	visibleObjects	array of object
ID objektu kroku procesu	visibleObjects.id	string	ID komponenty, na kterou se odkazuje v uživatelském rozhraní
choices	visibleObjects.inputOptions.choices	array of object
Popisek typu voleb	visibleObjects.inputOptions.choices.label	string	Popisek pro vybranou volbu
Hodnota typu volby	visibleObjects.inputOptions.choices.value	string	Hodnota pro vybranou volbu
Popisek vstupních možností	visibleObjects.inputOptions.label	string	Popisek definující vstupní pole nebo upravitelnou komponentu
Zprávy možností zadávání	visibleObjects.inputOptions.messages	array of string	Zprávy, které se mají použít, když se ověření možností vstupu nezdaří
Typ vstupních možností	visibleObjects.inputOptions.type	string	Definuje typ vstupního pole nebo upravitelné komponenty, které se mají použít.
Je možné upravit objekt kroku procesu.	visibleObjects.isEditable	boolean	Je komponenta odkazovaná na úpravy pro uživatelský vstup.
Je povinný objekt kroku procesu	visibleObjects.isMandatory	boolean	Vyžaduje odkazovaná komponenta uživatelský vstup.

StdJSONResponse

Name	Cesta	Typ	Description
Result	result	string	Result

objekt

Toto je typ 'objekt'.