get_top_level_item_class_m Sample Call and Response
This example retrieves all of the parent inventory item classes defined for a client, based on the get_top_level_item_class_m method defined in plsql_m_r73.yml.
This example includes every field the method accepts, since this method takes no arguments beyond the standard client and authentication credentials.
Sample call
{
"rest_call": "get_top_level_item_class_m",
"output_format": "json",
"client_no": 1275,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
The rest_call and output_format fields form the envelope that the REST layer adds to every call; they are not part of the method's own documented arguments. Beyond client_no and auth_key, the method defines no additional input fields, so this call has nothing further to configure.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"top_item_class": [
{
"class_no": 8801,
"class_label": "Hardware",
"class_description": "Top-level class for all physical hardware inventory items.",
"display_ind": 1
},
{
"class_no": 8802,
"class_label": "Software Licenses",
"class_description": "Top-level class for all licensed software inventory items.",
"display_ind": 1
},
{
"class_no": 8803,
"class_label": "Professional Services",
"class_description": "Top-level class for billable professional services.",
"display_ind": 0
}
]
}
An error_code of zero, together with an error_msg of "OK," indicates that Aria returned the client's parent inventory item classes successfully. The top_item_class array is shown here with three entries to illustrate that a client typically defines more than one top-level class; an actual response could contain additional entries beyond what is shown here. The display_ind field indicates whether Aria marks a given class as displayable; this example shows one class, Professional Services, with a display_ind of zero to illustrate a class that is not marked displayable, alongside two classes that are.