api:push

Version 25.3.9411

Parameters
Control Attributes
Example

api:push

Use the api:push keyword to push an item into the output feed of the script. If there are no api:push elements in your script, no output items result from it.

Parameters

item: The item to push into the feed. If not present, the item at the top of the stack is pushed.
title: The title for the feed item.
desc[ription]: The description for the feed item. If none is provided, the scope of api:push is used. The scope of api:push can contain other keywords, HTML tags, and so on. Everything is evaluated as a template and used to set the description.
op: The name of the operation to call and then push the resulting items. For example:
```
  <api:push op="myOp"/>    
```
This is shorthand for the following:
```
  <api:call op="myOp">
    <api:push/>
  </api:call>
```
enc[oding]: The encoding of the description. By default, the application pushes the description as escaped XML. Set this parameter to cdata to encode the description as CDATA, which includes unescaped XML.

Control Attributes

None

Example

Create a description for each item pushed out. The description is the text in the scope of the api:push keyword, as shown below:

<api:call op="fileListDir?mask=*.log">
  <api:push>
    The .log file contains details about the transmission, including any error messages.
  </api:push>
</api:call>