| GET | /Queries/SY_SysValues | Retrieves a list of system settings. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| Section | query | string | No | |
| SectionStartsWith | query | string | No | |
| SectionEndsWith | query | string | No | |
| SectionContains | query | string | No | |
| SectionLike | query | string | No | |
| SectionBetween | query | string[] | No | |
| SectionIn | query | string[] | No | |
| IDKey | query | string | No | |
| IDKeyStartsWith | query | string | No | |
| IDKeyEndsWith | query | string | No | |
| IDKeyContains | query | string | No | |
| IDKeyLike | query | string | No | |
| IDKeyBetween | query | string[] | No | |
| IDKeyIn | query | string[] | No | |
| Contents | query | string | No | |
| ContentsStartsWith | query | string | No | |
| ContentsEndsWith | query | string | No | |
| ContentsContains | query | string | No | |
| ContentsLike | query | string | No | |
| ContentsBetween | query | string[] | No | |
| ContentsIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| CellType | query | short? | No | |
| CellTypeGreaterThanOrEqualTo | query | short? | No | |
| CellTypeGreaterThan | query | short? | No | |
| CellTypeLessThan | query | short? | No | |
| CellTypeLessThanOrEqualTo | query | short? | No | |
| CellTypeNotEqualTo | query | short? | No | |
| CellTypeBetween | query | short[] | No | |
| CellTypeIn | query | short[] | No | |
| DisplayOrder | query | int? | No | |
| DisplayOrderGreaterThanOrEqualTo | query | int? | No | |
| DisplayOrderGreaterThan | query | int? | No | |
| DisplayOrderLessThan | query | int? | No | |
| DisplayOrderLessThanOrEqualTo | query | int? | No | |
| DisplayOrderNotEqualTo | query | int? | No | |
| DisplayOrderBetween | query | int[] | No | |
| DisplayOrderIn | query | int[] | No | |
| SectionCaption | query | string | No | |
| SectionCaptionStartsWith | query | string | No | |
| SectionCaptionEndsWith | query | string | No | |
| SectionCaptionContains | query | string | No | |
| SectionCaptionLike | query | string | No | |
| SectionCaptionBetween | query | string[] | No | |
| SectionCaptionIn | query | string[] | No | |
| ReadOnly | query | bool? | No | |
| ScriptFormatCell | query | string | No | |
| ScriptFormatCellStartsWith | query | string | No | |
| ScriptFormatCellEndsWith | query | string | No | |
| ScriptFormatCellContains | query | string | No | |
| ScriptFormatCellLike | query | string | No | |
| ScriptFormatCellBetween | query | string[] | No | |
| ScriptFormatCellIn | query | string[] | No | |
| ScriptButtonClicked | query | string | No | |
| ScriptButtonClickedStartsWith | query | string | No | |
| ScriptButtonClickedEndsWith | query | string | No | |
| ScriptButtonClickedContains | query | string | No | |
| ScriptButtonClickedLike | query | string | No | |
| ScriptButtonClickedBetween | query | string[] | No | |
| ScriptButtonClickedIn | query | string[] | No | |
| ScriptReadData | query | string | No | |
| ScriptReadDataStartsWith | query | string | No | |
| ScriptReadDataEndsWith | query | string | No | |
| ScriptReadDataContains | query | string | No | |
| ScriptReadDataLike | query | string | No | |
| ScriptReadDataBetween | query | string[] | No | |
| ScriptReadDataIn | query | string[] | No | |
| GridHandlerCode | query | string | No | |
| GridHandlerCodeStartsWith | query | string | No | |
| GridHandlerCodeEndsWith | query | string | No | |
| GridHandlerCodeContains | query | string | No | |
| GridHandlerCodeLike | query | string | No | |
| GridHandlerCodeBetween | query | string[] | No | |
| GridHandlerCodeIn | query | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | form | string | No | |
| Section | form | string | No | |
| IDKey | form | string | No | |
| Contents | form | string | No | |
| Description | form | string | No | |
| CellType | form | short | No | |
| DisplayOrder | form | int | No | |
| SectionCaption | form | string | No | |
| ReadOnly | form | bool | No | |
| ScriptFormatCell | form | string | No | |
| ScriptButtonClicked | form | string | No | |
| ScriptReadData | form | string | No | |
| GridHandlerCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/SY_SysValues HTTP/1.1 Host: localhost Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Results":[{"RecID":"String","Section":"String","IDKey":"String","Contents":"String","Description":"String","SectionCaption":"String","ScriptFormatCell":"String","ScriptButtonClicked":"String","ScriptReadData":"String","GridHandlerCode":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}