This endpoint is designed to be accessed from any tool that can issue HTTP requests.
Several formats are supported including a DataListLoadReply xml document, xml with row and column elements (r,c), .Net DataSet, or comma separated values (csv). If the list fetches sucessfully then a 200 will be returned with the data in the format specified via the format parameter.
| Parameter | Usage | Type | Description |
|---|---|---|---|
| DatabaseName | Required | String | The name of the database to use for this request. The list of available databases is defined in web.config and can be retrieved here. |
| format | Optional | String | One of the following: reply, reply_resultsasxml, xml, xml_with_fieldids, dataset, csv. If not specified then reply is assumed.
reply: DataListLoadReply xml document reply_resultsasxml: DataListLoadReply xml document with the XmlResults element instead of the Rows element. xml: xml document with each row in an element r and each column in an element c. xml_with_fieldids: xml document with each row in an element r and each column in an element c. The c element will have an attribute for the FieldID of the column. dataset: .Net dataset. If IncludeMetaData=True then the schema will have extendend properties with the metadata. csv: comma separated values text. |
| DataListID | Required | GUID | The catalog ID of the datalist |
| ContextRecordID | Optional | String (usually a GUID) | Only used if the datalist requires a context record id. |
| MaxRows | Optional | Integer | Used to cap the number of rows returned. |
| IncludeMetaData | Optional | Boolean | Defaults to False. If True then metadata for the datalist will be returned along with the result rows. |
| {Field ID for one of the datalist filters} | Optional | depends on the Field | If the datalist supports filters then the value for any of the filters can be passed on the query string by using the FIELDID of the filter form field as the query parameter and the filter value as the query value. |