Description:
Returns a list of available documents for a site.
Search parameters:
One or more of the following search parameters need to be specified in order to retrieve data:
| siteId |
Yes |
The id of the site to get a document list for
|
Additional parameters:
The following, optional, parameters may be specified:
| format |
The desired return format. Valid formats are: {json, jsonp, text, csv, xls, ods, and tab}. The default is json. |
| callback |
The JSONP callback function name (Note that format needs to be "jsonp"). |
| fields |
The comma-separated-list of the field names to return from the query. The default is to return all available fields. |
| nullValue |
Value to substitute in place of null values. The default is to return null values as "null" (per JSON.org). |
Result Set Definitions:
| active |
Indicates if the the activity is active or not. |
| activityId |
The commonly used ID for the activity. |
| activityName |
The name of the activity. |
| activitySubtypeName |
The subtype of activity. |
| activitySystemId |
The system id for the activity. |
| activityTypeName |
The type of activity. |
| documentDate |
The date of the document. |
| documentFileSize |
The estimated size of the document. |
| documentId |
The onbase document id. |
| documentMimeType |
The MIME type for the document. |
| documentName |
The long onbase document name. |
| documentTitle |
The title of the document. |
| documentType |
The type of document. |
| programName |
The name of the MPCA program associated with the activity. |
| siteId |
The id of the site to get a document list for |
Example Queries: