POST api/v2/dataservice/compoundfind

Finds data in specified table with the supplied query, using sql query syntax. 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
NameDescriptionTypeAdditional 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:

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

Response Information

Resource Description

PcSafeData2
NameDescriptionTypeAdditional information
TransactionId

string

None.

PagingData

PagingData

None.

TableData

TableData

None.

Response Formats

application/json, text/json

Sample:
{
  "TransactionId": "sample string 1",
  "PagingData": {
    "PageSize": 1,
    "PageIndex": 2,
    "TotalRecords": 3,
    "TotalPages": 4,
    "Token": "sample string 5"
  },
  "TableData": {
    "TableName": "sample string 1",
    "FieldNames": [
      "sample string 1",
      "sample string 2"
    ],
    "Rows": [
      {
        "RefId": "sample string 1",
        "RowId": "sample string 2",
        "FieldValues": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "RefId": "sample string 1",
        "RowId": "sample string 2",
        "FieldValues": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:
<PcSafeData2 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>
  <TableData>
    <FieldNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </FieldNames>
    <Rows>
      <SafeDataRow>
        <FieldValues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </FieldValues>
        <RefId>sample string 1</RefId>
        <RowId>sample string 2</RowId>
      </SafeDataRow>
      <SafeDataRow>
        <FieldValues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </FieldValues>
        <RefId>sample string 1</RefId>
        <RowId>sample string 2</RowId>
      </SafeDataRow>
    </Rows>
    <TableName>sample string 1</TableName>
  </TableData>
  <TransactionId>sample string 1</TransactionId>
</PcSafeData2>