Help:Processing:External Calls

From Opadeez Wiki
Jump to navigationJump to search

External calls are used to perform a WebService / API call to an external system.

External Calls

Call Name Name of the External Call. Name shall be unique.
End point URL used to access to the external WebService / API
Call Type Protocol used to call the external service:
  • SOAP Web Service
  • REST Web Service
  • Other
SOAP Action SOAP Action HTTP header (used for SOAP web service only)
Storage Entity Entity that will store the request/response for this API call. This entity should be created using the Entities creation wizard
Entities creation wizard This wizard creates the necessary entities and links matching the data model of the API request/response. The Input and Output blocks should be created before calling this wizard.
Template request Request template used to generate an API call. This template should be created by using the Import from sample wizard in the Input blocks section.

Input blocks

This section describes the details used to generate the request to call the API. The easiest way to generate the blocks and fields correctly is to use the Import from sample wizard.

Import from sample This wizard request for a sample request and automatically extract the blocks and fields from the sample structure.
Block name A descriptive name for this block
Full name The complete block name as defined in the request structure (e.g. workspace:xml_field_name...)
Line from/to Line in the Template request where this block starts/ends.
Storage entity Entity used to store the content of the block at runtime. This entity should be created using the Entities creation wizard
Field name A descriptive name for this field
Full name The complete field name as defined in the request structure (e.g. workspace:xml_field_name...)
Type The data type for this field
Length The field length
Line number The line number in the template request where this field is defined

Output blocks

Import from sample This wizard request for a sample response and automatically extract the blocks and fields from the sample structure.
Block name Name of a block. This name should match the name of the block in the structure (e.g. the XML tag name...)
Full path The path used to access the field value (e.g. XPath for XML...)
Storage entity Entity used to store the content of the block at runtime. This entity should be created using the Entities creation wizard
Field name A descriptive name for this field
Full name The complete field name as defined in the response structure (e.g. workspace:xml_field_name...)
Type The data type for this field
Length The field length

See also