Generating a WSDL representation

You can generate a WSDL representation of request and response elements, and their documentation.

About this task

To write the SOAP payload for the request to a specific ruleset endpoint URI, you must generate the WSDL representation. The WSDL representation contains the description of the SOAP request and SOAP response, as well as the endpoint of the web service. A set of XSD files are attached to the WSDL file to describe the XML representation of the input and output objects.

To generate a WSDL representation, you can use the format of SOAP resource URIs. The WSDL format is described in the Web Services Description Language External link opens a new window or tab page of the W3C website.

Procedure

  1. Define the request: 
    https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/ws/{rulesetPath}/wsdl

    The URI variables are defined in Endpoint URIs.

    Example:
    GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/ws/miniloanruleapp/1.0/miniloanrules/1.0/wsdl
  2. Optional: To generate the WSDL code and its XSD files to a compressed file, add the zip parameter.

    Use the zip parameter if you want to download the WSDL as a ZIP archive in which the XSD files are saved separately from the WSDL file. This option is useful if you import more than one decision from Decision Server into an IBM® Integration Designer project, or if you migrate a ruleflow to a process. The separation of the object types from the WSDL avoids the duplication of these objects in IBM Integration Designer.

    Example:
    GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/ws/miniloanruleapp/1.0/miniloanrules/1.0/wsdl?zip=true

Results

If you try to generate WSDL representation for an invalid URL or if an error occurs during the WSDL generation, an error status code is returned.
  • If you sent the request from a browser, an HTML page displays the error message.
    Note: The status code is 200 despite the error message because it applies to the HTML page, not to the request result.
  • If you sent the request from a client other than a browser, status code 404 (Not Found) is returned and the error is described in XML.
You can find a description of error messages in HTTP status codes.