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	Array of field name, title pairs as they should be exported in the CSV. If FieldTitles 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 consisteny results from one version to the next, make sure you provide this value after you have determined the values you need.	Collection of Pair of string [key] and string [value]	None.
TotalCountFromPriorFetch	This field helps to skip the page count recalculation that goes into calculating the TotalRecordsLongCount. For example - When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is a time-consuming operation. To avoid that extra calculation, and help prevent throttling, TotalRecordsLongCount is assigned to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page through the records faster. By default, this value is a null value, meaning the api should peform a record count of the data prior to fetching the records.	integer	None.
AdditionalSkipCount	This is the additional number of records to skip, in addition to page size and page #. This is useful for quick filter (more) mode of operation. This field is not implemented.	integer	None.
PageSize	Due to the large number of records this API may return, this is a paging API. Set this value to specify the number of records you wish to process per API call. (Recommended 100-500). Note: some grid query api will ignore or cap this value if the requested page size is too large. A large page size (several thousands) could overflow or degrade the serialization of return data.	integer	None.
PageNumber	Due to the large number of records this API may return, this is a paging API. Set this value to specify the page number or record set you wish to process. Generally you would want to keep the PageSize constant (Recommended 100-500) and loop thru the results incrementing this PageNumber until the number of records returned is less than the value you specified for PageSize.	integer	None.
Sort	This is an expression tree. Set this to specify all the columns you wish to sort the data by. Default None.	Collection of Object	None.
Filter	This is an expression tree. Set this to specify all the columns, values and operators you wish to filter the data by. Default None.	TopLevelFilterType	None.
ClientUtcOffset	If you provide a valid expression tree for the Filter parameter and the filter expression you provide performs one or more comparisons of DateTime values with constants then set this to specify which time zone your DateTime constants represent. Common ClientUtcOffset string values include: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Marquesas Standard Time, Alaskan Standard Time, Pacific Standard Time, Mountain Standard Time, Central Standard Time, Eastern Standard Time, Venezuela Standard Time, Atlantic Standard Time, Newfoundland Standard Time, Greenland Standard Time, UTC-02, Cape Verde Standard Time, GMT Standard Time, W. Europe Standard Time, GTB Standard Time, Russian Standard Time, Arabian Standard Time, Afghanistan Standard Time, Pakistan Standard Time, India Standard Time, China Standard Time, Tokyo Standard Time, AUS Central Standard Time, West Pacific Standard Time, Central Pacific Standard Time, Fiji Standard Time, Samoa Standard Time.	TimeZoneInfoId	None.
FilterBehavior	Internal - specific filter behaviors	FilterBehaviorFlags	None.
WorkingSiteIdCsvList	Use this comma separated list for values to efficiently filter results to one or more sites.	string	None.

Request Formats

application/json

Sample:

{
  "FieldTitles": [
    {
      "Key": "AssetTransDate",
      "Value": "AssetTransDate"
    },
    {
      "Key": "IsSystemGenerated",
      "Value": "IsSystemGenerated"
    },
    {
      "Key": "AssetTransCheckoutQtyCurrentQty",
      "Value": "AssetTransCheckoutQtyCurrentQty"
    },
    {
      "Key": "AssetTransCurrentQty",
      "Value": "AssetTransCurrentQty"
    },
    {
      "Key": "AssetTransQuantity",
      "Value": "AssetTransQuantity"
    },
    {
      "Key": "OrderNumber",
      "Value": "OrderNumber"
    },
    {
      "Key": "AssetTransBatchNo",
      "Value": "AssetTransBatchNo"
    },
    {
      "Key": "AssetDescription",
      "Value": "AssetDescription"
    },
    {
      "Key": "AssetModel",
      "Value": "AssetModel"
    },
    {
      "Key": "AssetSerialNumber",
      "Value": "AssetSerialNumber"
    },
    {
      "Key": "AssetTag",
      "Value": "AssetTag"
    },
    {
      "Key": "AssetTransReceiptNum",
      "Value": "AssetTransReceiptNum"
    },
    {
      "Key": "AssetTransRecordSource",
      "Value": "AssetTransRecordSource"
    },
    {
      "Key": "AssetTypeNumber",
      "Value": "AssetTypeNumber"
    },
    {
      "Key": "CustomerCompanyName",
      "Value": "CustomerCompanyName"
    },
    {
      "Key": "CustomerNumber",
      "Value": "CustomerNumber"
    },
    {
      "Key": "LocationCode",
      "Value": "LocationCode"
    },
    {
      "Key": "LocationDescription",
      "Value": "LocationDescription"
    },
    {
      "Key": "ReasonCode",
      "Value": "ReasonCode"
    },
    {
      "Key": "SiteName",
      "Value": "SiteName"
    },
    {
      "Key": "SupplierName",
      "Value": "SupplierName"
    },
    {
      "Key": "SupplierNumber",
      "Value": "SupplierNumber"
    },
    {
      "Key": "UserLogon",
      "Value": "UserLogon"
    },
    {
      "Key": "AssetTransEntryDate",
      "Value": "AssetTransEntryDate"
    },
    {
      "Key": "CustomerFirstName",
      "Value": "CustomerFirstName"
    },
    {
      "Key": "CustomerLastName",
      "Value": "CustomerLastName"
    },
    {
      "Key": "SerialNumber",
      "Value": "SerialNumber"
    },
    {
      "Key": "UserTransactionDate",
      "Value": "UserTransactionDate"
    },
    {
      "Key": "Category",
      "Value": "Category"
    },
    {
      "Key": "ActionItem",
      "Value": "ActionItem"
    },
    {
      "Key": "CustomerNameCalculated",
      "Value": "CustomerNameCalculated"
    },
    {
      "Key": "VendorSupplierNameCalculated",
      "Value": "VendorSupplierNameCalculated"
    },
    {
      "Key": "Lot",
      "Value": "Lot"
    },
    {
      "Key": "DateCode",
      "Value": "DateCode"
    },
    {
      "Key": "RefNumber",
      "Value": "RefNumber"
    },
    {
      "Key": "LicensePlateNumber",
      "Value": "LicensePlateNumber"
    }
  ],
  "AdditionalSkipCount": 0,
  "PageSize": 0,
  "PageNumber": 0,
  "Filter": {
    "filters": [
      {
        "field": "AssetTransDate",
        "operator": ">",
        "value": "2025-02-20T00:00:00"
      }
    ]
  },
  "FilterBehavior": 0
}

Response Information

Resource Description

HttpResponseMessage

Name	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.