POST public-api/assets/streamgridrequestcsvflat
Request asset inventory records as a stream of data in a CSV formatted stream. If the FieldTitles parameter is null then all available fields are exported with default column titles. When you create Custom Fields on assets you can call this function with the FieldTitles parameter = null as well to see how custom fields look in the output stream. 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 set this value after you have determined the values you need. Does not support paging as it is intended to stream all of the data at once This is the flat view, so an asset that is present in more than one location is streamed once per location record. DateTime values are streamed in UTC unless you name them in the ClientLocalDateTimeFields parameter, in which case they are converted using ClientUtcOffset and ExportDateTimeFormat.
Request Information
URI Parameters
None.
Body Parameters
GridStreamRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FieldTitles | Collection of Pair of string [key] and string [value] |
None. |
|
| ClientLocalDateTimeFields | Collection of string |
None. |
|
| DateOnlyFields | Collection of string |
None. |
|
| ExportDateFormat | string |
None. |
|
| ExportDateTimeFormat | string |
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"
}
],
"ClientLocalDateTimeFields": [
"sample string 1",
"sample string 2"
],
"DateOnlyFields": [
"sample string 1",
"sample string 2"
],
"ExportDateFormat": "sample string 1",
"ExportDateTimeFormat": "sample string 2",
"TotalCountFromPriorFetch": 1,
"AdditionalSkipCount": 3,
"PageSize": 4,
"PageNumber": 5,
"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": "8"
}
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. |