Operations

4 minutes to read Download PDF Edit

Provides the actual methods of which the webservice is composed.

Looking at an operation in more detail, you can see that a microflow can be selected. When you select a microflow, the other fields will be automatically filled These can be changed as needed.

An operation has the following properties:

General

Name

This is what the operation is called in the WSDL.

Microflow

Defines which microflow will be executed when this webservice is called.

Documentation

Describes the operation and is included in the WSDL.

Parameters

Microflow parameter

Defines the name of the parameter in the microflow

Type

Defines which type the parameter is, for example a List of Vehicle entities.

Optional

Defines whether this parameter is optional in the webservice call.

Nillable

Defines whether this parameter can have a nil value in the webservice call.

Operation parameter

Defines the name of the parameter in the webservice call. This is initially copied from the microflow parameter name but can be modified.

Operation object name

Is available when the parameter is a list, and can be used to name the object in the list.

Exposed attributes and associations

If you click ‘Select…’ in the parameter tab, you can select individual members of the entity that is being passed as a parameter. The toolbar buttons are available to help you quickly perform operations that would otherwise be laborious.

Collapse allCollapses the entire tree, so that only the root node remains visible
Check allChecks the box next to every expanded node and visible leaf node. Collapsed nodes and their children are not affected.
Uncheck allUnchecks the box next to every expanded node and visible leaf node. Collapsed nodes and their children are not affected.
All optionalChecks the Optional box on every expanded node and visible leaf node.
All non-optionalUnchecks the Optional box on every expanded node and visible leaf node.
All nillableChecks the Nillable box on every expanded node and visible leaf node.
All non-nillableUnchecks the Nillable box on every expanded node and visible leaf node.

Return Type

This section pertains to the return type of the microflow and how it is transformed back to XML.

Type

Defines what kind of object will be returned by the microflow. If the returned type is a complex type (i.e. something from your entity model) you can use the Members button to select which members will be returned in the same way as parameters.

Name

The name of the return type. This determines the output element name in the XML that results from a webservice call.

Optional

This determines if the element in the XML can be left out if the return value is empty. In Mendix versions 5.9 and before, all return elements were optional.

Nillable

This determines if the element in the XML is sent as nil if the return value is empty.

Optional and Nillable cannot be checked both.