Operations

Last modified: February 22, 2024

1 Introduction

This document provides the methods of which the web service 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 automatically fill. These can be changed as needed.

An operation has the properties described below.

2 General

2.1 Name

This is what the operation is called in the WSDL.

2.2 Microflow

Defines which microflow will be executed when this web service is called.

2.3 Documentation

Describes the operation and is included in the WSDL.

3 Parameters

3.1 Microflow Parameter

Defines the name of the parameter in the microflow.

3.2 Type

Defines which type the parameter is (for example, a List of Vehicles entity).

3.3 Optional

Defines if this parameter is optional in the web service call.

3.4 Nillable

Defines if this parameter can have a nil value in the web service call.

3.5 Operation Parameter

Defines the name of the parameter in the web service call. This is initially copied from the microflow parameter name, but it can be modified.

3.6 Operation Object Name

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

The microflow attached to the CountCarsAndHp operation. It takes a list of objects of the entity Vehicle as input and returns an object that holds the number of cars and the total amount of horsepower of those cars.

3.7 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 difficult.

Collapse all Collapses the entire tree, so that only the root node remains visible.
Check all Checks the box next to every expanded node and visible leaf node. Collapsed nodes and their children are not affected.
Uncheck all Unchecks the box next to every expanded node and visible leaf node. Collapsed nodes and their children are not affected.
All optional Checks the Optional box on every expanded node and visible leaf node.
All non-optional Unchecks the Optional box on every expanded node and visible leaf node.
All nillable Checks the Nillable box on every expanded node and visible leaf node.
All non-nillable Unchecks the Nillable box on every expanded node and visible leaf node.

Here you can select which members of the entity can be passed and/or are optional or nillable, as well as set their names. Note that checking Optional or Nillable on the root element has no effect; set these values in the operation editor.

4 Return Type

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

4.1 Type

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

4.2 Name

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

4.3 Optional

This determines if the element in the XML can be left out if the return value is empty.

4.4 Nillable

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

Optional and Nillable cannot both be checked.

Here, you can see an optional Order entity set as the return type of the operation ReturnsOrder.