POST api/PostDownloadTextFile
Request Information
URI Parameters
None.
Body Parameters
DownloadTextFileRequestName | Description | Type | Additional information |
---|---|---|---|
SearchRequest | GetSearchRequest |
None. |
|
DelimitedFileSpec | DelimitedFileSpec |
None. |
Request Formats
application/json, text/json
Sample:
{ "SearchRequest": { "ClassSymbolicName": "sample string 1", "PropertyOption": "sample string 2", "RowsPerPage": 3, "PageNumber": 4, "SearchCriteria": [ { "SymbolicName": "sample string 1", "Condition": "sample string 2", "Value": "sample string 3" }, { "SymbolicName": "sample string 1", "Condition": "sample string 2", "Value": "sample string 3" } ], "OrderByProperties": [ { "SymbolicName": "sample string 1", "Direction": "sample string 2" }, { "SymbolicName": "sample string 1", "Direction": "sample string 2" } ], "RequestProperties": [ "sample string 1", "sample string 2" ] }, "DelimitedFileSpec": { "Delimiter": 1, "TextQualifier": 2, "FileName": "sample string 3", "EscapeExcelFormulas": true } }
application/xml, text/xml
Sample:
<DownloadTextFileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JSONFileNet"> <DelimitedFileSpec> <Delimiter>1</Delimiter> <EscapeExcelFormulas>true</EscapeExcelFormulas> <FileName>sample string 3</FileName> <TextQualifier>2</TextQualifier> </DelimitedFileSpec> <SearchRequest> <ClassSymbolicName>sample string 1</ClassSymbolicName> <OrderByProperties> <OrderBy> <Direction>sample string 2</Direction> <SymbolicName>sample string 1</SymbolicName> </OrderBy> <OrderBy> <Direction>sample string 2</Direction> <SymbolicName>sample string 1</SymbolicName> </OrderBy> </OrderByProperties> <PageNumber>4</PageNumber> <PropertyOption>sample string 2</PropertyOption> <RequestProperties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </RequestProperties> <RowsPerPage>3</RowsPerPage> <SearchCriteria> <PropertyCriterion> <Condition>sample string 2</Condition> <SymbolicName>sample string 1</SymbolicName> <Value>sample string 3</Value> </PropertyCriterion> <PropertyCriterion> <Condition>sample string 2</Condition> <SymbolicName>sample string 1</SymbolicName> <Value>sample string 3</Value> </PropertyCriterion> </SearchCriteria> </SearchRequest> </DownloadTextFileRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessageName | 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. |