Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

Odkaz na výstup diff

Obě strany předchozí revize Předchozí verze
Následující verze 		Předchozí verze
cs:mervis-scada:50-api [2025/07/17 12:12]
p.dostalek [api/get/projects] 		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/checkCredentials||+^api/v2/get/authenticate|| 
 +^api/checkCredentials [deprecated]||
 ^api/logout|| ^api/logout||
 ^api/get/projects|| ^api/get/projects||
 ^api/get/projectData|| ^api/get/projectData||
 ^api/get/projectByParts|| ^api/get/projectByParts||
-^api/get/history||+^api/get/history [deprecated]||
 ^api/get/history/specific|| ^api/get/history/specific||
 ^api/set/history|| ^api/set/history||
Řádek 33: Řádek 34:
 ===== Příklad ===== ===== Příklad =====
  
-==== api/checkCredentials ====+==== api/v2/get/authenticate ==== 
 + 
 +**Request** 
 + 
 +   * URL: https://scada.mervis.info/api/v2/get/authenticate?format=xml 
 +   * Method: POST 
 + 
 + 
 +<code javascript> 
 +{"data":{"cred":{"n":"demo","p":"demo","pe":0}}} 
 +</code> 
 + 
 +**Response XML** 
 + 
 +<code xml> 
 +<?xml version="1.0" encoding="utf-8"?> 
 +<globalResponse xmlns:r="http://dev.rcware.eu/serialization/references" xmlns:n1="http://dev.rcware.eu/scada/projects/domainWrapperClientDs2" xmlns="http://dev.rcware.eu/core/globalRequestResponse"> 
 +    <data n1:token="3:d487f7c1-d372-41a4-bee8-c16eb76fe948" n1:tokenValidFor="P1D" n1:login="demo" n1:username="" n1:user="48141739-5d16-4ca3-8ae1-33e27d9eb22e" n1:domain="3c73477a-6c95-4939-b047-7bbf902bcef1" n1:clientType="DS3" r:type="34945d89-d9ab-42be-a0ec-7676745641fb" /> 
 +    <result code="0" codeTxt="" desc="" dataType="" /> 
 +</globalResponse> 
 +</code> 
 + 
 +**Response JSON** 
 + 
 +<code javascript> 
 +{ 
 +    "data": { 
 +        "ChangePwdBefore": null, 
 +        "ClientType": 2, 
 +        "Domain": "3c73477a-6c95-4939-b047-7bbf902bcef1", 
 +        "DomainName": "GlobalDomain", 
 +        "FullName": "GlobalDomain\\demo", 
 +        "Login": "demo", 
 +        "NotifyNearingPwdExpirationIn": null, 
 +        "Token": "3:ae378e2d-c7ec-4046-aad1-12310f8f72cc", 
 +        "TokenValidFor": "P1D", 
 +        "User": "48141739-5d16-4ca3-8ae1-33e27d9eb22e", 
 +        "Username": "" 
 +    }, 
 +    "result": { 
 +        "code": 0, 
 +        "codeTxt": null, 
 +        "dataType": null, 
 +        "desc": null 
 +    } 
 +} 
 +</code> 
 +  * Získaný token **t** je třeba použít místo dvojice jméno/heslo v následujících API voláních. 
 + 
 + 
 + 
 +==== [Deprecated] api/checkCredentials ====
  
 **Request** **Request**
Řádek 53: Řádek 105:
  
   * Získaný token **t** je třeba použít místo dvojice jméno/heslo v následujících API voláních.   * Získaný token **t** je třeba použít místo dvojice jméno/heslo v následujících API voláních.
- 
- 
- 
  
 ==== api/get/projects ==== ==== api/get/projects ====
Řádek 67: Řádek 116:
  
 <code javascript> <code javascript>
-{"cred": {"t": "3:00695fb2-1c15-440f-b454-4183defbafee" }}+{"cred": {"t": "2:85be00d3-5875-4dec-a9b4-c98e2ff2acbe" }}
 </code> </code>
  
Řádek 455: Řádek 504:
  
 <code javascript> <code javascript>
