GlpigetObject » History » Version 8

walid, 06/10/2011 11:46 AM

1 1 yeti
h1. [[En_devguide#Provided-Methods|Methods]] > glpi.getObject
2 2 yeti
3 8 walid
Since : WebServices 1.1.0
4 8 walid
5 2 yeti
!https://forge.indepnet.net/svn/webservices/authenticated.png! +@This method is only accessible by authenticated users@+
6 2 yeti
7 2 yeti
Retrieve information on a existing object if the authenticated user can view it.
8 2 yeti
9 2 yeti
*input* a hastable
10 2 yeti
11 3 yeti
* *help* option to get usage information *+OPTIONAL+*
12 3 yeti
* *itemtype* the object type *+MANDATORY+*
13 7 yeti
_itemtype can take one of the following_ https://forge.indepnet.net/embedded/glpi/annotated.html
14 3 yeti
* *id* the ID of object *+MANDATORY+*
15 4 yeti
* *show_label* option to show the lang label for each return field *+OPTIONAL+*
16 4 yeti
* *show_name* option to show the dropdown name value for each ID field *+OPTIONAL+*
17 4 yeti
18 4 yeti
+*Other input hastable options*+ 
19 4 yeti
20 4 yeti
The following options are available depending on the type that was defines in the "itemtype" option bellow.
21 4 yeti
22 4 yeti
* *with_infocom* option to show infocom informations in the output result
23 4 yeti
* *with_networkport* option to show network ports in the output result
24 5 yeti
* *with_phone* option to show connected phones in the output result (only for Computer type)
25 5 yeti
* *with_printer* option to show connected printers in the output result (only for Computer type)
26 5 yeti
* *with_monitor* option to show connected monitors in the output result (only for Computer type)
27 5 yeti
* *with_peripheral* option to show connected peripherals in the output result (only for Computer type)
28 5 yeti
* *with_document* option to show documents in the output result
29 5 yeti
* *with_ticket* option to show tickets in the output result (only for Ticket type)
30 5 yeti
* *with_tickettask* option to show ticket tasks in the output result (only for Ticket type)
31 5 yeti
* *with_ticketfollowup* option to show ticket followups in the output result (only for Ticket type)
32 5 yeti
* *with_ticketvalidation* option to show ticket validations informations in the output result (only for Ticket type)
33 5 yeti
* *with_reservation* option to show reservations available in the output result
34 5 yeti
* *with_software* option to show installed softwares in the output result (only for Computer type)
35 5 yeti
* *with_contract* option to show attached contracts in the output result
36 4 yeti
37 2 yeti
38 2 yeti
*Default Call* example
39 2 yeti
<pre>
40 2 yeti
$ php testxmlrpc.php --session=0ptega61kobcnhkv0vokbercv1 --method=glpi.getObject --itemtype=Computer --id=501
41 2 yeti
+ Calling 'glpi.getObject' on http://localhost/glpi/plugins/webservices/xmlrpc.php?session=0ptega61kobcnhkv0vokbercv1
42 2 yeti
+ Response: Array
43 2 yeti
(
44 2 yeti
    [name] => computers 0-1
45 2 yeti
    [id] => 501
46 2 yeti
    [locations_id] => 21
47 2 yeti
    [computertypes_id] => 1
48 2 yeti
    [computermodels_id] => 1
49 2 yeti
    [states_id] => 5
50 2 yeti
    [operatingsystems_id] => 1
51 2 yeti
    [operatingsystemversions_id] => 2
52 2 yeti
    [operatingsystemservicepacks_id] => 4
53 2 yeti
    [autoupdatesystems_id] => 3
54 2 yeti
    [os_license_number] => os sn 0
55 2 yeti
    [os_licenseid] => os id 0
56 2 yeti
    [serial] => m233a56mu6i
57 2 yeti
    [otherserial] => vqcfci7a8si
58 2 yeti
    [notepad] => note computer 0
59 2 yeti
    [contact] => contact 0
60 2 yeti
    [contact_num] => num 0
61 2 yeti
    [users_id] => 748
62 2 yeti
    [groups_id] => 3
63 2 yeti
    [date_mod] => 2011-01-26 10:39:52
64 2 yeti
    [networks_id] => 5
65 2 yeti
    [domains_id] => 3
66 2 yeti
    [manufacturers_id] => 1
67 2 yeti
    [users_id_tech] => 579
68 2 yeti
    [entities_id] => 1
69 2 yeti
    [is_ocs_import] => 0
70 2 yeti
)</pre>
71 6 yeti
72 6 yeti
*Same call with_infocom* example
73 6 yeti
<pre>
74 6 yeti
$ php testxmlrpc.php --session=0ptega61kobcnhkv0vokbercv1 --method=glpi.getObject --itemtype=Computer --id=501 --with_infocom
75 6 yeti
+ Calling 'glpi.getObject' on http://localhost//glpi_078_svn/plugins/webservices/xmlrpc.php?session=0ptega61kobcnhkv0vokbercv1
76 6 yeti
+ Response: Array
77 6 yeti
(
78 6 yeti
    [name] => computers 0-1
79 6 yeti
    [id] => 501
80 6 yeti
    [locations_id] => 21
81 6 yeti
    [computertypes_id] => 1
82 6 yeti
    [computermodels_id] => 1
83 6 yeti
    [states_id] => 5
84 6 yeti
    [operatingsystems_id] => 1
85 6 yeti
    [operatingsystemversions_id] => 2
86 6 yeti
    [operatingsystemservicepacks_id] => 4
87 6 yeti
    [autoupdatesystems_id] => 3
88 6 yeti
    [os_license_number] => os sn 0
89 6 yeti
    [os_licenseid] => os id 0
90 6 yeti
    [serial] => m233a56mu6i
91 6 yeti
    [otherserial] => vqcfci7a8si
92 6 yeti
    [notepad] => note computer 0
93 6 yeti
    [contact] => contact 0
94 6 yeti
    [contact_num] => num 0
95 6 yeti
    [users_id] => 748
96 6 yeti
    [groups_id] => 3
97 6 yeti
    [date_mod] => 2011-01-26 10:39:52
98 6 yeti
    [networks_id] => 5
99 6 yeti
    [domains_id] => 3
100 6 yeti
    [manufacturers_id] => 1
101 6 yeti
    [users_id_tech] => 579
102 6 yeti
    [entities_id] => 1
103 6 yeti
    [is_ocs_import] => 0
104 6 yeti
    [Infocom] => Array
105 6 yeti
        (
106 6 yeti
            [id] => 1126
107 6 yeti
            [buy_date] => 2006-07-16
108 6 yeti
            [use_date] => 2006-07-16
109 6 yeti
            [warranty_duration] => 36
110 6 yeti
            [warranty_info] => infowar comp 501
111 6 yeti
            [warranty_value] => 315.0000
112 6 yeti
            [suppliers_id] => 10
113 6 yeti
            [order_number] => commande comp 501
114 6 yeti
            [delivery_number] => BL comp 501
115 6 yeti
            [immo_number] => immo comp 501
116 6 yeti
            [value] => 3355.0000
117 6 yeti
            [sink_time] => 5
118 6 yeti
            [sink_type] => 1
119 6 yeti
            [comment] => comment comp 501
120 6 yeti
            [sink_coeff] => 5
121 6 yeti
            [bill] => facture comp 501
122 6 yeti
            [budgets_id] => 9
123 6 yeti
            [itemtype] => Computer
124 6 yeti
            [items_id] => 501
125 6 yeti
            [alert] => 0
126 6 yeti
            [entities_id] => 1
127 6 yeti
            [is_recursive] => 0
128 6 yeti
        )
129 6 yeti
130 6 yeti
)
131 6 yeti
</pre>