Integration Guides › Web Service API Reference Guide › Valid Web API Objects › obj Object

obj Object

Use this object to get list and info for API objects.

list Method (obj Object)

Description

Retrieve list of objects

Syntax

/api/v2/obj/list 

Arguments

None

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve list of objects

GET http://192.168.123.200/api/v2/obj/list 

Sample Output

XML:

<objects>
   <object>
      <name>app</name>
   </object>
   <object>
      <name>cat</name>
   </object>
   <object>
      <name>class</name>
   </object>
   <object>
      <name>comp</name>
   </object>
   .
   .
   .
<objects> 

JSON:

{
   "object" : [
   {
      "name" : "app"
   },
   {
      "name" : "cat"
   },
   {
      "name" : "class"
   },
   {
      "name" : "comp"
   },
   .
   .
   .
} 

info Method (obj Object)

Description

Retrieve information for an object

Syntax

/api/v2/obj/info?obj=object 

Arguments

obj

API object

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve information for obj=vdc

GET http://192.168.123.200/api/v2/obj/info?obj=vdc 

Sample Output

XML:

<methods>
   <method>
      <name>info</name>
   </method>
   <method>
      <name>info_verbose</name>
   </method>
   <method>
      <name>list</name>
   </method>>
</methods> 

JSON:

{
   "method" : [ 
      {
            "name" : "info"
       },
      {
            "name" : "info_verbose"
       ,
      {
            "name" : "list"
      } 
    ]
}