Rozdíly
Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.
| Obě strany předchozí revize Předchozí verze Následující verze | Předchozí verze | ||
| 
                    cs:mervis-scada:50-api [2018/11/02 07:32] m.chlupac  | 
                
                    cs:mervis-scada:50-api [2025/07/24 09:10] (aktuální) p.dostalek [Přehled základních API metod]  | 
            ||
|---|---|---|---|
| Řádek 7: | Řádek 7: | ||
| ^Function^Description| | ^Function^Description| | ||
| - | ^api/ | + | ^api/ | 
| + | ^api/ | ||
| ^api/ | ^api/ | ||
| ^api/ | ^api/ | ||
| ^api/ | ^api/ | ||
| ^api/ | ^api/ | ||
| - | ^api/ | + | ^api/ | 
| ^api/ | ^api/ | ||
| ^api/ | ^api/ | ||
| Řádek 28: | Řádek 29: | ||
| ^api/ | ^api/ | ||
| ^api/ | ^api/ | ||
| + | ^/ | ||
| ===== Příklad ===== | ===== Příklad ===== | ||
| - | ====api/ | + | ==== api/v2/get/authenticate  | 
| **Request** | **Request** | ||
| - | * URL: /api/get/history?format=xml | + |    * URL: https:// | 
| * Method: POST | * Method: POST | ||
| - | < | + | |
| + | < | ||
| + | {" | ||
| + | </ | ||
| + | |||
| + | **Response XML** | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version=" | ||
| + | < | ||
| + |     <data n1: | ||
| + |     <result code=" | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | **Response JSON** | ||
| + | |||
| + | <code javascript> | ||
| { | { | ||
| - |    " | + |     " | 
| - |       " | + |         " | 
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + |   * Získaný token **t** je třeba použít místo dvojice jméno/ | ||
| + | |||
| + | |||
| + | |||
| + | ==== [Deprecated] api/ | ||
| + | |||
| + | **Request** | ||
| + | |||
| + |    * URL: https:// | ||
| + | * Method: POST | ||
| + | |||
| + | |||
| + | <code javascript> | ||
| + | {" | ||
| + | </ | ||
| + | |||
| + | **Response** | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version=" | ||
| + | < | ||
| + | </ | ||
| + | |||
| + |   * Získaný token **t** je třeba použít místo dvojice jméno/ | ||
| + | |||
| + | ==== api/ | ||
| + | |||
| + | **Request** | ||
| + | |||
| + |    * URL: https:// | ||
| + | * Method: POST | ||
| + | |||
| + | Formát reponse je xml a nebo json podle volané url. | ||
| + | |||
| + | <code javascript> | ||
| + | {" | ||
| + | </ | ||
| + | |||
| + | **Response XML** | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version=" | ||
| + | < | ||
| + |     < | ||
| + |         <project id=" | ||
| + |             < | ||
| + |                 <mi n1: | ||
| + |                 <mi n2: | ||
| + |             </ | ||
| + |         </ | ||
| + |         <project id=" | ||
| + |             < | ||
| + |                 < | ||
| + |                 < | ||
| + |                 < | ||
| + |             < | ||
| + |                 <mi n2: | ||
| + |                 <mi n1: | ||
| + |             </ | ||
| + |         </ | ||
| + |         <project id=" | ||
| + |             < | ||
| + |                 <n4:gps lat=" | ||
| + |             </ | ||
| + |             < | ||
| + |                 < | ||
| + |                 < | ||
| + |                 < | ||
| + |             < | ||
| + |                 <mi r: | ||
| + |                 <mi n1: | ||
| + |             </ | ||
| + |         </ | ||
| + |         <project id=" | ||
| + |             < | ||
| + |                 <n4:gps lat=" | ||
| + |             </ | ||
| + |             < | ||
| + |                 <mi n2: | ||
| + |                 <mi n1: | ||
| + |             </ | ||
| + |         </ | ||
| + |         <project id=" | ||
| + |             < | ||
| + |                 <mi n2: | ||
| + |                 <mi n1: | ||
| + |             </ | ||
| + |         </ | ||
| + |     </ | ||
| + |     < | ||
| + |         <group n5: | ||
| + |             < | ||
| + |                 < | ||
| + |                     <project r: | ||
| + |                 </ | ||
| + |                 < | ||
| + |                     <project r: | ||
| + |                 </ | ||
| + |                 < | ||
| + |                     <project r: | ||
| + |                 </ | ||
| + |                 < | ||
| + |                     <project r: | ||
| + |                 </ | ||
| + |                 < | ||
| + |                     <project r: | ||
| + |                 </ | ||
| + |             </ | ||
| + |         </ | ||
| + |     </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | **Response JSON** | ||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + |     " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |             " | ||
| + | { | ||
| + |                     " | ||
| + |                         " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + | }, | ||
| + |                         " | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                     " | ||
| + |                         " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + | }, | ||
| + |                         " | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ], | ||
| + |                         " | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                     " | ||
| + |                         " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + | }, | ||
| + |                         " | ||
| + |                             " | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                     " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + |                         " | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ], | ||
| + |                         " | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                     " | ||
| + |                         " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + | }, | ||
| + |                         " | ||
| + |                             " | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                     " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + |                         " | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                     " | ||
| + |                         " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + | }, | ||
| + |                         " | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | ], | ||
| + |             " | ||
| + | { | ||
| + |                     " | ||
| + |                         " | ||
| + |                             " | ||
| + | }, | ||
| + |                         " | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                 " | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | ], | ||
| + |             " | ||
| + |                 " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | |||
| + | ==== api/ | ||
| + | |||
| + | **Request** | ||
| + | |||
| + |    * URL: https:// | ||
| + | * Method: POST | ||
| + | |||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + |     " | ||
| + |         " | ||
| + | }, | ||
| + |     " | ||
| + |     " | ||
| + |     " | ||
| + |     " | ||
| + |     " | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | **Response XML** | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version=" | ||
| + | < | ||
| + |     < | ||
| + |         <dp id=" | ||
| + | <v> | ||
| + |                 < | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                             < | ||
| + |                                 < | ||
| + |                                     < | ||
| + |                                     < | ||
| + |                                         <n1:p r: | ||
| + |                                             < | ||
| + |                                             < | ||
| + |                                         </ | ||
| + |                                     </ | ||
| + |                                 </ | ||
| + |                             </ | ||
| + |                         </ | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         <n2:v e=" | ||
| + |                             < | ||
| + |                                 <n2:inpm i=" | ||
| + |                                 <n2:inpm i=" | ||
| + |                                 <n2:inpm i=" | ||
| + |                                 <n2:inpm i=" | ||
| + |                                 <n2:inpm i=" | ||
| + |                                 <n2:inpm i=" | ||
| + |                                 <n2:inpm i=" | ||
| + |                                 <n2:inpm i=" | ||
| + |                                 <n2:inpm i=" | ||
| + |                             </ | ||
| + |                         </ | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                             < | ||
| + |                                 <t vt=" | ||
| + |                             </ | ||
| + |                         </ | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                     </ | ||
| + |                 </ | ||
| + |             </ | ||
| + | <a> | ||
| + |                 < | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                         < | ||
| + |                     </ | ||
| + |                     <p n=" | ||
| + |                         < | ||
| + |                         < | ||
| + |                         < | ||
| + |                         < | ||
| + |                     </ | ||
| + |                 </ | ||
| + |             </ | ||
| + |             <core r: | ||
| + |         </ | ||
| + | ... | ||
| + |     </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | **Response JSON** | ||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + |     " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |             " | ||
| + |                 " | ||
| + |                 " | ||
| + |                 " | ||
| + |                 " | ||
| + | }, | ||
| + |             " | ||
| + | { | ||
| + |                     " | ||
| + |                         " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + |                             " | ||
| + | }, | ||
| + |                         " | ||
| + |                             " | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + |                                             " | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                         " | ||
| + | { | ||
| + |                                                                 " | ||
| + |                                                                     " | ||
| + |                                                                     " | ||
| + |                                                                     " | ||
| + |                                                                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                                 " | ||
| + |                                                 " | ||
| + |                                                 " | ||
| + |                                                 " | ||
| + | }, | ||
| + |                                             " | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + |                                             " | ||
| + | { | ||
| + |                                                     " | ||
| + |                                                         " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + |                                                             " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
| + |                         " | ||
| + |                             " | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                                     " | ||
| + |                                         " | ||
| + |                                             " | ||
| + |                                             " | ||
| + | }, | ||
| + |                                         " | ||
| + |                                         " | ||
| + |                                         " | ||
| + |                                         " | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
| + |                         " | ||
| + |                             " | ||
| + |                                 " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ... | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | ==== api/ | ||
| + | |||
| + | **Request** | ||
| + | |||
| + |    * URL: / | ||
| + | * Method: POST | ||
| + | * Umožňuje stahovat historii pro více datových bodů | ||
| + | * V ukázkách je vždy za dvěma lomítky uvedený typ property | ||
| + |    * V sekci credentials lze místo " | ||
| + |    * " | ||
| + |    * " | ||
| + |    * položky " | ||
| + | |||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + |     " | ||
| + |         " | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |             " | ||
| + |             " | ||
| + | }, | ||
| + |         " | ||
| + | { | ||
| + |                 " | ||
| + |                     " | ||
| + |                     " | ||
| + | }, | ||
| + |                 " | ||
| + |                 " | ||
| + |                     " | ||
| + |                         " | ||
| + |                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                 " | ||
| + |                 " | ||
| + |                     " | ||
| + |                         " | ||
| + |                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |             " | ||
| + | } | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |         " | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | **Response** | ||
| + | |||
| + |    * Dokud je v odpovědi v sekci " | ||
| + |    * " | ||
| + | * Values | ||
| + | * v - hodnota | ||
| + | * ts - začátek platnosti hodnoty | ||
| + | * gt - konec platnosti hodnoty | ||
| + | * i - interval, pokud je jiný než uvedená hodnota u celé série | ||
| + | * Meta | ||
| + | * type - typ uložených hodnot - double, string, datetime | ||
| + | * unit - jednotky | ||
| + | * interval - informace o periodě, v jaké by měly být hodnoty v databázi uloženy. Slouží k identifikaci chybějících záznamů. | ||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + | " | ||
| + |         " | ||
| + |         " | ||
| + |         " | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |         " | ||
| + | { | ||
| + |                 " | ||
| + |                 " | ||
| + |                     " | ||
| + |                     " | ||
| + |                         " | ||
| + |                         " | ||
| + | } | ||
| + | }, | ||
| + |                 " | ||
| + |                     " | ||
| + |                     " | ||
| + |                     " | ||
| + | }, | ||
| + |                 " | ||
| + | { | ||
| + |                         " | ||
| + |                         " | ||
| + |                         " | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
| + | { | ||
| + |                 " | ||
| + |                 " | ||
| + |                     " | ||
| + |                         " | ||
| + |                         " | ||
| + | } | ||
| + | }, | ||
| + |                 " | ||
| + |                     " | ||
| + |                     " | ||
| + |                     " | ||
| + | }, | ||
| + |                 " | ||
| + | { | ||
| + |                         " | ||
| + |                         " | ||
| + |                         " | ||
| + | }, | ||
| + | { | ||
| + |                         " | ||
| + |                         " | ||
| + |                         " | ||
| + |                         " | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |         " | ||
| + | } | ||
| + | } | ||
| + | |||
| + | |||
| + | </ | ||
| + | |||
| + | **Funkční demo** | ||
| + | <code javascript> | ||
| + | { | ||
| + |     " | ||
| + |         " | ||
| + |         " | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |             " | ||
| + |             " | ||
| + | }, | ||
| + |         " | ||
| + | { | ||
| + |                 " | ||
| + |                 " | ||
| + |                     " | ||
| + |                         " | ||
| + |                         " | ||
| + | } | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + |                 " | ||
| + |                 " | ||
| + |                     " | ||
| + |                         " | ||
| + |                         " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | }, | ||
| + |     " | ||
| + |         " | ||
| + |             " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | |||
| + | </ | ||
| + | |||
| + | |||
| + | |||
| + | ==== [Deprecated] api/ | ||
| + | |||
| + | **Request** | ||
| + | |||
| + |    * URL: / | ||
| + | * Method: POST | ||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + |    " | ||
| + |       " | ||
| + |       " | ||
| + |       " | ||
| }, | }, | ||
| - |    " | + |    " | 
| - |    " | + |    " | 
| - |    " | + |    " | 
| - |    " | + |    " | 
| - |    " | + | |
|    " |    " | ||
|    " |    " | ||
| Řádek 58: | Řádek 1212: | ||
| <code xml> | <code xml> | ||
| + | <?xml version=" | ||
| < | < | ||
| - |   <hist projId=" | + |   <hist projId=" | 
|     < |     < | ||
|     < |     < | ||
| - |       <hv ts="2017-05-08T22:26:53.32684Z" gt="2017-05-08T22:31:53.465467Z"> | + |       <hv ts="2018-11-02T21:26:08.7936747Z" gt="2018-11-03T20:35:08.8060769Z"> | 
| - |         < | + |         < | 
| </hv> | </hv> | ||
| - |       <hv ts="2017-05-08T22:36:53.283875Z"> | + |       <hv ts="2018-11-03T20:41:09.0100479Z" | 
| - |         < | + |         < | 
| </hv> | </hv> | ||
| - |       <hv ts="2017-05-08T22:41:53.435042Z"> | + |       <hv ts="2018-11-05T11:40:04.0077949Z" | 
| - |         < | + |         < | 
| </hv> | </hv> | ||
| - |       <hv ts="2017-05-08T22:46:53.711496Z" gt="2017-05-08T23:36:53.776657Z"> | + |       <hv ts="2018-11-05T17:28:03.4133447Z" gt="2018-11-05T19:40:03.0246122Z"> | 
| - |         < | + |         < | 
| + |       </ | ||
| + |       <hv ts=" | ||
| + |         < | ||
| + |       </ | ||
| + |       <hv ts=" | ||
| + |         < | ||
| + |       </ | ||
| + |       <hv ts=" | ||
| + |         < | ||
| + |       </ | ||
| + |       <hv ts=" | ||
| + |         < | ||
| + |       </ | ||
| + |       <hv ts=" | ||
| + |         < | ||
| + |       </ | ||
| + |       <hv ts=" | ||
| + |         < | ||
| + |       </ | ||
| + |       <hv ts=" | ||
| + |         < | ||
| + |       </ | ||
| + |       <hv ts=" | ||
| + |         < | ||
| </hv> | </hv> | ||
| - | |||
|     </ |     </ | ||
|   </ |   </ | ||
| Řádek 82: | Řádek 1260: | ||
| </ | </ | ||
| - | ====api/v2/get/ | + | |
| + | ====api/set/ | ||
| **Request** | **Request** | ||
| - |    * URL: /api/v2/get/ | + |    * URL: /api/set/ | 
| * Method: POST | * Method: POST | ||
| + |    * Content-Type: | ||
| - | < | + | Atribut **i** nastavuje **interval** ([[https:// | 
| - | {   | + | |
| - |     | + | V **cred** lze použít i ověření pomocí jména a hesla, ale využití **tokenu** nabízí vyšší výkon. | 
| - | "cred":{ | + | |
| - |           | + | Všechny časové údaje jsou očekávány v UTC. | 
| - |           | + | |
| - |           | + | < | 
| - | }, | + | <?xml version=" | 
| - |       "projId":" | + | < | 
| - |       "from":"/ | + | xmlns:n2=" | 
| - |       "to":"/ | + | xmlns:n1="http:// | 
| - |        | + | projId=" | 
| - | "variableOffset":0, | + | dpId=" | 
| - |       "count": | + |   <n2:cred t=" | 
| - |       "historyState":"" | + |   < | 
| - | "providersDps":[ | + |     < | 
| - | { | + |       <n1:v> | 
| - |             "m_Item1":" | + |     </ | 
| - |             "m_Item2":" | + |     <hv ts="2020-03-16T11: | 
| - |           | + |       < | 
| - |           | + | </hv> | 
| - |             "m_Item1":" | + |     < | 
| - |             "m_Item2":" | + |       <n1:v> | 
| - |           | + |     </ | 
| - | ] | + |     <hv ts="2020-03-18T11: | 
| - | } | + |       < | 
| + |     </ | ||
| + | </vals> | ||
| + | </setHistoryRequest></ | ||
| + | |||
| + | **Response** | ||
| + | |||
| + | * 200 OK | ||
| + | |||
| + | ====api/ | ||
| + | |||
| + |    * URL: / | ||
| + | * Method: POST | ||
| + |    * Content-Type: | ||
| + | |||
| + | ===DoubleValue=== | ||
| + | |||
| + | **Request** | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version="1.0"  | ||
| + | < | ||
| + | xmlns: | ||
| + | xmlns:n1="http:// | ||
| + | xmlns:r=" | ||
| + |   <n1:cred t=" | ||
| + |   < | ||
| + |     < | ||
| + |        | ||
| + |         < | ||
| + |           < | ||
| + |         </execParam> | ||
| + |       </ | ||
| + |       < | ||
| + |       </actionDefItem> | ||
| + | </actions> | ||
| + |   </ | ||
| + | </ | ||
| + | |||
| + | **Response** | ||
| + | |||
| + | <code xml><? | ||
| + | < | ||
| + | |||
| + | ===PlanningCalendar=== | ||
| + | |||
| + |    * v requestu je atribut  | ||
| + |    * pokud je kalendář číslený místo  | ||
| + | |||
| + | **Request** | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version="1.0"  | ||
| + | < | ||
| + | xmlns:n1=" | ||
| + | xmlns: | ||
| + |   <n1:cred t=" | ||
| + |    | ||
| + |     < | ||
| + |       < | ||
| + |         < | ||
| + |           < | ||
| + |              | ||
| + |               < | ||
| + |                 <n2:changes> | ||
| + |                   <n2:ch cmd=" | ||
| + |                     <n2:def start="2024-04-09T02: | ||
| + |                       < | ||
| + |                     </ | ||
| + |                   </ | ||
| + |                 </ | ||
| + |               </ | ||
| + |             </ | ||
| + |           </ | ||
| + |         </ | ||
| + |       </ | ||
| + |     </ | ||
| + |   </actionDefs> | ||
| + | </executeActionsRequest></ | ||
| + | |||
| + | **Response** | ||
| + | |||
| + | <code xml><? | ||
| + | < | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ====api/ | ||
| + | |||
| + |    * URL: / | ||
| + | * Method: POST | ||
| + | |||
| + | ===Output property=== | ||
| + | |||
| + | Nejvhodnější způsob vyčtení aktuálních hodnot datových bodů (property " | ||
| + | |||
| + | **Request** | ||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + |  " | ||
| + |   " | ||
| + | }, | ||
| + |  " | ||
| + |  " | ||
| + |  " | ||
| + |  " | ||
| + |  " | ||
| + |     | ||
| + |     | ||
| + | } | ||
| + | ] | ||
| } | } | ||
| + | |||
| + | </ | ||
| + | |||
| + | **Response** | ||
| + | |||
| + | <code xml><? | ||
| + | <values xmlns: | ||
| + |  < | ||
| + |   <v projId=" | ||
| + |    < | ||
| + |     <d id=" | ||
| + |      < | ||
| + |       <p n=" | ||
| + |        < | ||
| + | </p> | ||
| + |      </ | ||
| + | </d> | ||
| + |     <d id=" | ||
| + |      < | ||
| + |       <p n=" | ||
| + |        < | ||
| + | </p> | ||
| + |      </ | ||
| + | </d> | ||
| + |    </ | ||
| + | </v> | ||
| + |  </ | ||
| + | </ | ||
| + | |||
| + | ===PlanningCalendar property=== | ||
| + | |||
| + | **Request** | ||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + |  " | ||
| + |   " | ||
| + | }, | ||
| + |  " | ||
| + |  " | ||
| + |  " | ||
| + |  " | ||
| + |  " | ||
| + |    " | ||
| + |    " | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | |||
| </ | </ | ||
| Řádek 122: | Řádek 1463: | ||
| <code xml> | <code xml> | ||
| <?xml version=" | <?xml version=" | ||
| - | <globalResponse  | + | <values  | 
| - |     <result code="0"  | + | <vals> | 
| - |     <data n1:count="2"  | + |     <v projId="17d3ff08-40c1-41c0-ad6a-bad4489323c7"  | 
| - |         <n1:providerHistories> | + |       < | 
| - |             < | + |         <d id="d1243034-0809-444d-a48a-d04d800b4095" | 
| - | <n1:dpHistories> | + | <props> | 
| - | <n2:pl> | + |             <p n="PlanningCalendar"  | 
| - |                         <n2:p n="Output"  | + |               <n1:v defaultValue="0" emailForNotifications="" | 
| - |                             <n3:hist projId="5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0"  | + | <n1:layers> | 
| - |                                 < | + |                   <n1:l name="Decimal"  | 
| - | <n3:vals> | + |                     <n1:events> | 
| - |                                     <n3:hv ts="2018-10-23T16:27:41.5932104Z"  | + |                       <n1:e rev="3"> | 
| - | <n4:v>11979</n4:v> | + |                         <n1:def start="2024-04-11T04: | 
| - | </n3:hv> | + | </n1:e> | 
| - | </n3:vals> | + |                       <n1:e rev=" | 
| - | </n3:hist> | + |                         <n1:def start="2024-04-11T22:00:00Z" end=" | 
| - | </n2:p> | + | </n1:e> | 
| - |                         <n2:p n="Output"  | + |                      | 
| - |                             <n3:hist projId="5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0"  | + | <n1:items /> | 
| - | <n3:errMsg></n3:errMsg> | + | </n1:l> | 
| - | <n3:vals> | + |                   <n1:l name=" | 
| - |                                     <n3:hv ts="2018-10-24T12:48:42.1926956Z"  | + |                     <n1:events> | 
| - | <n4:v>12702</n4:v> | + |                       <n1:e rev=" | 
| - | </n3:hv> | + |                         <n1:def start=" | 
| - | </n3:vals> | + | </n1:e> | 
| - | </n3:hist> | + | <n1:e rev="5"> | 
| - | </n2:p> | + |                         <n1:def start="2024-04-11T22: | 
| - | </n2:pl> | + | </n1:e> | 
| - |                 </n1: | + |                      | 
| - |             </n1: | + | <n1:items /> | 
| - |         </n1: | + | </n1:l> | 
| - | </data> | + |                   <n1:l name=" | 
| - | </globalResponse> | + |                     < | 
| + |                       <n1:e rev=" | ||
| + |                         <n1:def start="2024-04-11T22:00:00Z"  | ||
| + | </n1:e> | ||
| + |                      | ||
| + | <n1:items /> | ||
| + | </n1:l> | ||
| + | </n1:layers> | ||
| + | </n1:v> | ||
| + | </p> | ||
| + | </props> | ||
| + | </d> | ||
| + | </dps> | ||
| + | </v> | ||
| + | </vals> | ||
| + | </values> | ||
| </ | </ | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||