Arthur Ria
227 lines
3.1 KiB
Markdown
227 lines
3.1 KiB
Markdown
## Request Information
|
|
|
|
### URI Parameters
|
|
|
|
None.
|
|
|
|
### Body Parameters
|
|
|
|
[QueryExecute](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryExecute)
|
|
|
|
| Name | Description | Type | Additional information |
|
|
| --- | --- | --- | --- |
|
|
| Application |
|
|
Application name.
|
|
|
|
| String |
|
|
|
|
None.
|
|
|
|
|
|
|
| ClientModule |
|
|
|
|
Client module that executes the query.
|
|
|
|
| String |
|
|
|
|
None.
|
|
|
|
|
|
|
| QueryType |
|
|
|
|
Type of the query.
|
|
|
|
| [QueryContextType](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryContextType) |
|
|
|
|
Default: Reading
|
|
|
|
|
|
|
| Expression |
|
|
|
|
Query expression.
|
|
|
|
| String |
|
|
|
|
None.
|
|
|
|
|
|
|
| OrderBy |
|
|
|
|
Order by to be applied to the expression.
|
|
|
|
| String |
|
|
|
|
None.
|
|
|
|
|
|
|
| Select |
|
|
|
|
Select to be applied to the expression.
|
|
|
|
| String |
|
|
|
|
None.
|
|
|
|
|
|
|
| Skip |
|
|
|
|
Skip to be applied to the expression.
|
|
|
|
| Int32 |
|
|
|
|
None.
|
|
|
|
|
|
|
| Take |
|
|
|
|
Take to be applied to the expression.
|
|
|
|
| Int32 |
|
|
|
|
None.
|
|
|
|
|
|
|
| Parameters |
|
|
|
|
Dictionary with the parameters and their values for the query.
|
|
|
|
| Dictionary of String \[key\] and [QueryParameterValue](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryParameterValue) \[value\] |
|
|
|
|
None.
|
|
|
|
|
|
|
| InlineCount |
|
|
|
|
Indicate if an inline count must be done to the query.
|
|
|
|
| Boolean |
|
|
|
|
None.
|
|
|
|
|
|
|
| CommandTimeout |
|
|
|
|
Gets or sets the command/query timeout.
|
|
|
|
| Int32? |
|
|
|
|
None.
|
|
|
|
|
|
|
| QueryId |
|
|
|
|
Gets or sets the query execution identifier.
|
|
|
|
| Guid? |
|
|
|
|
None.
|
|
|
|
|
|
|
|
|
### Request Formats
|
|
|
|
**Sample:**
|
|
|
|
```
|
|
{
|
|
"Application": "sample string 1",
|
|
"ClientModule": "sample string 2",
|
|
"QueryType": 0,
|
|
"Expression": "sample string 3",
|
|
"OrderBy": "sample string 4",
|
|
"Select": "sample string 5",
|
|
"Skip": 6,
|
|
"Take": 7,
|
|
"Parameters": {
|
|
"sample string 1": {
|
|
"TypeName": "sample string 1",
|
|
"Value": {}
|
|
},
|
|
"sample string 2": {
|
|
"TypeName": "sample string 1",
|
|
"Value": {}
|
|
}
|
|
},
|
|
"InlineCount": true,
|
|
"CommandTimeout": 1,
|
|
"QueryId": "e57b9e2d-1ba9-42c7-a035-fe964ce53fd6"
|
|
}
|
|
|
|
```
|
|
|
|
**Sample:**
|
|
|
|
Sample not available.
|
|
|
|
**Sample:**
|
|
|
|
```
|
|
Binary JSON content. See http://bsonspec.org for details.
|
|
|
|
```
|
|
|
|
## Response Information
|
|
|
|
### Resource Description
|
|
|
|
[QueryResultData](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryResultData)
|
|
|
|
| Name | Description | Type | Additional information |
|
|
| --- | --- | --- | --- |
|
|
| InLineCount |
|
|
Gets or sets the in line count.
|
|
|
|
| Int32 |
|
|
|
|
None.
|
|
|
|
|
|
|
| Table |
|
|
|
|
Gets or sets the table.
|
|
|
|
| [QueryTable](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryTable) |
|
|
|
|
None.
|
|
|
|
|
|
|
|
|
### Response Formats
|
|
|
|
**Sample:**
|
|
|
|
```
|
|
{
|
|
"InLineCount": 1,
|
|
"Table": {
|
|
"TableName": "sample string 1",
|
|
"Columns": [
|
|
{
|
|
"ColumnName": "sample string 1",
|
|
"TypeName": "sample string 2"
|
|
},
|
|
{
|
|
"ColumnName": "sample string 1",
|
|
"TypeName": "sample string 2"
|
|
}
|
|
],
|
|
"Rows": [
|
|
null,
|
|
{
|
|
"Values": {
|
|
"sample string 1": {},
|
|
"sample string 3": {}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
|
|
```
|
|
|
|
**Sample:**
|
|
|
|
```
|
|
Binary JSON content. See http://bsonspec.org for details.
|
|
|
|
``` |