POST public-api/transactions/streamgridrequestcsv
Request transaction history records as a stream of data in a CSV formated stream. If the FieldTitles parameter is null than all available fields are exported with default column titles. Important! Without this parameter the order and names of fields may change from version to version. Therefore, to ensure consistent results from one version to the next, make sure you provide this value after you have determined the values you need. If the FieldTitles parameter is not provided the column names returned will be the database column names. This API does not support paging as it is intended to stream all of the data at once All of datatime field will not convert to local time,showing UTC(UniversalTime) with format yyyy-MM-dd HH:mm:ssZ
Request Information
URI Parameters
None.
Body Parameters
GridStreamRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FieldTitles | Collection of Pair of string [key] and string [value] |
None. |
|
| TotalCountFromPriorFetch | integer |
None. |
|
| AdditionalSkipCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Sort | Collection of Object |
None. |
|
| Filter | TopLevelFilterType |
None. |
|
| ClientUtcOffset | TimeZoneInfoId |
None. |
|
| FilterBehavior | FilterBehaviorFlags |
None. |
|
| IgnoreAttachments | boolean |
None. |
|
| IgnoreGeoLocation | boolean |
None. |
|
| WorkingSiteIdCsvList | string |
None. |
Request Formats
application/json
{
"_sortCriteria": [],
"FieldTitles": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"TotalCountFromPriorFetch": 1,
"AdditionalSkipCount": 1,
"PageSize": 2,
"PageNumber": 3,
"Filter": {
"$id": "1",
"field": "sample string 1",
"operator": "sample string 2",
"value": {},
"logic": "sample string 4",
"filters": []
},
"ClientUtcOffset": null,
"FilterBehavior": 0,
"IgnoreAttachments": true,
"IgnoreGeoLocation": true,
"WorkingSiteIdCsvList": "6"
}
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |