System Configuration Methods

Method Description
updateConfig Updates the system configuration record.
The user calling this method must have AdministratorRight and cannot be assigned to a department.
Note: When performing an update, only set the fields that you want to update in the Config object. The rest of the fields will be null.
To update a field to become null:
  • String objects should be set to be an empty string (for example: "").
  • The members of DateTime objects should be set to zero.
getConfig Gets the system configuration record for a given host.

If the configuration record is not found, a null is returned.

The user calling this method must have AdministratorRight and cannot be assigned to a department.

retrieveAllConfigs Gets the system configuration for each host in the system.

The last element of the array is null. If no configuration is found, an array of one element is returned with a value of null.

The user calling this method must have AdministratorRight and cannot be assigned to a department.

removeConfig Removes the system configuration record for a given host.

The user calling this method must have AdministratorRight and cannot be assigned to a department.