ConfigService
Session Bean implementation class ConfigWebService
Endpoint Metadata
- Namespace: http://opencase.extend.com/webservices/config
- Endpoint Name: ConfigWebService
- Endpoint Address: http(s)://{VMS URL}/opencase/webservices/config-service
The following methods are available on this endpoint:
Retrieves a list of root nodes that can be navigated through to access all properties that exist within the configuration tree.
Return Value
type |
description |
list<config>
|
A list of all properties presented as root configuration objects that can be navigated through to access any node within the tree. |
Retrieves a configuration property from a given object name.
Input Parameters
name |
type |
description |
name |
string |
The name of the config object whose property is to be retrieved. |
Return Value
type |
description |
config
|
The passed object's configuration property. |
Faults
name |
description |
ClientFault |
If the configuration property cannot be retrieved for any reason. |
Retrieves a config property object that matches the given config name and the parent object.
Input Parameters
name |
type |
description |
name |
string |
The config object name. |
parent |
config
|
The parent object. |
Return Value
type |
description |
config
|
A config property object that matches the passed config name and parent object. |
Faults
name |
description |
ClientFault |
If the configuration property object cannot be retrieved for any reason. |
Retrieves a config property object that matches the given config name and parent name.
Input Parameters
name |
type |
description |
name |
string |
The config object name. |
parent |
string |
(no documentation provided) |
Return Value
type |
description |
config
|
A config property object that matches the config name and parent name. |
Faults
name |
description |
ClientFault |
If the configuration property object cannot be retrieved for any reason. |
Retrieves a list of config property objects that match the given name.
Input Parameters
name |
type |
description |
name |
string |
The name of the config object. |
Return Value
Faults
name |
description |
ClientFault |
If the list of config objects cannot be retrieved for any reason. |
Retrieves a list of config property objects that match the name and parent name of the specific config objects.
Input Parameters
name |
type |
description |
name |
string |
The name of the config objects to match. |
parentName |
string |
The parent name of the config objects to match. |
Return Value
type |
description |
list<config>
|
A list of config property objects. |
Faults
name |
description |
ClientFault |
If the list of config objects cannot be retrieved for any reason. |
Retrieves a list of config property objects that match the parent.
Input Parameters
name |
type |
description |
parent |
config
|
The parent of the config object. |
Return Value
Faults
name |
description |
ClientFault |
If the list of config objects cannot be retrieved for any reason. |
Generate a menu tree
Return Value
type |
description |
list<Menu>
|
a menu tree (unfiltered) |
Faults
name |
description |
ClientFault |
(no documentation provided) |
Updates value for the config setting specified by config name and config parent name.
Input Parameters
name |
type |
description |
name |
string |
config name |
parentName |
string |
config parent name |
value |
string |
value to be set into config |
Faults
name |
description |
ClientFault |
if any exception occurs |