Konfigurácia univerzálneho REST a Comet API sa nastavuje v súbore A configuration of universal REST and Comet API is set in the file smartWeb.json nasledovne in the following manner:
| Blok kódu | ||
|---|---|---|
| ||
{
"application": {
"cometApi": {
"enabled": "true", /* global permission globálneor povolenieprohibition aleboof zakázaniethe Comet API rozhraniainterface, preddefinovanápredefined hodnotavalue jeis true */
"accessFilter": {
"allowedD2RpcEventNames": ["*"], /* list zoznamof povolenýchallowed eventovevents, preddefinovanápredefined hodnotavalue jeis "*" */
"allowedD2RpcMethodNames": ["*"], /* zoznamlist of povolenýchallowed RPC metódmethods, preddefinovanápredefined hodnotavalue jeis "*" */
"allowedD2ObjectNames": ["*"] /*list zoznamof prístupnýchaccessible objektovobjects, preddefinovanápredefined hodnotavalue jeis "*" */
}
},
"restApi": {
"enabled": "true", /* global permission globálneor povolenieprohibition aleboof zakázaniethe REST API rozhraniainterface, preddefinovanápredefined hodnotavalue jeis true */
"accessFilter": {
"allowedD2RpcEventNames": ["*"], /* zoznamlist of povolenýchallowed eventovevents, preddefinovanápredefined hodnotavalue jeis "*" */
"allowedD2RpcMethodNames": ["*"], /* zoznamlist of povolenýchallowed RPC metódmethods, preddefinovanápredefined hodnotavalue jeis "*" */
"allowedD2ObjectNames": ["*"] /* list zoznamof prístupnýchaccessible objektovobjects, preddefinovanápredefined hodnotavalue jeis "*" */
}
},
}
} |
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 ľubovoľný počet znakov, "?" pre ľubovoľný jeden znakIf we do not define this part of the configuration, both interfaces with calls of all RPC methods and acquisition of all objects values (current and historical values) are standardly allowed. In a configuration, it is possible to completely prohibit individual API by attributes enabled. The content of configuration objects cometApi and restApi is the object accessFilter, which defines the allowed names of objects, events and their RPC methods. It is possible to define the allowed names also generally by standard wildcart characters used while browsing files (for example "*" for an arbitrary number of characters, "?" for one arbitrary character).