-{"cred":{"n":"demo","p":"demo"}}+{ 
 +    "cred": { 
 +        "t": "2:85be00d3-5875-4dec-a9b4-c98e2ff2acbe" 
 +    }, 
 +    "projId": "1b2623be-eaa4-4e29-8596-c66dd85d5643", 
 +    "treeId": "Visual tree", 
 +    "partType": 0, 
 +    "offset": 0, 
 +    "count": 2000 
 +}
 </code> </code>
  
-**Response**+**Response XML**
  
 <code xml> <code xml>
 <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
-<checkCredentialsResult xmlns:r="http://dev.rcware.eu/serialization/references" d="GlobalDomain" l="demo" t="2:85be00d3-5875-4dec-a9b4-c98e2ff2acbe" xmlns="http://dev.rcware.eu/auth" />+<getProjectByPartsResult xmlns:r="http://dev.rcware.eu/serialization/references" projId="1b2623be-eaa4-4e29-8596-c66dd85d5643" dataVersion="638854006248661233" totalCount="15" nextOffset="-1" xmlns:n1="http://dev.rcware.eu/scada/basic-props" xmlns:n2="http://dev.rcware.eu/scada/legacy-props" xmlns:n3="http://dev.rcware.eu/rt2com" xmlns="http://dev.rcware.eu/scada/datapoints"> 
 +    <dps> 
 +        <dp id="07d538d9-9f4b-46ca-ba4d-13b13b5302ff" n="analog setpoint" canAct="true" canAlr="true"> 
 +            <v> 
 +                <props> 
 +                    <p n="Source" u="°C" t="2025-07-16T23:26:36.0742528Z" q="Good" r:type="b133774d-21ce-42b6-add3-57c012079c55" r:def="1"> 
 +                        <n1:v>6</n1:v> 
 +                    </p> 
 +                    <p n="Output" u="°C" t="2025-07-16T23:26:36.0742528Z" q="Good" r:type="b133774d-21ce-42b6-add3-57c012079c55"> 
 +                        <n1:v>6</n1:v> 
 +                    </p> 
 +                    <p n="Dec" u="°C" t="2024-09-11T13:40:30.8120217Z" q="Good" r:type="b133774d-21ce-42b6-add3-57c012079c55"> 
 +                        <n1:v>-1</n1:v> 
 +                    </p> 
 +                    <p n="Inc" u="°C" t="2024-09-11T13:40:30.8122506Z" q="Good" r:type="b133774d-21ce-42b6-add3-57c012079c55"> 
 +                        <n1:v>1</n1:v> 
 +                    </p> 
 +                    <p n="Min" u="°C" t="2024-09-11T13:40:30.8112955Z" q="Good" r:type="b133774d-21ce-42b6-add3-57c012079c55"> 
 +                        <n1:v>-10</n1:v> 
 +                    </p> 
 +                    <p n="Max" u="°C" t="2024-09-11T13:40:30.8112988Z" q="Good" r:type="b133774d-21ce-42b6-add3-57c012079c55"> 
 +                        <n1:v>20</n1:v> 
 +                    </p> 
 +                    <p n="StdVis_V1" t="2024-09-11T13:40:30.8112085Z" q="Good" r:type="b0db7bd7-0375-4830-90f2-6d918bac41ee"> 
 +                        <n1:v> 
 +                            <n1:props> 
 +                                <n1:p> 
 +                                    <n1:pn>Output</n1:pn> 
 +                                    <n1:props> 
 +                                        <n1:p r:type="033dd98a-337f-4908-9866-55961696f646"> 
 +                                            <n1:dec>3</n1:dec> 
 +                                            <n1:fs></n1:fs> 
 +                                        </n1:p> 
 +                                    </n1:props> 
 +                                </n1:p> 
 +                            </n1:props> 
 +                        </n1:v> 
 +                    </p> 
 +                    <p n="CheckMin" t="2024-09-11T13:40:30.8114074Z" q="Good" r:type="e4c0288b-9d7b-48d8-93be-fa4a0a787a36"> 
 +                        <n1:v>true</n1:v> 
 +                    </p> 
 +                    <p n="CheckMax" t="2024-09-11T13:40:30.811645Z" q="Good" r:type="e4c0288b-9d7b-48d8-93be-fa4a0a787a36"> 
 +                        <n1:v>true</n1:v> 
 +                    </p> 
 +                    <p n="LegacyRcAddress_V1" t="2024-09-11T13:40:30.8132286Z" q="Good" r:type="f426f6d7-8dd5-40a3-ac73-dd98e927fd74"> 
 +                        <n2:v e="1" g="1" n="2" o="15"> 
 +                            <n2:m> 
 +                                <n2:inpm i="0" p="Source" /> 
 +                                <n2:inpm i="15" p="Output" /> 
 +                                <n2:inpm i="7" p="Min" /> 
 +                                <n2:inpm i="8" p="Max" /> 
 +                                <n2:inpm i="5" p="Dec" /> 
 +                                <n2:inpm i="9" a="true" p="-" /> 
 +                                <n2:inpm i="6" p="Inc" /> 
 +                                <n2:inpm i="10" a="true" p="+" /> 
 +                                <n2:inpm i="11" a="true" p="INIT" /> 
 +                            </n2:m> 
 +                        </n2:v> 
 +                    </p> 
 +                    <p n="Tags_V1" t="2019-06-14T12:00:04.9014633Z" q="Good" r:type="e1b9ddbd-bf76-4c04-9f61-0626d2d774bb"> 
 +                        <n1:v> 
 +                            <tags> 
 +                                <t vt="String" k="pointy_type" v="one" /> 
 +                            </tags> 
 +                        </n1:v> 
 +                    </p> 
 +                    <p n="LAlr" u="°C" t="0001-01-01T00:00:00" q="Unknown" r:type="b133774d-21ce-42b6-add3-57c012079c55"> 
 +                        <n1:v>0</n1:v> 
 +                    </p> 
 +                    <p n="HAlr" u="°C" t="0001-01-01T00:00:00" q="Unknown" r:type="b133774d-21ce-42b6-add3-57c012079c55"> 
 +                        <n1:v>0</n1:v> 
 +                    </p> 
 +                    <p n="LAlrAct" t="0001-01-01T00:00:00" q="Unknown" r:type="e4c0288b-9d7b-48d8-93be-fa4a0a787a36"> 
 +                        <n1:v>false</n1:v> 
 +                    </p> 
 +                    <p n="HAlrAct" t="0001-01-01T00:00:00" q="Unknown" r:type="e4c0288b-9d7b-48d8-93be-fa4a0a787a36"> 
 +                        <n1:v>false</n1:v> 
 +                    </p> 
 +                </props> 
 +            </v> 
 +            <a> 
 +                <props> 
 +                    <p n="-" r:type="2e0a871a-af8e-4234-8d27-e3145aeb6bd3"> 
 +                        <n1:diff>Dec</n1:diff> 
 +                        <n1:target>Output</n1:target> 
 +                    </p> 
 +                    <p n="+" r:type="2e0a871a-af8e-4234-8d27-e3145aeb6bd3"> 
 +                        <n1:diff>Inc</n1:diff> 
 +                        <n1:target>Output</n1:target> 
 +                    </p> 
 +                    <p n="INIT" r:type="90d4f1b9-c18c-4ce9-9799-d1475d949139"> 
 +                        <n1:interactive>true</n1:interactive> 
 +                        <n1:interactiveTimestamp>false</n1:interactiveTimestamp> 
 +                        <n1:target>Output</n1:target> 
 +                        <n1:nonInteractiveValue>0</n1:nonInteractiveValue> 
 +                    </p> 
 +                </props> 
 +            </a> 
 +            <core r:type="ffdebc6e-11fc-4bcb-949d-04c05dabc6d5" /> 
 +        </dp> 
 + ... 
 +    </dps> 
 +</getProjectByPartsResult>
 </code> </code>
  
