Description

Generates a syndication feed, converting one or more objects to XML and returning it (GET/POST)

Parameters

Ids comma-separated object version identifiers: database id + 'v' + the version creation date-time (assumed to be UTC). If the 'v' + date-time is omitted indicates the current version.

Objects or object old versions to export in the feed

PubDest string

Path of the publishing destination to export in the feed (if there are no explicit object ids) and providing the default export options and preview URL

Name string

Name of the XML export configuration to use to convert the feed object(s) to the feed XML representation. Optional, if not specified the command will use the export options of the publishing destionation (if any).

Pars list of name-value pairs in the format 'name1:value1;name2:value2...'; e.g. 'folderId:30;cmd:up' to define a 'folderId' parameter with value 30 and a 'cmd' parameter with value 'up'.

Additional optional parameters passed to the feed XSL transformation 'as is'

Post

If specified the feed output is POSTed to the Web page specified by the 'FN' option or the preview URL of the specified publishing destination.

FN string

When not using the 'Post' option it is the file name to associate to the feed content. If specified the browser will offer to download and save the feed content instead than displaying it. When using the 'Post' option it is the URL of the Web page that receives the feed data in a POST call.

ZFN string

Optional file name to associate to the returned zip data

Max integer

Maximum navigation depth. Optional, if present it overrides the MaxDepth value specified in the XML export configuration. Use 0 to return the simple XML of the object(s), -1 for unlimited depth (dangerous)

Size integer

Maximum size in bytes of the binary data content that is returned directly in the XML. Optional, if present it overrides the DataMaxSize value specified in the XML export configuration.

X string

Name of an XSL transformation to be applied to the XML (note that it is just inserted as an XML instruction and applied by the browser). Optional, if present it overrides the XsltPIHref value specified in the XML export configuration.

Strict boolean: '1' or 'true' for true or '0' or 'false' for false

Requests strict access: fail if any of the requested attributes is not accessible. Optional, if present it overrides the AccessStrict value specified in the XML export configuration.

Nulls boolean: '1' or 'true' for true or '0' or 'false' for false

Render missing (null) object attributes as xsi:nil XML elements or empty XML attributes instead than just omitting them. Optional, if present it overrides the OutputNulls value specified in the XML export configuration.

Counter string

Optional name of the counter to increment for each returned object

Encoding character encoding (e.g. utf-8, iso-8859-1)

The character encoding to use for the returned XML. Optional, if present it overrides the Encoding value specified in the XML export configuration.

Options data navigator options

Options controlling which extra information to include (or exclude) from the XML output. Optional, if present it overrides the NavOptions value specified in the XML export configuration.

RefKeys boolean: '1' or 'true' for true or '0' or 'false' for false

Request references to other objects to contain also the referenced object key attribute(s) values instead than just the database id. Optional, if present it overrides the RefKeys value specified in the XML export configuration.

Spiked spiked objects handling value

How to handle spiked objects: load only non-spiked objects, load both spiked and unspiked objects, load only spiked objects.