Podrobný popis API

Věta F - typ app_query_response

Vlastnost Popis Povinné Poznámka
Hlavička
MessageType Typ zprávy = app_query_response A  
ServiceID Identifikátor služby v podobě srv-xxx-xxx A  
ServiceExecutionID Globálně unikátní identifikátor zpracování služby - jednoznačný identifikátor konkrétního běhu komunikační služby Maatrix A  
QueryExecutionID Globálně unikátní identifikátor zpracování dotazu - jednoznačný identifikátor konkrétního dotazu A  
ExternalID Externí ID daného volání služby (přiděleno volající externí aplikací) N Identifikátor převzatý z věty E-app_query
Response

Odpověď Maatrixu na výzvu ke spuštění služby:

OK - toto je úplná a platná odpověď na daný dotaz

confirmed - vyhodnocování spuštěno, čekáme na ukončení položky v atributu WaitFor z dotazu E-app_query

refused - otázka nemohla být spuštěna z licenčních důvodů. Podrobnosti mohou být v atributu Reason

error - otázka obsahovala chyby, kvůli kterým nemohl být požadavek vykonán. Viz atributy Reason a Errors

A  
Reason

Příčina hodnoty v atributu Response:

content - chybný a nebo neúplný obsah

identification - chybné identifikační údaje ve větě

format - obsah věty E nebylo možné načíst

licence - událost nemohla být spuštěna kvůli překročení licence služby, tj. byla překročena maximálně povolená četnost použití

time - událost nemohla být spuštěna kvůli tomu, že ještě neuplynulo dostatek času od spuštění předchozí události téže služby

waiting - query má být spuštěna až po ukončení nějakého procesu a nyní na to opravdu čekáme

N  
Subject

Subjekt dotazu:

Service - subjektem je daný výkon služby ServiceExecutionID, Maatrix vrátí jeho stav, a výstupní parametry

Block(identifikace bloku) - subjektem je blok daný svým identifikátorem (pořadí bloku jak je na diagramu procesu v definici služby)

Parameters - budou vyhodnoceny pouze explicitní parametry Parameters.

A  
SubjectResult Pokud má subjekt definován nějaký výsledek, zde je N  
SubjectStatus

Stav subjektu dotazu v okamžiku vyhodnocení - subjekt může být celá služba nebo některý z bloků (viz popis ve zprávě E-app_query). Příklady SubjectStatus:

closed - subjekt korektně proběhl (služba /blok ukončena, má výsledek)

stopped - subjekt byl buď násilně ukončen, nebo zkolaboval (služba / blok byla přerušena, výsledky nejsou platné, a nikdy platné nebudou),

open - subjekt byl nastartován, stále ještě běží (výsledky nejsou uzavřeny, při jejich interpretaci je třeba velké opatrnosti)

null - subjekt nemá status (například: daný blok ještě nebyl nastartován)

A  
Errors Seznam chyb   Přehled kódů chyb naleznete zde
Timestamp časová značka přijetí zprávy (UTC čas) A  
Výstupní parametry
<:OutputPara> Jednotlivé výstupní parametry služby nebo dotazu. Názvy parametrů jsou uvedeny včetně povinného uzavření mezi "<: a >" A Seznam těchto parametrů je k dispozici v portálu systému Maatrix u nastavení služby. Význam jednotlivých typů výstupních parametrů naleznete zde.