Web Service Descriptors - EcoSys - Customization & Programming - Hexagon PPM

EcoSys Web Service API Usage Documentation

Language
English
Product
EcoSys
Search by Category
Customization & Programming
EcoSys Version
9.0

Web Service Descriptors include XSD, WADL, and WSDL definitions.

  • XSD defines the XML schema for REST responses.

  • WADL is a web application description language and describes only the REST XML access methods, not the JSON format options.

  • WSDL identifies the service endpoints, bindings, ports, operations, and objects used to access the SOAP interface.

REST XSD Descriptor

A link to an XSD file is available on the documentation page for each published API. The XSD file may be used to configure a calling client using the REST XML interface, to generate client code, or to validate responses. The XSD is generated dynamically to match the API's configuration.

The XSD defines both result elements and request elements. For example, for an object API called "SampleProject", the XSD defines: <SampleProjectResult> and <SampleProjectRequest>.

REST WADL Descriptor

A link to a WADL file is available on the documentation page for each published API.

SOAP WSDL Descriptor

The SOAP end point published for each API is described by the WSDL linked from the documentation page for each API. This is for APIs configured to use runtime parameters, a parameter object is defined as input.