itop.wsdl.tpl 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268
  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <!-- WSDL file generated manually -->
  3. <definitions name="ITop" targetNamespace="urn:ITop" xmlns:typens="urn:ITop" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns="http://schemas.xmlsoap.org/wsdl/">
  4. <types>
  5. <xsd:schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="urn:ITop">
  6. <!-- Added the following import tag to pass the Eclipse validation -->
  7. <xsd:import namespace="http://schemas.xmlsoap.org/soap/encoding/" />
  8. <xsd:complexType name="SearchCondition">
  9. <!--wsdl:documentation>
  10. A criteria to restrict a search (strict search is performed)
  11. Example: name = 'myserver.combodo.fr'
  12. </wsdl:documentation -->
  13. <xsd:all>
  14. <xsd:element name="attcode" type="xsd:string"/>
  15. <xsd:element name="value" type="xsd:string"/> <!-- should be anyType but this one is not well supported by Eclipse -->
  16. </xsd:all>
  17. </xsd:complexType>
  18. <xsd:complexType name="ArrayOfSearchCondition">
  19. <xsd:complexContent mixed="false">
  20. <xsd:restriction base="soapenc:Array">
  21. <xsd:attribute ref="soapenc:arrayType" wsdl:arrayType="typens:SearchCondition[]"/>
  22. </xsd:restriction>
  23. </xsd:complexContent>
  24. </xsd:complexType>
  25. <xsd:complexType name="ExternalKeySearch">
  26. <!-- wsdl:documentation>
  27. Specifies [how to find] a value for an external key.
  28. the class of object to search for will depend on the usage that is being made, therefore the search conditions that may be used will vary depending on the parameter that is concerned.
  29. If one criteria is not relevant, then the match will not be attempted and warning will be logged (or an error if the target external key is mandatory)
  30. Example: match on customer = 'Demo' and type = 'Router'
  31. </wsdl:documentation -->
  32. <xsd:all>
  33. <xsd:element name="conditions" type="typens:ArrayOfSearchCondition"/>
  34. </xsd:all>
  35. </xsd:complexType>
  36. <xsd:complexType name="AttributeValue">
  37. <!-- wsdl:documentation>
  38. Specifies a value to set
  39. </wsdl:documentation -->
  40. <xsd:all>
  41. <xsd:element name="attcode" type="xsd:string"/>
  42. <xsd:element name="value" type="xsd:string"/> <!-- should be anyType but this one is not well supported by Eclipse -->
  43. </xsd:all>
  44. </xsd:complexType>
  45. <xsd:complexType name="ArrayOfAttributeValue">
  46. <xsd:complexContent mixed="false">
  47. <xsd:restriction base="soapenc:Array">
  48. <xsd:attribute ref="soapenc:arrayType" wsdl:arrayType="typens:AttributeValue[]"/>
  49. </xsd:restriction>
  50. </xsd:complexContent>
  51. </xsd:complexType>
  52. <xsd:complexType name="LinkCreationSpec">
  53. <!-- wsdl:documentation>
  54. Specifies [how to match] one item to attach and what values should be set on the newly created link.
  55. </wsdl:documentation -->
  56. <xsd:all>
  57. <xsd:element name="class" type="xsd:string"/>
  58. <xsd:element name="conditions" type="typens:ArrayOfSearchCondition"/>
  59. <xsd:element name="attributes" type="typens:ArrayOfAttributeValue"/>
  60. </xsd:all>
  61. </xsd:complexType>
  62. <xsd:complexType name="ArrayOfLinkCreationSpec">
  63. <xsd:complexContent mixed="false">
  64. <xsd:restriction base="soapenc:Array">
  65. <xsd:attribute ref="soapenc:arrayType" wsdl:arrayType="typens:LinkCreationSpec[]"/>
  66. </xsd:restriction>
  67. </xsd:complexContent>
  68. </xsd:complexType>
  69. <xsd:complexType name="LogMessage">
  70. <!-- wsdl:documentation>
  71. An event that happened during the execution of the web service
  72. </wsdl:documentation -->
  73. <xsd:all>
  74. <xsd:element name="text" type="xsd:string"/>
  75. </xsd:all>
  76. </xsd:complexType>
  77. <xsd:complexType name="ArrayOfLogMessage">
  78. <xsd:complexContent mixed="false">
  79. <xsd:restriction base="soapenc:Array">
  80. <xsd:attribute ref="soapenc:arrayType" wsdl:arrayType="typens:LogMessage[]"/>
  81. </xsd:restriction>
  82. </xsd:complexContent>
  83. </xsd:complexType>
  84. <xsd:complexType name="ResultLog">
  85. <!-- wsdl:documentation>
  86. A Log of events of the same category
  87. </wsdl:documentation -->
  88. <xsd:all>
  89. <xsd:element name="messages" type="typens:ArrayOfLogMessage"/>
  90. </xsd:all>
  91. </xsd:complexType>
  92. <xsd:complexType name="ResultData">
  93. <xsd:all>
  94. <xsd:element name="key" type="xsd:string"/>
  95. <xsd:element name="value" type="xsd:string"/> <!-- should be anyType but this one is not well supported by Eclipse -->
  96. </xsd:all>
  97. </xsd:complexType>
  98. <xsd:complexType name="ArrayOfResultData">
  99. <xsd:complexContent mixed="false">
  100. <xsd:restriction base="soapenc:Array">
  101. <xsd:attribute ref="soapenc:arrayType" wsdl:arrayType="typens:ResultData[]"/>
  102. </xsd:restriction>
  103. </xsd:complexContent>
  104. </xsd:complexType>
  105. <xsd:complexType name="ResultMessage">
  106. <!-- wsdl:documentation>
  107. Output expected, depending on the operation invoked.
  108. Example: CreateIncidentTicket will return 'created' => basic information on the created ticket
  109. </wsdl:documentation -->
  110. <xsd:all>
  111. <xsd:element name="label" type="xsd:string"/>
  112. <xsd:element name="values" type="typens:ArrayOfResultData"/>
  113. </xsd:all>
  114. </xsd:complexType>
  115. <xsd:complexType name="ArrayOfResultMessage">
  116. <xsd:complexContent mixed="false">
  117. <xsd:restriction base="soapenc:Array">
  118. <xsd:attribute ref="soapenc:arrayType" wsdl:arrayType="typens:ResultMessage[]"/>
  119. </xsd:restriction>
  120. </xsd:complexContent>
  121. </xsd:complexType>
  122. <xsd:complexType name="Result">
  123. <!-- wsdl:documentation>
  124. Standard result structure returned by all of the operations, excepted GetVersion (returning a string)
  125. result holds returned data if the status is set to true
  126. errors, warnings and infos will help in understanding what happened (unknown identifiers, object matching issues/results)
  127. This resulting structure is being tracked into the application log as well.
  128. </wsdl:documentation -->
  129. <xsd:all>
  130. <xsd:element name="status" type="xsd:boolean"/>
  131. <xsd:element name="result" type="typens:ArrayOfResultMessage"/>
  132. <xsd:element name="errors" type="typens:ResultLog"/>
  133. <xsd:element name="warnings" type="typens:ResultLog"/>
  134. <xsd:element name="infos" type="typens:ResultLog"/>
  135. </xsd:all>
  136. </xsd:complexType>
  137. </xsd:schema>
  138. </types>
  139. <message name="GetVersion">
  140. </message>
  141. <message name="GetVersionResponse">
  142. <part name="GetVersionReturn" type="xsd:string"/>
  143. </message>
  144. <message name="CreateRequestTicket">
  145. <part name="login" type="xsd:string"/>
  146. <part name="password" type="xsd:string"/>
  147. <part name="title" type="xsd:string"/>
  148. <part name="description" type="xsd:string"/>
  149. <part name="caller" type="typens:ExternalKeySearch"/>
  150. <part name="customer" type="typens:ExternalKeySearch"/>
  151. <part name="service" type="typens:ExternalKeySearch"/>
  152. <part name="service_subcategory" type="typens:ExternalKeySearch"/>
  153. <part name="product" type="xsd:string"/>
  154. <part name="workgroup" type="typens:ExternalKeySearch"/>
  155. <part name="impacted_cis" type="typens:ArrayOfLinkCreationSpec"/>
  156. <part name="impact" type="xsd:string"/>
  157. <part name="urgency" type="xsd:string"/>
  158. </message>
  159. <message name="CreateIncidentTicket">
  160. <part name="login" type="xsd:string"/>
  161. <part name="password" type="xsd:string"/>
  162. <part name="title" type="xsd:string"/>
  163. <part name="description" type="xsd:string"/>
  164. <part name="caller" type="typens:ExternalKeySearch"/>
  165. <part name="customer" type="typens:ExternalKeySearch"/>
  166. <part name="service" type="typens:ExternalKeySearch"/>
  167. <part name="service_subcategory" type="typens:ExternalKeySearch"/>
  168. <part name="product" type="xsd:string"/>
  169. <part name="workgroup" type="typens:ExternalKeySearch"/>
  170. <part name="impacted_cis" type="typens:ArrayOfLinkCreationSpec"/>
  171. <part name="impact" type="xsd:string"/>
  172. <part name="urgency" type="xsd:string"/>
  173. </message>
  174. <message name="CreateIncidentTicketResponse">
  175. <part name="CreateIncidentTicketReturn" type="typens:Result"/>
  176. </message>
  177. <message name="CreateRequestTicketResponse">
  178. <part name="CreateRequestTicketReturn" type="typens:Result"/>
  179. </message>
  180. <message name="SearchObjects">
  181. <part name="login" type="xsd:string"/>
  182. <part name="password" type="xsd:string"/>
  183. <part name="oql" type="xsd:string"/>
  184. </message>
  185. <message name="SearchObjectsResponse">
  186. <part name="SearchObjectsReturn" type="typens:Result"/>
  187. </message>
  188. <portType name="WebServicePortType">
  189. <operation name="GetVersion">
  190. <!-- wsdl:documentation>
  191. Get the current version of Itop
  192. As this service is very simple, it is a test to get trained for more complex operations
  193. </wsdl:documentation --> -->
  194. <input message="typens:GetVersion"/>
  195. <output message="typens:GetVersionResponse"/>
  196. </operation>
  197. <operation name="CreateRequestTicket">
  198. <!-- wsdl:documentation>
  199. Create a ticket, return information about reconciliation on external keys and the created ticket
  200. </wsdl:documentation -->
  201. <input message="typens:CreateRequestTicket"/>
  202. <output message="typens:CreateRequestTicketResponse"/>
  203. </operation>
  204. <operation name="CreateIncidentTicket">
  205. <!-- wsdl:documentation>
  206. Create a ticket, return information about reconciliation on external keys and the created ticket
  207. </wsdl:documentation -->
  208. <input message="typens:CreateIncidentTicket"/>
  209. <output message="typens:CreateIncidentTicketResponse"/>
  210. </operation>
  211. <operation name="SearchObjects">
  212. <!-- wsdl:documentation>
  213. Create a ticket, return information about reconciliation on external keys and the created ticket
  214. </wsdl:documentation -->
  215. <input message="typens:SearchObjects"/>
  216. <output message="typens:SearchObjectsResponse"/>
  217. </operation>
  218. </portType>
  219. <binding name="WebServiceBinding" type="typens:WebServicePortType">
  220. <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
  221. <operation name="GetVersion">
  222. <soap:operation soapAction="urn:WebServiceAction"/>
  223. <input>
  224. <soap:body namespace="urn:ITop" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
  225. </input>
  226. <output>
  227. <soap:body namespace="urn:ITop" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
  228. </output>
  229. </operation>
  230. <operation name="CreateRequestTicket">
  231. <soap:operation soapAction="urn:WebServiceAction"/>
  232. <input>
  233. <soap:body namespace="urn:ITop" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
  234. </input>
  235. <output>
  236. <soap:body namespace="urn:ITop" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
  237. </output>
  238. </operation>
  239. <operation name="CreateIncidentTicket">
  240. <soap:operation soapAction="urn:WebServiceAction"/>
  241. <input>
  242. <soap:body namespace="urn:ITop" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
  243. </input>
  244. <output>
  245. <soap:body namespace="urn:ITop" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
  246. </output>
  247. </operation>
  248. <operation name="SearchObjects">
  249. <soap:operation soapAction="urn:WebServiceAction"/>
  250. <input>
  251. <soap:body namespace="urn:ITop" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
  252. </input>
  253. <output>
  254. <soap:body namespace="urn:ITop" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
  255. </output>
  256. </operation>
  257. </binding>
  258. <service name="ITopService">
  259. <!-- wsdl:documentation>
  260. ITop is the central solution for managing your IT infrastructure
  261. </wsdl:documentation -->
  262. <port name="WebServicePort" binding="typens:WebServiceBinding">
  263. <soap:address location="___SOAP_SERVER_URI___"/>
  264. </port>
  265. </service>
  266. </definitions>