-  * Získaný token **t** je třeba použít místo dvojice jméno/heslo v následujících API voláních. +**Response JSON**
- +
  
 +<code javascript>
 +{
 +    "ns": {
 +        "r": "http://dev.rcware.eu/serialization/references",
 +        "n1": "http://dev.rcware.eu/scada/datapoints",
 +        "n2": "http://dev.rcware.eu/scada/basic-props",
 +        "n3": "http://dev.rcware.eu/scada/legacy-props",
 +        "n4": "http://dev.rcware.eu/rt2com"
 +    },
 +    "doc": {
 +        "n1:getProjectByPartsResult": {
 +            "@": {
 +                "n1:projId": "1b2623be-eaa4-4e29-8596-c66dd85d5643",
 +                "n1:dataVersion": "638854006248661233",
 +                "n1:totalCount": 15,
 +                "n1:nextOffset": -1
 +            },
 +            "n1:dps": [
 +                {
 +                    "n1:dp": {
 +                        "@": {
 +                            "n1:id": "07d538d9-9f4b-46ca-ba4d-13b13b5302ff",
 +                            "n1:n": "analog setpoint",
 +                            "n1:canAct": true,
 +                            "n1:canAlr": true
 +                        },
 +                        "n1:v": {
 +                            "n1:props": [
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "Source",
 +                                            "n1:u": "°C",
 +                                            "n1:t": "2025-07-16T23:26:36.0742528Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "b133774d-21ce-42b6-add3-57c012079c55",
 +                                            "r:def": "1"
 +                                        },
 +                                        "n2:v": 6.0
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "Output",
 +                                            "n1:u": "°C",
 +                                            "n1:t": "2025-07-16T23:26:36.0742528Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "b133774d-21ce-42b6-add3-57c012079c55"
 +                                        },
 +                                        "n2:v": 6.0
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "Dec",
 +                                            "n1:u": "°C",
 +                                            "n1:t": "2024-09-11T13:40:30.8120217Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "b133774d-21ce-42b6-add3-57c012079c55"
 +                                        },
 +                                        "n2:v": -1.0
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "Inc",
 +                                            "n1:u": "°C",
 +                                            "n1:t": "2024-09-11T13:40:30.8122506Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "b133774d-21ce-42b6-add3-57c012079c55"
 +                                        },
 +                                        "n2:v": 1.0
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "Min",
 +                                            "n1:u": "°C",
 +                                            "n1:t": "2024-09-11T13:40:30.8112955Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "b133774d-21ce-42b6-add3-57c012079c55"
 +                                        },
 +                                        "n2:v": -10.0
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "Max",
 +                                            "n1:u": "°C",
 +                                            "n1:t": "2024-09-11T13:40:30.8112988Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "b133774d-21ce-42b6-add3-57c012079c55"
 +                                        },
 +                                        "n2:v": 20.0
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "StdVis_V1",
 +                                            "n1:t": "2024-09-11T13:40:30.8112085Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "b0db7bd7-0375-4830-90f2-6d918bac41ee"
 +                                        },
 +                                        "n2:v": {
 +                                            "n2:props": [
 +                                                {
 +                                                    "n2:p": {
 +                                                        "n2:pn": "Output",
 +                                                        "n2:props": [
 +                                                            {
 +                                                                "n2:p": {
 +                                                                    "n2:dec": 3,
 +                                                                    "n2:fs": "",
 +                                                                    "@": {
 +                                                                        "r:type": "033dd98a-337f-4908-9866-55961696f646"
 +                                                                    }
 +                                                                }
 +                                                            }
 +                                                        ]
 +                                                    }
 +                                                }
 +                                            ]
 +                                        }
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "CheckMin",
 +                                            "n1:t": "2024-09-11T13:40:30.8114074Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "e4c0288b-9d7b-48d8-93be-fa4a0a787a36"
 +                                        },
 +                                        "n2:v": true
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "CheckMax",
 +                                            "n1:t": "2024-09-11T13:40:30.811645Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "e4c0288b-9d7b-48d8-93be-fa4a0a787a36"
 +                                        },
 +                                        "n2:v": true
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "LegacyRcAddress_V1",
 +                                            "n1:t": "2024-09-11T13:40:30.8132286Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "f426f6d7-8dd5-40a3-ac73-dd98e927fd74"
 +                                        },
 +                                        "n3:v": {
 +                                            "@": {
 +                                                "n3:e": 1,
 +                                                "n3:g": 1,
 +                                                "n3:n": 2,
 +                                                "n3:o": 15
 +                                            },
 +                                            "n3:m": [
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 0,
 +                                                            "n3:p": "Source"
 +                                                        }
 +                                                    }
 +                                                },
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 15,
 +                                                            "n3:p": "Output"
 +                                                        }
 +                                                    }
 +                                                },
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 7,
 +                                                            "n3:p": "Min"
 +                                                        }
 +                                                    }
 +                                                },
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 8,
 +                                                            "n3:p": "Max"
 +                                                        }
 +                                                    }
 +                                                },
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 5,
 +                                                            "n3:p": "Dec"
 +                                                        }
 +                                                    }
 +                                                },
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 9,
 +                                                            "n3:a": true,
 +                                                            "n3:p": "-"
 +                                                        }
 +                                                    }
 +                                                },
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 6,
 +                                                            "n3:p": "Inc"
 +                                                        }
 +                                                    }
 +                                                },
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 10,
 +                                                            "n3:a": true,
 +                                                            "n3:p": "+"
 +                                                        }
 +                                                    }
 +                                                },
 +                                                {
 +                                                    "n3:inpm": {
 +                                                        "@": {
 +                                                            "n3:i": 11,
 +                                                            "n3:a": true,
 +                                                            "n3:p": "INIT"
 +                                                        }
 +                                                    }
 +                                                }
 +                                            ]
 +                                        }
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "Tags_V1",
 +                                            "n1:t": "2019-06-14T12:00:04.9014633Z",
 +                                            "n1:q": "Good",
 +                                            "r:type": "e1b9ddbd-bf76-4c04-9f61-0626d2d774bb"
 +                                        },
 +                                        "n2:v": {
 +                                            "n1:tags": [
 +                                                {
 +                                                    "n1:t": {
 +                                                        "@": {
 +                                                            "n1:vt": "String",
 +                                                            "n1:k": "pointy_type",
 +                                                            "n1:v": "one"
 +                                                        }
 +                                                    }
 +                                                }
 +                                            ]
 +                                        }
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "LAlr",
 +                                            "n1:u": "°C",
 +                                            "n1:t": "0001-01-01T00:00:00",
 +                                            "n1:q": "Unknown",
 +                                            "r:type": "b133774d-21ce-42b6-add3-57c012079c55"
 +                                        },
 +                                        "n2:v": 0.0
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "HAlr",
 +                                            "n1:u": "°C",
 +                                            "n1:t": "0001-01-01T00:00:00",
 +                                            "n1:q": "Unknown",
 +                                            "r:type": "b133774d-21ce-42b6-add3-57c012079c55"
 +                                        },
 +                                        "n2:v": 0.0
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "LAlrAct",
 +                                            "n1:t": "0001-01-01T00:00:00",
 +                                            "n1:q": "Unknown",
 +                                            "r:type": "e4c0288b-9d7b-48d8-93be-fa4a0a787a36"
 +                                        },
 +                                        "n2:v": false
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "HAlrAct",
 +                                            "n1:t": "0001-01-01T00:00:00",
 +                                            "n1:q": "Unknown",
 +                                            "r:type": "e4c0288b-9d7b-48d8-93be-fa4a0a787a36"
 +                                        },
 +                                        "n2:v": false
 +                                    }
 +                                }
 +                            ]
 +                        },
 +                        "n1:a": {
 +                            "n1:props": [
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "-",
 +                                            "r:type": "2e0a871a-af8e-4234-8d27-e3145aeb6bd3"
 +                                        },
 +                                        "n2:diff": "Dec",
 +                                        "n2:target": "Output"
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "+",
 +                                            "r:type": "2e0a871a-af8e-4234-8d27-e3145aeb6bd3"
 +                                        },
 +                                        "n2:diff": "Inc",
 +                                        "n2:target": "Output"
 +                                    }
 +                                },
 +                                {
 +                                    "n1:p": {
 +                                        "@": {
 +                                            "n1:n": "INIT",
 +                                            "r:type": "90d4f1b9-c18c-4ce9-9799-d1475d949139"
 +                                        },
 +                                        "n2:interactive": true,
 +                                        "n2:interactiveTimestamp": false,
 +                                        "n2:target": "Output",
 +                                        "n2:nonInteractiveValue": 0.0
 +                                    }
 +                                }
 +                            ]
 +                        },
 +                        "n1:core": {
 +                            "@": {
 +                                "r:type": "ffdebc6e-11fc-4bcb-949d-04c05dabc6d5"
 +                            }
 +                        }
 +                    }
 +                }
 +         ...
 +            ]
 +        }
 +    }
 +}
 +</code>
  
 ==== api/v3/get/history ==== ==== api/v3/get/history ====
  • © Energocentrum Plus, s.r.o. 2017 - 2025