Google Search Appliance Administrative API Developers Guide: Java - Manual (Page 25)

Google Search Appliance: Administrative API Developer’s Guide: Java 25
Listing Documents
Query parameters:
List documents by sending an authenticated GET request to the root entry of the diagnostics feed.
A description entry, a set of document status entries and a set of directory status entries are
returned.
Description entry properties:
26 Unhandled content type
27 No filter for this content type
34 robots.txt forbidden
Value Description
collectionName Name of a collection that you want to list. The default value is the last used
collection.
flatList Indicates: false: (Default) List the files and directories specified by the URL.
true: List all files specified by a URL as a flat list.
negativeState Indicates: false: (Default) Return documents with a status equal to view values
(1-2).
true: (Default) Return documents with a status equal to view values (3-50).
pageNum The page you want to view. The files from a URL may be separated into several
pages to return. Page numbers start from 1. The default value is 1.
sort The key field on which to sort:
• "": The default value.
• crawled: Sort by the number or crawled documents.
• errors: Sort by the number of errors.
• excluded: Sort by the number of excluded documents.
• file: sort by file name.
• host: Sort by host name.
uriAt The prefix of URL of a document that you want to list. If not blank, it must
contain at least http://hostname.domain.com/. The default value is "".
view The filter of document status. The values of view are described in “Document
Status Values” on page 23. The default value is all.
Property Description
Entry Name description
numPages The total number of pages to return.
uriAt URL prefix taken from the query parameters.
Excluded Description