GlpigetObject » History » Version 10

walid, 07/04/2011 01:30 PM

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