SOAP

Allows to perform SOAP calls on a SOAP API.

Json

Example

{
  "name": "protocol-soap-perform",
  "taskReferenceName": "soap",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "endpoint": "https://",
    "useAuthentication": true,
    "login": "",
    "password": "",
    "request": "file://assets/request.xml"
  }
}

Definition

Property	Type	Required	Description
			The name (or type) of the task
			The unique name of the task in your job. It is used to reference this task in the workflow.
			The functional description of this task in your job.
			The type of the task. It must be SUB_WORKFLOW.
			true: the job continues if there is an error on this task. false: the job fails.
			Input parameters of the task. See below

Inputs

Property	Description
endpoint	The endpoint.
useAuthentication	Does it need authentication? true | false.
login	Login
password	Password
request	A valid input. A file that defines all the requests. See the definition below.

Input request

Example

<Soap>
  <Soap-Call>
    <Request>
        <Soap-Message>
          <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
            <soap:Body xmlns:m="http://www.example.org/stock">
              <m:GetStockPrice>
                <m:StockName>IBM</m:StockName>
              </m:GetStockPrice>
            </soap:Body>
          </soap:Envelope>
        </Soap-Message>
        <Headers>
            <Header key="customHeader">value</Header>
        </Headers>
    </Request>    
    <Metadata>
      <ean>1234567890123</ean>
    </Metadata>  
  </Soap-Call>
</Soap>

Definition

You can do multiple calls with only one xml file.

XPath	Description	Occurs
Soap	Root of the document	1
./Soap-Call	For each call.	1..*
../Request	The request element	1
../Request/@path	The path containing path params.	0..1
../Request/Headers	The headers	0..1
.../Headers/Header	A header	1..*
.../Headers/Header@key	The name of the header	1
.../Soap-Message	The soap message	1
../Metadata	An element that can be used to store informations and retrieve them in the responses.	0..1

Outputs

Property	Type	Description
responses		An xml file containing the responses for each request.
allSuccess		YES | NO. YES: all calls had a success response. NO: at least one request had an error response.

Output responses

Example

<Soap>
  <Soap-Call>
    <Request>
        <Soap-Message>
          <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
            <soap:Body xmlns:m="http://www.example.org/stock">
              <m:GetStockPrice>
                <m:StockName>IBM</m:StockName>
              </m:GetStockPrice>
            </soap:Body>
          </soap:Envelope>
        </Soap-Message>
        <Headers>
            <Header key="customHeader">value</Header>
        </Headers>
    </Request>    
    <Metadata>
      <ean>1234567890123</ean>
    </Metadata>  
    <Response>
        <Status-Code>200</Status-Code>
        <Content>
          <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
            <soap:Body xmlns:m="http://www.example.org/stock">
              <m:GetStockPriceResponse>
                <m:Price>34.5</m:Price>
              </m:GetStockPriceResponse>
            </soap:Body>
          </soap:Envelope>
        </Content>
    </Response>
  </Soap-Call>
</Soap>

Definition

The response has the structure as the request with some elements added.

XPath	Description	Occurs
./Response	The response for each call.	1
../Status-Code	The status code of the response	1
../Content	The content of the response	1

Limits and additional notes

• 50 requests in a file.