( Return to API Overview )
- createKey
- deleteKey
- listAllKeys
- updateKey
Description
Provides methods to access and modify custom system information.
Namespace:
system.custominfo
Description:
Create a new custom key
Parameters:
-
string sessionKey
-
string keyLabel - new key's label
-
string keyDescription - new key's description
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Delete an existing custom key and all systems' values for the key.
Parameters:
-
string sessionKey
-
string keyLabel - new key's label
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
List the custom information keys defined for the user's organization.
Parameters:
Returns:
-
array:
-
struct - custom info
- int "id"
- string "label"
- string "description"
- int "system_count"
- dateTime.iso8601 "last_modified"
Description:
Update description of a custom key
Parameters:
-
string sessionKey
-
string keyLabel - key to change
-
string keyDescription - new key's description
Returns:
-
int - 1 on success, exception thrown otherwise.