Podrobný popis API

Věta E - typ app_query

Vlastnost Popis Povinné Poznámka
Hlavička
InterfaceID Identifikátor Rozhraní (Interface) v podobě int-xxx-xxx  A Tento identifikátor interface je generován systémem Maatrix v okamžiku, kdy aplikační partner založí v tomto systému nové rozhraní / interface
MessageType Typ zprávy = app_query  A  
ServiceID Identifikátor služby v podobě srv-xxx-xxx  A  
M2Mpswd M2M (machine to machine) heslo pro přístup interface k systému A M2M heslo je náhodně generováno systémem Maatrix. Správce služby má možnost kdykoli vygenerovat nové heslo a to je pak následně nutné upravit i v externí aplikaci
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  
ExternalID Externí ID daného volání služby (přiděleno volající externí aplikací)  N Nepovinný externí identifikátor. Max 50 alfanumerických znaků, včetně mezer, podtržítek, pomlček. Systém Maatrix jej nijak nezpracovává. Pokud je ExternalID zadáno, bude jednoduše vráceno ve všech relevantních zprávách, které systém posílá vnějšímu světu
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  
WaitFor Dotaz bude vyhodnocen teprve po ukončení položky v atributu WaitFor. Typickou hodnotou je "Subject" .. což znamená, že dotaz bude vyhodnocen po ukončení subjektu Subject.  N Cokoliv, co může být v atributu Subject. (příklad: předpokládejme, že v Subject je Block(3) a ve WaitFor je Block(1); vyhodnocení dotazu bude čekat na ukončení bloku 3 a teprve poté bude vyhodnocen dotaz na blok 1.
AnswerChannel Komunikační kanál, kterým bude zaslán výsledek Y-app_query_response, pokud je požadován atributem WaitFor  N

Hodnotou jsou následující údaje:

Format: "json"

EmailRecipient: mailová adresa, na kterou má být zpráva X zaslána.

Pokud je zadán SendSummary=1 a v SummaryChannel není žádná hodnota, je vracena zpět zpráva dle typu interface (např. json) a na mailovou adresu, ze které přišla zpráva A (platí jen u smtp adapteru)

Parametry dotazu
<:Parameters> Jednotlivé parametry dotazu: mnemonikum (definované v příslušné definice služby) - v takovém případě může být hodnotou "", odpověď bude obsahovat vyhodnocené mnemonikum nebo libovolný řetězec (alfaumerikýc, až 50 znaků) s hodnoutou "řetězec s mnemoniky" N Použití formátu klíč-řetězec s mnemoniky bude pečlivě kontrolováno a omezováno. Pokud bude povoleno, mnemonika budou vyhodnocena v kontextu zpracování služby.