Konfigurácia API rozhraní REST, Comet, OData

Konfigurácia API rozhraní REST, Comet, OData

Konfigurácia API rozhraní REST, Comet, OData

Konfigurácia  REST, Comet a ODATA API rozhraní sa nastavuje v súbore smartWeb.json nasledovne:

{ "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 archívnych objektov, preddefinovaná hodnota je "*" */ "allowedD2EdaVectorReadCodes": ["*"] /* zoznam prístupných EDA vektorov ktorých hodnoty je možné načítať, preddefinovaná hodnota je "*" */     "allowedD2EdaVectorUpdateCodes": ["*"] /* zoznam prístupných EDA vektorov ktorých hodnoty je možné zapísať, preddefinovaná hodnota je "*" */   } }, "odataApi": { "enabled": "true", /* globálne povolenie alebo zakázanie ODATA API rozhrania, preddefinovaná hodnota je false*/ "accessFilter": {       "allowedD2EdaVectorReadCodes": ["*"] /* zoznam prístupných EDA vektorov ktorých hodnoty je možné načítať, preddefinovaná hodnota je "*" */     "allowedD2ObjectNames": ["*"] /* zoznam prístupných archívnych objektov ktorých hodnoty je možné načítať, preddefinovaná hodnota je "*" */ } }           } }

Pokiaľ túto časť konfigurácie nedefinujeme, štandardne sú povolené iba rozhrania REST a Comet 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 znak).