returnDocument
This command is deprecated and doesn’t work with Task or Batch APIs.
The API functionality requires additional licenses. Please contact support@documill.com to enable the licenses.
Defines the output of a composing process initiated through the Dynamo API. The File specified with the value attribute is returned to the API caller and the current Step of the Flow ends, leaving any commands following returnDocument unevaluated. As this command ends the Step without specifying a next Step, it also finishes the current Segment. If this command or returnString is not present in the document, the API caller will receive no output from Dynamo. However, the composing process may still produce output by creating Salesforce records, for example.
As the Dynamo API only handles Flow-based templates, this command does nothing in Controller-based templates besides ending the current event handler.
Attributes
value | ||
|---|---|---|
Required | Value type | EL-evaluated |
No | File | Yes |
Defines the output of the composing process. The resolved File can be the composed document or any other File within the variable context. If not defined, the currently running template itself is set as the output, which in the case of Office templates is also the composed result. | ||