POST api/v2/dataservice/findasync

Initiates a Finds data request in specified table with given search parameters asynchronously. You must call findasyncgetresult to retrieve results

Request Information

URI Parameters

None.

Body Parameters

The search parameters.

Query2

Name	Type	Additional information
TableName	string	Required
Operator	LogicalOperator	Required
PagingData	PagingData	Required
SearchFields	Collection of QueryField	Required
ReturnFieldList	Collection of string	None.
ReturnDataFormat	Collection of DataFieldFormat	None.

Request Formats

application/json, text/json

Sample:

{
  "TableName": "sample string 1",
  "Operator": "And",
  "PagingData": {
    "PageSize": 1,
    "PageIndex": 2,
    "TotalRecords": 3,
    "TotalPages": 4,
    "Token": "sample string 5"
  },
  "SearchFields": [
    {
      "FieldName": "sample string 1",
      "Value": "sample string 2",
      "ComparisonOperator": "Equal"
    },
    {
      "FieldName": "sample string 1",
      "Value": "sample string 2",
      "ComparisonOperator": "Equal"
    }
  ],
  "ReturnFieldList": [
    "sample string 1",
    "sample string 2"
  ],
  "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:

<Query2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paperclip.IOTA.WebApi.Model">
  <Operator>And</Operator>
  <PagingData>
    <PageIndex>2</PageIndex>
    <PageSize>1</PageSize>
    <Token>sample string 5</Token>
    <TotalPages>4</TotalPages>
    <TotalRecords>3</TotalRecords>
  </PagingData>
  <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>
  <ReturnFieldList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReturnFieldList>
  <SearchFields>
    <QueryField>
      <ComparisonOperator>Equal</ComparisonOperator>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
    </QueryField>
    <QueryField>
      <ComparisonOperator>Equal</ComparisonOperator>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
    </QueryField>
  </SearchFields>
  <TableName>sample string 1</TableName>
</Query2>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Query2'.

Response Information

Resource Description

Returns Ticket Id to be used by caller to retrieve result

string

Response 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