POST api/Lookup/GetSearchFields

Gets you a list of fields that can be used from ActivitySearchController.FindActivities(ActivitySearchController.ActivitySearchArgumentModel), ContractLineSearchController.FindContractLines(ContractLineSearchController.ContractLineSearchArgumentModel) or PartSearchController.PartSearch(PartSearchArgumentModel)

Request Information

URI Parameters

None.

Body Parameters

Specify which search you want the fields for

GetSearchFieldArgumentModel
NameDescriptionTypeAdditional information
SearchType

Gets or sets the search type

 SearchTypes

None.
ExportFieldsOnly

Gets or set if only fields available for export is to be fetched

 boolean

None.
TicketId

Gets or sets the ticket id

 string

None.
Culture

Gets or sets culture, if not specified we will use culture set on user.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "SearchType": 0,
  "ExportFieldsOnly": true,
  "TicketId": "sample string 2",
  "Culture": "sample string 3"
}

application/xml, text/xml

Sample: 
<LookupController.GetSearchFieldArgumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Controllers">
  <Culture xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 3</Culture>
  <TicketId xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 2</TicketId>
  <ExportFieldsOnly>true</ExportFieldsOnly>
  <SearchType>Activity</SearchType>
</LookupController.GetSearchFieldArgumentModel>

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 'GetSearchFieldArgumentModel'.

Response Information

Resource Description

GetSearchFieldReturnModel
NameDescriptionTypeAdditional information
Fields

Gets or sets the list ao available search fields.

 Collection of SearchFieldModel

None.
Type

Gets or set what kind of search to get fields from

 SearchTypes

None.
ExportFieldsOnly

Gets or set if only fields available for export is to be fetched

 boolean

None.
CombinedPerformanceId

Gets or sets the performance id. If performance monitoring is not turned on this property will not be present or set to null

 string

Json null value handling: Ignore

Response Formats

application/json, text/json

Sample: 
{
  "Fields": [
    {
      "Name": "sample string 1",
      "Label": "sample string 2",
      "Type": 0,
      "SortOrder": 3,
      "DefaultExport": true
    },
    {
      "Name": "sample string 1",
      "Label": "sample string 2",
      "Type": 0,
      "SortOrder": 3,
      "DefaultExport": true
    }
  ],
  "Type": 0,
  "ExportFieldsOnly": true,
  "CombinedPerformanceId": "sample string 2"
}

application/xml, text/xml

Sample: 
<LookupController.GetSearchFieldReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Controllers">
  <CombinedPerformanceId xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 2</CombinedPerformanceId>
  <ExportFieldsOnly>true</ExportFieldsOnly>
  <Fields>
    <LookupController.SearchFieldModel>
      <DefaultExport>true</DefaultExport>
      <Label>sample string 2</Label>
      <Name>sample string 1</Name>
      <SortOrder>3</SortOrder>
      <Type>Bool</Type>
    </LookupController.SearchFieldModel>
    <LookupController.SearchFieldModel>
      <DefaultExport>true</DefaultExport>
      <Label>sample string 2</Label>
      <Name>sample string 1</Name>
      <SortOrder>3</SortOrder>
      <Type>Bool</Type>
    </LookupController.SearchFieldModel>
  </Fields>
  <Type>Activity</Type>
</LookupController.GetSearchFieldReturnModel>