Documentation Center

list

Retrieve list of publications in one of multiple formats.

Description

Show list of publications. Requires "Use application" permission to see list of visible publications; with "Manage pubs" permission, user can see list of all publications, visible or not.

Parameters

action
list
value
The value of the configuration key used to locate publications.
show
If value = "all", show all publications; else just show visible publications. Requires "Manage pubs" permission.
format
The output format for the results. Either "html", "json" or "xml". Defaults to "html"
key
The name of the configuration key to use to locate publications.

Example URL

http://<host>:<port>/<context>/web/pub.xql?action=list&value=<value>&show=<value>&format=<value>&key=<value>

Successful Result

Publications list in the selected format.

Failed Result

Accessing this API feature requires the "Use application" permission, and the function will throw a permission exception if the permission is not available.