Wiki
Clone wikiNumera.LibrisAPI / configuration.rules
Home > API Reference Documentation > configuration.rules
configuration.rules
The configuration.rules
action is used to request metadata about the configuration settings for the realm you are working with. This allows you to know if certain settings have been "locked" so that they can not be edited at the level you are working with (most-likely a device or sub-realm). The information returned is a JSON object with the following properties. The property names match to a configuration setting and contain their own object structure for metadata. Today, the only setting you can rely on is whether or not something is locked
. If locked == true
this means the setting can not be customized below the realm you supplied (i.e. it can not be set on a device level or for sub-realms of the current realm).
Input Parameters
Property | Required | Description |
---|---|---|
realm | no | If not supplied, it returns the system level meta data. |
Output
A result object with properties representing meta data about certain configuration settings.
Property | Description |
---|---|
LastModified | iso formatted string of when this data was modified |
fd.disable | JSON object detailing meta data properties, such as locked |
.... | Any configuration setting can appear in this result object |
Updated