| SERVICE | PARAMS | RETURN | EXAMPLES |
| GetActiveEvents |
idnClient: client identifier |
Collection of active events associated to user's instances. For each active event it returns its event number id, master id, agent type, instance identifier, instance type, date of init, date of end, date of server recording, number of values, severity type, severity description, number of occurrences, event text, correlation identifier and node name identifier. |
|
| GetGlobalNote |
idnClient: client identifier range: maximun number of marks to be returned |
Collection of system marks registered in the historical with total length minor or equal to range. For each system mark it returns its mark number, date of init and date of end. |
|
| GetInstanceDetail |
idnClient: client identifier idnInstance: instance identifier |
Relevant information about the instance identified by idnInstance. This includes instance identifier, instance description, instance type, type description, availability indicator, date of availability, severity type, severity description, date of severity and, if any, a collection of infos associated to this instance. For each info it returns event type, info text and date of info. |
|
| GetInstances |
idnClient: client identifier |
Collection of instances associated to the user. For each instance it returns its instance identifier, instance description, instance type, type description, availability indicator, date of availability, severity type, severity description and date of severity. | |
| GetInstancesByType |
idnClient: client identifier typInstance: instance type |
Collection of instances associated to the user matching the type given in typInstance. For each instance it returns its instance identifier, instance description, instance type, type description, availability indicator, date of availability, severity type, severity description and date of severity. | |
| GetServiceDetail |
idnClient: client identifier idnService: service identifier |
Relevant information about the service identified by idnService. This includes service identifier, service description, sla identifier, sla description, availability indicator, date of availability, severity type, severity description, date of severity and, if any, a collection of instances associated to this service. For each instance it returns instance identifier, instance description, instance type, type description, availability indicator, date of availability, severity type, severity description and date of severity. |
|
| GetServices |
idnClient: client identifier |
Collection of services associated to the user. For each service it returns service identifier, service description, sla identifier, sla description, availability indicator, date of availability, severity type, severity description, date of severity and, if any, a collection of instances associated to this service. For each instance it returns instance identifier, instance description, instance type, type description, availability indicator, date of availability, severity type, severity description and date of severity. |
|
| RemoveUser |
idnClient: client identifier idnUser: user identifier |
"0" if the user was successfully removed. |
|
| AddUser |
idnClient: client identifier idnUser: user identifier passUser: user password desUser: user description mailUser: user email tlphUser: user telephone (could be "null") roleUser: user role |
"0" if the user was successfully added. |
|
| UpdateUser |
idnClient: client identifier idnUser: user identifier passUser: new user password ("null" for no changes) desUser: new user description ("null" for no changes) mailUser: new user email ("null" for no changes) tlphUser: new user telephone ("null" for no changes) roleUser: new user role ("null" for no changes) |
"0" if the user was successfully updated. |
|
| AddInstance |
idnInstance: instance identifier desInstance: instance description typInstance: type of instance connInfo: connection info nodeName: name of the node snmCommunity: SNMP community associated with the instance (optional) snmPort: SNMP port associated with the instance (optional) |
"0" if the instance was successfully added. |
Note: idnClient parameter is implemented to be used in future releases, actually you must set it to its default value '00000000'