PUT api/Search/Entities

Searches entities.

Request Information

URI Parameters

None.

Body Parameters

WorkPoint365.WebAPI.Models.SearchQuery
NameDescriptionTypeAdditional information
QueryText

string

None.

PageSize

integer

None.

PageStart

integer

None.

Scope

WorkPoint365.WebAPI.Models.SearchScope

None.

SelectProperties

Collection of string

None.

AdditionalRefiners

Collection of string

None.

Refiners

Collection of WorkPoint365.WebAPI.Models.SearchRefiner

None.

SortCollection

Collection of WorkPoint365.WebAPI.Models.SearchQuery+Sort

None.

TrimDuplicates

boolean

None.

TenantWideSearch

boolean

None.

CollapseSpecification

string

None.

Request Formats

application/json, text/json

Sample:
{
  "QueryText": "sample string 1",
  "PageSize": 2,
  "PageStart": 3,
  "Scope": {
    "Title": "sample string 1",
    "Expression": "sample string 2"
  },
  "SelectProperties": [
    "sample string 1",
    "sample string 2"
  ],
  "AdditionalRefiners": [
    "sample string 1",
    "sample string 2"
  ],
  "Refiners": [
    {
      "RefinerName": {},
      "RefinementType": {},
      "Culture": {},
      "RefinementValue": {},
      "RefinementToken": {},
      "RefinementCount": {}
    },
    {
      "RefinerName": {},
      "RefinementType": {},
      "Culture": {},
      "RefinementValue": {},
      "RefinementToken": {},
      "RefinementCount": {}
    }
  ],
  "SortCollection": [
    {
      "Direction": 0,
      "Property": "sample string 1"
    },
    {
      "Direction": 0,
      "Property": "sample string 1"
    }
  ],
  "TrimDuplicates": true,
  "TenantWideSearch": true,
  "CollapseSpecification": "sample string 6"
}

application/xml, text/xml

Sample:
<SearchQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Models">
  <AdditionalRefiners xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AdditionalRefiners>
  <CollapseSpecification>sample string 6</CollapseSpecification>
  <PageSize>2</PageSize>
  <PageStart>3</PageStart>
  <QueryText>sample string 1</QueryText>
  <Refiners>
    <SearchRefiner>
      <Culture />
      <RefinementCount />
      <RefinementToken />
      <RefinementType />
      <RefinementValue />
      <RefinerName />
    </SearchRefiner>
    <SearchRefiner>
      <Culture />
      <RefinementCount />
      <RefinementToken />
      <RefinementType />
      <RefinementValue />
      <RefinerName />
    </SearchRefiner>
  </Refiners>
  <Scope>
    <Expression>sample string 2</Expression>
    <Title>sample string 1</Title>
  </Scope>
  <SelectProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SelectProperties>
  <SortCollection>
    <SearchQuery.Sort>
      <Direction>Ascending</Direction>
      <Property>sample string 1</Property>
    </SearchQuery.Sort>
    <SearchQuery.Sort>
      <Direction>Ascending</Direction>
      <Property>sample string 1</Property>
    </SearchQuery.Sort>
  </SortCollection>
  <TenantWideSearch>true</TenantWideSearch>
  <TrimDuplicates>true</TrimDuplicates>
</SearchQuery>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.