POST Study/GetSearchPeers
Request Information
URI Parameters
None.
Body Parameters
BreadCrumbSearchParam| Name | Description | Type | Additional information |
|---|---|---|---|
| studyId | integer |
None. |
|
| searchTerminoList | Collection of SearchTermino |
None. |
|
| searchPublicPeerLastParam | SearchTermino |
None. |
|
| fromAvailableList | boolean |
None. |
|
| isNewSearch | boolean |
None. |
|
| isRemove | boolean |
None. |
|
| sorts | Collection of GridSort |
None. |
|
| filters | GridFilters |
None. |
|
| pageNumber | integer |
None. |
|
| pageSize | integer |
None. |
|
| FilterType | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"studyId": 1,
"searchTerminoList": [
{
"searchType": "sample string 1",
"searchText": "sample string 2",
"metricId": 3,
"kpiName": "sample string 4",
"filterOperatorId": 5,
"metricValueStart": 6,
"metricValueEnd": 7,
"metricUnitValue1": 8,
"metricUnitValue2": 9,
"searchOperand": "sample string 10"
},
{
"searchType": "sample string 1",
"searchText": "sample string 2",
"metricId": 3,
"kpiName": "sample string 4",
"filterOperatorId": 5,
"metricValueStart": 6,
"metricValueEnd": 7,
"metricUnitValue1": 8,
"metricUnitValue2": 9,
"searchOperand": "sample string 10"
}
],
"searchPublicPeerLastParam": {
"searchType": "sample string 1",
"searchText": "sample string 2",
"metricId": 3,
"kpiName": "sample string 4",
"filterOperatorId": 5,
"metricValueStart": 6,
"metricValueEnd": 7,
"metricUnitValue1": 8,
"metricUnitValue2": 9,
"searchOperand": "sample string 10"
},
"fromAvailableList": true,
"isNewSearch": true,
"isRemove": true,
"sorts": [
{
"field": "sample string 1",
"dir": "sample string 2"
},
{
"field": "sample string 1",
"dir": "sample string 2"
}
],
"filters": {
"Filters": [
{
"Operator": "sample string 1",
"Field": "sample string 2",
"Value": "sample string 3"
},
{
"Operator": "sample string 1",
"Field": "sample string 2",
"Value": "sample string 3"
}
],
"Logic": "sample string 1"
},
"pageNumber": 5,
"pageSize": 6,
"FilterType": 1
}
application/xml, text/xml
Sample:
<BreadCrumbSearchParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUA.REST.Models">
<FilterType>1</FilterType>
<filters>
<Filters>
<GridFilter>
<Field>sample string 2</Field>
<Operator>sample string 1</Operator>
<Value>sample string 3</Value>
</GridFilter>
<GridFilter>
<Field>sample string 2</Field>
<Operator>sample string 1</Operator>
<Value>sample string 3</Value>
</GridFilter>
</Filters>
<Logic>sample string 1</Logic>
</filters>
<fromAvailableList>true</fromAvailableList>
<isNewSearch>true</isNewSearch>
<isRemove>true</isRemove>
<pageNumber>5</pageNumber>
<pageSize>6</pageSize>
<searchPublicPeerLastParam>
<filterOperatorId>5</filterOperatorId>
<kpiName>sample string 4</kpiName>
<metricId>3</metricId>
<metricUnitValue1>8</metricUnitValue1>
<metricUnitValue2>9</metricUnitValue2>
<metricValueEnd>7</metricValueEnd>
<metricValueStart>6</metricValueStart>
<searchOperand>sample string 10</searchOperand>
<searchText>sample string 2</searchText>
<searchType>sample string 1</searchType>
</searchPublicPeerLastParam>
<searchTerminoList>
<SearchTermino>
<filterOperatorId>5</filterOperatorId>
<kpiName>sample string 4</kpiName>
<metricId>3</metricId>
<metricUnitValue1>8</metricUnitValue1>
<metricUnitValue2>9</metricUnitValue2>
<metricValueEnd>7</metricValueEnd>
<metricValueStart>6</metricValueStart>
<searchOperand>sample string 10</searchOperand>
<searchText>sample string 2</searchText>
<searchType>sample string 1</searchType>
</SearchTermino>
<SearchTermino>
<filterOperatorId>5</filterOperatorId>
<kpiName>sample string 4</kpiName>
<metricId>3</metricId>
<metricUnitValue1>8</metricUnitValue1>
<metricUnitValue2>9</metricUnitValue2>
<metricValueEnd>7</metricValueEnd>
<metricValueStart>6</metricValueStart>
<searchOperand>sample string 10</searchOperand>
<searchText>sample string 2</searchText>
<searchType>sample string 1</searchType>
</SearchTermino>
</searchTerminoList>
<sorts>
<GridSort>
<dir>sample string 2</dir>
<field>sample string 1</field>
</GridSort>
<GridSort>
<dir>sample string 2</dir>
<field>sample string 1</field>
</GridSort>
</sorts>
<studyId>1</studyId>
</BreadCrumbSearchParam>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | 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. |