Konfigurácia univerzálneho REST a Comet API sa nastavuje v súbore smartWeb.json
nasledovne:
Blok kódu | ||
---|---|---|
| ||
{
"application": {
"cometApi": {
"enabled": "true", /* globálne povolenie alebo zakázanie Comet API rozhrania, preddefinovaná hodnota je true */
"accessFilter": {
"allowedD2RpcEventNames": ["*"], /* zoznam povolených eventov, preddefinovaná hodnota je "*" */
"allowedD2RpcMethodNames": ["*"], /* zoznam povolených RPC metód, preddefinovaná hodnota je "*" */
"allowedD2ObjectNames": ["*"] /* zoznam prístupných objektov, preddefinovaná hodnota je "*" */
}
},
"restApi": {
"enabled": "true", /* globálne povolenie alebo zakázanie REST API rozhrania, preddefinovaná hodnota je true */
"accessFilter": {
"allowedD2RpcEventNames": ["*"], /* zoznam povolených eventov, preddefinovaná hodnota je "*" */
"allowedD2RpcMethodNames": ["*"], /* zoznam povolených RPC metód, preddefinovaná hodnota je "*" */
"allowedD2ObjectNames": ["*"] /* zoznam prístupných objektov, preddefinovaná hodnota je "*" */
}
},
}
} |
Pokiaľ túto časť konfigurácie nedefinujeme štandardne sú povolené obe rozhrania s volaniami všetkých RPC metód a získavanie hodnôt všetkých objektov (aktuálne hodnoty aj archívne). V konfigurácii je možne jednotlivé API úplne zakázať atribútmi enabled
. Obsahom konfiguračných objektov cometApi
a restApi
je objekt accessFilter,
ktorý definuje povolené názvy objektov, eventov, ich RPC metód. Povolené názvy je možné definovať aj všeobecne pomocou štandardných wildcard znakov, používaných pri vyhľadávaní súborov (napr. "
*"
pre lubovolný počet znakov, "?
" pre ľubovolný jeden znak).