Axiell WebAPI home page > WebAPI > listpointerfiles

WebAPI Browser

listpointerfiles

Url request
Adlib.Data
jQuery

Listpointerfiles returns a list of metadata of saved searches (aka pointer files) from a database.

Syntax

command=listpointerfiles&<parameter>=<value>&...

database (String) database on which to perform the listpointerfiles function. The name of this database must have been specified in the adlibweb.xml file.
users (String) [optional] list of comma separated names of users who created the saved searches you are looking for. The wildcard * (may replace multiple characters) is allowed in any position in the name.
limit (Integer) [optional] maximum amount of saved searches to return.
startfrom (Integer) [optional] the sequential number of the first saved search to return in the result (default 1).
output (String) [optional] output format to be returned. Values for output can be either json or xml (xml is the default, so you don't need to specify that explicitly). However, the output format produced by jQuery applications is always JSON, so you don't need to specify the output type there either.
Read more about JSON output here.
callback (String) [optional] returns JSON output wrapped in brackets with your callback function name, for AJAX requests: <callback function name>( <JSON output> ); You don't need to specify output=json, because the output format is JSON by default.
fields (String) [optional, available from wwwopac.ashx version 3.6.279.0] specifies which metadata fields to return. You can list one or more fields, separated by comma's (no spaces). Available metadata fields are: title, selection, owner, hits, created, modified, frequency, subject, expires and prunemode; the number field will always be returned.
Without the fields argument, all fields are returned by default.

Description

The metadata returned per saved search comprises the assigned saved search number, and optionally its title, the selection statement (an advanced search language statement or manual selection statement), the owner (creator of the saved search), the number of hits (records referred to in the saved search), the date the saved search was modified, and possibly some SDI information if the saved search has been set up to be rerun (profiled) automatically on a regular basis.
For more information about saved searches and SDI, see the Axiell Collections online Help.

Examples

List the metadata of all saved searches from collect.inf show
Note that the syntax is different from search commands.
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&command=listpointerfiles
```
run example select text
List the metadata of the first 5 saved searches from collect.inf, made by Bert show
- no further description -
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&command=listpointerfiles&users=bert&limit=5
```
run example select text
List the metadata of the first 10 saved searches from collect.inf, and only retrieve the title, owner and number metadata fields show
- no further description -
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&command=listpointerfiles&limit=10&fields=title,owner
```
run example select text