POST api/v1/dataservice/compoundfindasync
Initiates a Compound Find in specified table with given search parameters asynchronously. You must call compoundfindasyncgetresult to retrieve results. NOTE : Currently, only queries on a single table are supported and only using the 'AND' logical operator. In addition, the only comparison operators supported are '=' and 'like'
Request Information
URI Parameters
None.
Body Parameters
The search parameters.
CompoundQuery| Name | Description | Type | Additional information |
|---|---|---|---|
| PagingData | PagingData |
Required |
|
| Query | string |
Required |
|
| ReturnDataFormat | Collection of DataFieldFormat |
None. |
Request Formats
application/json, text/json
Sample:
{
"PagingData": {
"PageSize": 1,
"PageIndex": 2,
"TotalRecords": 3,
"TotalPages": 4,
"Token": "sample string 5"
},
"Query": "sample string 1",
"ReturnDataFormat": [
{
"Name": "sample string 1",
"Format": "sample string 2",
"AnonymizationOption": "Default"
},
{
"Name": "sample string 1",
"Format": "sample string 2",
"AnonymizationOption": "Default"
}
]
}
application/xml, text/xml
Sample:
<CompoundQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paperclip.IOTA.WebApi.Model">
<PagingData>
<PageIndex>2</PageIndex>
<PageSize>1</PageSize>
<Token>sample string 5</Token>
<TotalPages>4</TotalPages>
<TotalRecords>3</TotalRecords>
</PagingData>
<Query>sample string 1</Query>
<ReturnDataFormat>
<DataFieldFormat>
<AnonymizationOption>Default</AnonymizationOption>
<Format>sample string 2</Format>
<Name>sample string 1</Name>
</DataFieldFormat>
<DataFieldFormat>
<AnonymizationOption>Default</AnonymizationOption>
<Format>sample string 2</Format>
<Name>sample string 1</Name>
</DataFieldFormat>
</ReturnDataFormat>
</CompoundQuery>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>
text/plain
Sample:
sample string 1