Description
This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in Property Options Reference.
Properties
Property name | Description | Data type | Read-only |
---|---|---|---|
id | The database ID of the object in Address Manager. | integer (int64) | No |
name | The field name, which might be null. | string | No |
type | The class name of the object. For example, a configuration object has a type equal to Configuration. This field cannot be null. A list of types is part of the API client (Java and Perl). | string | No |
properties | A string that contains properties for the object in attribute=value format, with each separated by a | (pipe) character. For example, a host record object may have a properties field such as ttl=123|comments=my comment|. This field can be null. | string | No |
Example
{
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
}