Property class examples
This topic provides examples for the property class.
- List the property classes (type prefix)
- Get the children of the SystemObject class (type prefix)
- Get the Job property class (type prefix)
- Get the children of the Server property class (type prefix)
- Get the children of the Server property class using a property value filter (type prefix)
- Get a single resource by GUID (id prefix)
- Get the children of /group
- Get the children of a group (group prefix)
- Get the value of a specific property on a specific object (group prefix)
List the property classes (type prefix)
XML response
<RESTXMLResponse>
<PropertySetClassChildrenResponse>
<PropertySetClassChildren>
<PropertySetClasses>
<PropertySetClass name="SystemObject" path="Class://SystemObject"
uri="/type/PropertySetClasses/SystemObject" />
</PropertySetClasses>
</PropertySetClassChildren>
</PropertySetClassChildrenResponse>
</RESTXMLResponse>
</RESTXMLResponse>
JSON response
"PropertySetClassChildrenResponse": {
"PropertySetClassChildren": {
"PropertySetClasses": {
"totalCount": "1",
"Elements": [
{
"name": "SystemObject",
"uri": "/type/PropertySetClasses/SystemObject"
}
]
}
}
}
}
Get the children of the SystemObject class (type prefix)
XML response
<RESTXMLResponse>
<PropertySetClassChildrenResponse>
<PropertySetClassChildren>
<PropertySetClasses>
<PropertySetClass name="Component Template"
path="Class://SystemObject/Component Template" uri="/type/PropertySetClasses/SystemObject/Component Template" />
<PropertySetClass name="Server"
path="Class://SystemObject/Server" uri="/type/PropertySetClasses/SystemObject/Server" />
<PropertySetClass name="Component"
path="Class://SystemObject/Component" uri="/type/PropertySetClasses/SystemObject/Component" />
<PropertySetClass name="Depot Object"
path="Class://SystemObject/Depot Object" uri="/type/PropertySetClasses/SystemObject/Depot Object" />
path="Class://SystemObject/Depot Object" uri="/type/PropertySetClasses/SystemObject/Depot Object" />
...
OMITTED
...
<PropertySetClass name="Custom Objects Environment"
path="Class://SystemObject/Custom Objects Environment"
uri="/type/PropertySetClasses/SystemObject/Custom Objects Environment" />
<PropertySetClass
name="Compliance Job Result Unique Component For A Template"
path="Class://SystemObject/Compliance Job Result Unique Component For A Template"
uri="/type/PropertySetClasses/SystemObject/Compliance Job Result Unique Component For A Template" />
<PropertySetClass name="WSClass0.627975373097106"
path="Class://SystemObject/WSClass0.627975373097106"
uri="/type/PropertySetClasses/SystemObject/WSClass0.627975373097106" />
</PropertySetClasses>
</PropertySetClassChildren>
</PropertySetClassChildrenResponse>
</RESTXMLResponse>
JSON response
"PropertySetClassChildrenResponse": {
"PropertySetClassChildren": {
"PropertySetClasses": {
"totalCount": "63",
"Elements": [
{
"name": "Component Template",
"uri": "/type/PropertySetClasses/SystemObject/Component Template"
},
{
"name": "Server",
"uri": "/type/PropertySetClasses/SystemObject/Server"
},
{
"name": "Component",
"uri": "/type/PropertySetClasses/SystemObject/Component"
},
{
"name": "Depot Object",
"uri": "/type/PropertySetClasses/SystemObject/Depot Object"
},
},
...
OMITTED
...
{
"name": "Custom Objects Environment",
"uri": "/type/PropertySetClasses/SystemObject/Custom Objects Environment"
},
{
"name": "Compliance Job Result Unique Component For A Template",
"uri": "/type/PropertySetClasses/SystemObject/Compliance Job Result Unique Component For A Template"
},
]
}
}
}
}
Get the Job property class (type prefix)
XML response
<RESTXMLResponse>
<PropertySetClassResponse>
<PropertySetClass name="Job" uri="/type/PropertySetClasses/SystemObject/Job">
<Properties totalCount="29">
<Property name="EXECUTION_ROLE" isList="false" type="String" defaultValue="" />
<Property name="RESULTS_RETENTION_TIME" isList="false" type="Integer" defaultValue="" />
<Property name="IS_SERVER_SPECIFIED*" isList="false" type="Boolean" defaultValue="" />
<Property name="MAX_PARALLEL_PER_VM_HOST*" isList="false" type="Integer" defaultValue="0" />
<Property name="USER_MODIFIED" isList="false" type="String" defaultValue="" />
<Property name="USER_CREATED" isList="false" type="String" defaultValue="" />
<Property name="JOB_RESULT_PROPERTY_NAME*" isList="false" type="String" defaultValue="" />
<Property name="JOB_PART_TIMEOUT" isList="false" type="Integer" defaultValue="0" />
<Property name="IS_SCHEDULED" isList="false" type="Boolean" defaultValue="false" />
<Property name="AUDIT_TRAILS*" isList="true" type="/type/PropertySetClasses/SystemObject/AuditTrail" defaultValue="" />
<Property name="ROLE_CREATED" isList="false" type="String" defaultValue="" />
<Property name="IS_COMPONENT_SPECIFIED*" isList="false" type="Boolean" defaultValue="" />
<Property name="DATE_MODIFIED" isList="false" type="Date" defaultValue="" />
<Property name="NAME" isList="false" type="String" defaultValue="" />
<Property name="NAME" isList="false" type="String" defaultValue="" />
...
OMITTED
...
<Property name="JOB_TIMEOUT" isList="false" type="Integer" defaultValue="0" />
<Property name="BL_ACL*" isList="false" type="/type/PropertySetClasses/SystemObject/BlAcl" defaultValue="" />
<Property name="DATE_CREATED" isList="false" type="Date" defaultValue="" />
</Properties>
<Operations totalCount="7">
<Operation name="execute" returnType="Statuses">
<OperationArguments totalCount="1">
<OperationArgument name="job" type="/type/PropertySetClasses/SystemObject/Job" list="false" />
</OperationArguments>
</Operation>
...
OMITTED
...
</Operations>
</PropertySetClass>
</PropertySetClassResponse>
</RESTXMLResponse>
Get the children of the Server property class (type prefix)
XML response
<RESTXMLResponse>
<PropertySetClassChildrenResponse>
<PropertySetClassChildren>
<PropertySetClasses totalCount="1">
<PropertySetClass name="Agentless Managed Object" uri="/type/PropertySetClasses/SystemObject/Server/Agentless Managed Object" />
</PropertySetClasses>
<PropertySetInstances totalCount="1">
<PropertySetInstance name="myServer" description="" type="/type/PropertySetClasses/SystemObject/Server" dbKey="DBKey:SDeviceModelKeyImpl:2000000-2003106" objectId="0d3a0f31-7185-4594-b326-26f3ecf463a5" uri="/id/SystemObject/Server/0d3a0f31-7185-4594-b326-26f3ecf463a5" modelType="SERVER" modelTypeId="5004" />
</PropertySetInstances>
</PropertySetClassChildren>
</PropertySetClassChildrenResponse>
</RESTXMLResponse>
Get the children of the Server property class using a property value filter (type prefix)
This example uses the NAME value as a filter.
Request URI: /type/PropertySetClasses/SystemObject/Server/?NAME=myServer
XML response
<RESTXMLResponse>
<PropertySetClassChildrenResponse>
<PropertySetClassChildren>
<PropertySetInstances totalCount="1">
<PropertySetInstance name="myServer" description="" type="/type/PropertySetClasses/SystemObject/Server" dbKey="DBKey:SDeviceModelKeyImpl:2000000-2003106" objectId="0d3a0f31-7185-4594-b326-26f3ecf463a5" uri="/id/SystemObject/Server/0d3a0f31-7185-4594-b326-26f3ecf463a5" modelType="SERVER" modelTypeId="5004" />
</PropertySetInstances>
</PropertySetClassChildren>
</PropertySetClassChildrenResponse>
</RESTXMLResponse>
Get a single resource by GUID (id prefix)
For information about how to obtain a GUID, see Obtaining a GUID for use with /id prefix.
The returned PropertyValue elements can be of various types: primitives, enums, lists, objects, and so on. For information about how to interpret each type, see Analyzing property value responses for primitives and more complex objects.
Request URI: /id/SystemObject/Server/d163b519-4c1d-4830-9972-87386a7e0c8f
XML response
<RESTXMLResponse>
<PropertySetInstanceChildrenResponse>
<PropertySetInstanceChildren>
<PropertyValues totalCount="65">
<PropertyValue name="SOLARIS_ALTERNATIVE_BOOT_ENV*" isList="false" type="String" uri="/id/SystemObject/
Server/0d3a0f31-7185-4594-b326-26f3ecf463a5/PropertyValues/SOLARIS_ALTERNATIVE_BOOT_ENV*"
isNull="true" isNoAccess="false" value="" />
<PropertyValue name="BL_ACL*" isList="false" type="/type/PropertySetClasses/SystemObject/BlAcl"
uri="/id/SystemObject/Server/0d3a0f31-7185-4594-b326-26f3ecf463a5/PropertyValues/BL_ACL*"
isNull="false" isNoAccess="false" value="">
<PropertySetInstance name="" description="" type="/type/PropertySetClasses/SystemObject/BlAcl"
dbKey="DBKey:SBlAclKeyImpl:2000701" objectId="556b2c4a-20af-49fe-97f5-cb8b77f5412c"
uri="/id/SystemObject/BlAcl/556b2c4a-20af-49fe-97f5-cb8b77f5412c" modelType="BL_ACL"
modelTypeId="1012">
<PropertyValues totalCount="16">
<PropertyValue name="DATE_MODIFIED" isList="false" type="Date" uri="/id/SystemObject/
BlAcl/556b2c4a-20af-49fe-97f5-cb8b77f5412c/PropertyValues/DATE_MODIFIED"
isNull="true" isNoAccess="false" value="" />
<PropertyValue name="GROUP*" isList="false" type="/type/PropertySetClasses/SystemObject/
Static Group" uri="/id/SystemObject/BlAcl/556b2c4a-20af-49fe-97f5-cb8b77f5412c/
PropertyValues/GROUP*" isNull="false" isNoAccess="false" value="" />
<PropertyValue name="NAME" isList="false" type="String" uri="/id/SystemObject/
BlAcl/556b2c4a-20af-49fe-97f5-cb8b77f5412c/PropertyValues/NAME"
isNull="true" isNoAccess="false" value="" />
<PropertyValue name="RBAC_ACES" isList="true" type="/type/PropertySetClasses/SystemObject/
RbacAce" uri="/id/SystemObject/BlAcl/556b2c4a-20af-49fe-97f5-cb8b77f5412c/PropertyValues/
RBAC_ACES/" isNull="false" isNoAccess="false" value="">
<PropertyValueElements totalCount="1">
<PropertyValueElement isNull="false" isNoAccess="false" value="">
<PropertySetInstance name="" description="" type="/type/PropertySetClasses/
SystemObject/BlAce" dbKey="DBKey:SBlAceKeyImpl:2000600"
objectId="66931a6c-9794-4b30-a4c4-7316896ff2eb"
uri="/id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb"
modelType="BL_ACE" modelTypeId="1011">
<PropertyValues totalCount="17">
<PropertyValue name="BL_AUTH" isList="false" type="/type/PropertySetClasses/
SystemObject/Authorization" uri="/id/SystemObject/BlAce/
66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/BL_AUTH"
isNull="false" isNoAccess="false" value="" />
<PropertyValue name="DATE_MODIFIED" isList="false" type="Date"
uri="/id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/
PropertyValues/DATE_MODIFIED" isNull="true" isNoAccess="false"
value="" />
<PropertyValue name="GROUP*" isList="false" type="/type/PropertySetClasses/
SystemObject/Static Group" uri="/id/SystemObject/BlAce/
66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/GROUP*"
isNull="false" isNoAccess="false" value="" />
<PropertyValue name="NAME" isList="false" type="String" uri="/id/SystemObject/
BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/NAME"
isNull="true" isNoAccess="false" value="" />
<PropertyValue name="DESCRIPTION" isList="false" type="String" uri="/
id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/
PropertyValues/DESCRIPTION" isNull="true" isNoAccess="false" value="" />
<PropertyValue name="ROLE" isList="false" type="/type/PropertySetClasses/
SystemObject/Role" uri="/id/SystemObject/BlAce/
66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/
ROLE" isNull="false" isNoAccess="false" value="" />
<PropertyValue name="USER_CREATED" isList="false" type="String"
uri="/id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/
PropertyValues/USER_CREATED" isNull="true" isNoAccess="false" value="" />
<PropertyValue name="USER_MODIFIED" isList="false" type="String" uri="/id/
SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/
USER_MODIFIED" isNull="true" isNoAccess="false" value="" />
<PropertyValue name="AUTO_GENERATED" isList="false" type="Boolean"
uri="/id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/
PropertyValues/AUTO_GENERATED" isNull="true"
isNoAccess="false" value="" />
<PropertyValue name="BROKEN_OBJECT" isList="false" type="Boolean"
uri="/id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/
PropertyValues/BROKEN_OBJECT" isNull="true"
isNoAccess="false" value="" />
<PropertyValue name="GROUPS*" isList="true" type="/type/PropertySetClasses/
SystemObject/Static Group" uri="/id/SystemObject/
BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/GROUPS*/"
isNull="false" isNoAccess="false" value="" />
<PropertyValue name="IS_AUTH_PROFILE" isList="false" type="Boolean"
uri="/id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/
PropertyValues/IS_AUTH_PROFILE" isNull="false"
isNoAccess="false" value="false" />
<PropertyValue name="ROLE_MODIFIED" isList="false" type="String"
uri="/id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/
PropertyValues/ROLE_MODIFIED" isNull="true"
isNoAccess="false" value="" />
<PropertyValue name="AUDIT_TRAILS*" isList="true" type="/type/
PropertySetClasses/SystemObject/AuditTrail" uri="/id/SystemObject/
BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/
AUDIT_TRAILS*/" isNull="false" isNoAccess="false" value="" />
<PropertyValue name="ROLE_CREATED" isList="false" type="String"
uri="/id/SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/
PropertyValues/ROLE_CREATED" isNull="true"
isNoAccess="false" value="" />
<PropertyValue name="BL_ACL*" isList="false" type="/type/
PropertySetClasses/SystemObject/BlAcl" uri="/id/SystemObject/
BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/BL_ACL*"
isNull="true" isNoAccess="false" value="" />
<PropertyValue name="DATE_CREATED" isList="false" type="Date" uri="/id/
SystemObject/BlAce/66931a6c-9794-4b30-a4c4-7316896ff2eb/PropertyValues/
DATE_CREATED" isNull="true" isNoAccess="false" value="" />
</PropertyValues>
</PropertySetInstance>
</PropertyValueElement>
</PropertyValueElements>
</PropertyValue>
<PropertyValue name="DESCRIPTION" isList="false" type="String" uri="/id/SystemObject/
BlAcl/556b2c4a-20af-49fe-97f5-cb8b77f5412c/PropertyValues/DESCRIPTION"
isNull="true" isNoAccess="false" value="" />
<PropertyValue name="CURRENT_ROLE_AUTH_NAMES" isList="true" type="String" uri="/id/
SystemObject/BlAcl/556b2c4a-20af-49fe-97f5-cb8b77f5412c/PropertyValues/
CURRENT_ROLE_AUTH_NAMES/" isNull="false" isNoAccess="false" value="">
<PropertyValueElements totalCount="1">
<PropertyValueElement isNull="false" isNoAccess="false" value="Server.*" />
</PropertyValueElements>
</PropertyValue>
...
OMITTED
...
</PropertyValues>
<Assets totalCount="16">
<Asset name="SystemInfo" type="SystemInfo" description="" version="801010" uri="/id/
SystemObject/Server/0d3a0f31-7185-4594-b326-26f3ecf463a5/Assets/SystemInfo/801010"
modelType="GENERIC_OBJECT" modelTypeId="6030">
<AssetAttributeValues totalCount="2">
<AssetAttributeValue name="Path" type="String" value="SystemInfo"
uri="/id/SystemObject/Server/0d3a0f31-7185-4594-b326-26f3ecf463a5/Assets/SystemInfo/
801010/AssetAttributeValues/Path" />
<AssetAttributeValue name="Name" type="String" value="SystemInfo"
uri="/id/SystemObject/Server/0d3a0f31-7185-4594-b326-26f3ecf463a5/Assets/
SystemInfo/801010/AssetAttributeValues/Name" />
</AssetAttributeValues>
</Asset>
...
OMITTED
...
</Assets>
</PropertySetInstanceChildren>
</PropertySetInstanceChildrenResponse>
</RESTXMLResponse>
Get the children of /group
The returned PropertyValue elements can be of various types: primitives, enums, lists, objects, and so on. For information about how to interpret each type, see for primitives and more complex objects.
Request URI: /group/
XML response
<RESTXMLResponse>
<GroupChildrenResponse>
<GroupChildren>
<Groups totalCount="6">
<Group name="Depot" description="" type="/type/PropertySetClasses/SystemObject/Static Group
/Abstract Depot Group/Depot Group" dbKey="DBKey:SBLGroupModelKeyImpl:1000002-12002"
objectId="cd4ff64d-6996-446c-90c6-2f99d3091db6" uri="/id/SystemObject/Static Group/Abstract
Depot Group/Depot Group/cd4ff64d-6996-446c-90c6-2f99d3091db6" modelType="DEPOT_GROUP"
modelTypeId="5001" groupId="1000002">
<PropertyValues totalCount="15">
<PropertyValue name="DATE_MODIFIED" isList="false" type="Date" uri="/id/SystemObject/
Static Group/Abstract Depot Group/Depot Group/cd4ff64d-6996-446c-90c6-2f99d3091db6/
PropertyValues/DATE_MODIFIED" isNull="false" isNoAccess="false" value="2011/04/26
10:36:26-0400" />
<PropertyValue name="GROUP*" isList="false" type="/type/PropertySetClasses/SystemObject/
Static Group" uri="/id/SystemObject/Static Group/Abstract Depot Group/Depot
Group/cd4ff64d-6996-446c-90c6-2f99d3091db6/PropertyValues/GROUP*" isNull="false"
isNoAccess="false" value="" />
<PropertyValue name="NAME" isList="false" type="String" uri="/id/SystemObject/
Static Group/Abstract Depot Group/Depot Group/cd4ff64d-6996-446c-90c6-2f99d3091db6/
PropertyValues/NAME" isNull="false" isNoAccess="false" value="Depot" />
<PropertyValue name="DESCRIPTION" isList="false" type="String" uri="/id/SystemObject/
Static Group/Abstract Depot Group/Depot Group/cd4ff64d-6996-446c-90c6-2f99d3091db6/
PropertyValues/DESCRIPTION" isNull="true" isNoAccess="false" value="" />
<PropertyValue name="IS_USED_IN_REPORTS*" isList="false" type="Boolean"
uri="/id/SystemObject/Static Group/Abstract Depot Group/Depot
Group/cd4ff64d-6996-446c-90c6-2f99d3091db6/PropertyValues/IS_USED_IN_REPORTS*"
isNull="false" isNoAccess="false" value="true" />
...
OMITTED
...
<Group name="Jobs" description="" type="/type/PropertySetClasses/SystemObject/Static Group/
Job Group" dbKey="DBKey:SBLGroupModelKeyImpl:1000003-12003"
objectId="8df86ecb-27da-432b-b22c-c86c0f9891f7" uri="/id/SystemObject/Static Group/
Job Group/8df86ecb-27da-432b-b22c-c86c0f9891f7" modelType="JOB_GROUP" modelTypeId="5005"
groupId="1000003">
...
OMITTED
...
<Group name="Servers" description="" type="/type/PropertySetClasses/SystemObject/Static Group/
Static Server Group" dbKey="DBKey:SBLGroupModelKeyImpl:1000001-12001"
objectId="c205a533-2b63-40fc-bbfb-505996402c1a" uri="/id/SystemObject/Static Group/
Static Server Group/c205a533-2b63-40fc-bbfb-505996402c1a" modelType="STATIC_SERVER_GROUP"
modelTypeId="5003" groupId="1000001">
...
OMITTED
...
</Groups>
</GroupChildren>
</GroupChildrenResponse>
</RESTXMLResponse>
Get the children of a group (group prefix)
XML response
<RESTXMLResponse>
<GroupChildrenResponse>
<GroupChildren>
<Groups totalCount="13">
<Group name="MyServers" description="" type="/type/PropertySetClasses/SystemObject/Static Group/
Static Server Group" dbKey="DBKey:SBLGroupModelKeyImpl:2000000-2005800"
objectId="39f380ad-b439-4e6c-ac39-2be2d03ab59d" uri="/id/SystemObject/Static Group/
Static Server Group/39f380ad-b439-4e6c-ac39-2be2d03ab59d" modelType="STATIC_SERVER_GROUP"
modelTypeId="5003" groupId="2000000" />
...
OMITTED
...
</Groups>
<PropertyValues totalCount="12">
<PropertyValue name="BROKEN_OBJECT" isList="false" type="Boolean"
uri="/id/SystemObject/
Static Group/Static Server Group/c205a533-2b63-40fc-bbfb-505996402c1a/
PropertyValues/BROKEN_OBJECT" isNull="true" isNoAccess="false" value="" />
<PropertyValue name="ROLE_MODIFIED" isList="false" type="String"
uri="/id/SystemObject/Static Group/Static Server
Group/c205a533-2b63-40fc-bbfb-505996402c1a/PropertyValues/
ROLE_MODIFIED" isNull="false" isNoAccess="false" value="RBACAdmins" />
<PropertyValue name="AUTO_GENERATED" isList="false" type="Boolean"
uri="/id/SystemObject/Static Group/Static Server Group/
c205a533-2b63-40fc-bbfb-505996402c1a/PropertyValues/AUTO_GENERATED"
isNull="true" isNoAccess="false" value="" />
...
OMITTED
...
</PropertyValues>
</GroupChildren>
</GroupChildrenResponse>
</RESTXMLResponse>
Get the value of a specific property on a specific object (group prefix)
To do this, you specify:
- The full path to the object
- The keyword: PropertyValues
- The name of the property whose value you want
This example displays the value of the ROLE_MODIFIED property on the localhost server in the /Servers/MyServers/group.
Request URI: /group/Servers/MyServers/localhost/PropertyValues/ROLE_MODIFIED
XML response
<?xml version="1.0" encoding="UTF-8" ?>
<RESTXMLResponse>
<PropertyValueResponse>
<PropertyValue name="ROLE_MODIFIED" isList="false"
type="String" uri="/id/SystemObject/Server/
0d3a0f31-7185-4594-b326-26f3ecf463a5/
PropertyValues/ROLE_MODIFIED" isNull="false"
isNoAccess="false" value="BLAdmins" />
</PropertyValueResponse>
</RESTXMLResponse>
</RESTXMLResponse>
</RESTXMLResponse>