GET api/filters/{id}

Get a specific filter.

Required Scopes

Assessment.MainIndex

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique ID of the filter.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Filter

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
Description	string	None.
Notes	string	None.
KeyField	string	None.
DisplayKeyField	string	None.
FilterType	Enum	None.
ParentId	globally unique identifier	None.
Parameters	Collection of FilterParameter	None.

{
  "Id": "3f989134-50e4-4dce-97da-33df3d66abd4",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Notes": "sample string 4",
  "KeyField": "sample string 5",
  "DisplayKeyField": "sample string 6",
  "FilterType": null,
  "ParentId": "1819c5ef-ea09-4d64-9708-86883bf81792",
  "Parameters": [
    {
      "Id": "c52d53d1-f276-4aa5-a3d5-0c301c39a925",
      "ParameterType": null,
      "Description": "sample string 2"
    },
    {
      "Id": "c52d53d1-f276-4aa5-a3d5-0c301c39a925",
      "ParameterType": null,
      "Description": "sample string 2"
    }
  ]
}

<Filter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models.Filters">
  <Description>sample string 3</Description>
  <DisplayKeyField>sample string 6</DisplayKeyField>
  <FilterType i:nil="true" />
  <Id>3f989134-50e4-4dce-97da-33df3d66abd4</Id>
  <KeyField>sample string 5</KeyField>
  <Name>sample string 2</Name>
  <Notes>sample string 4</Notes>
  <Parameters>
    <FilterParameter>
      <Description>sample string 2</Description>
      <Id>c52d53d1-f276-4aa5-a3d5-0c301c39a925</Id>
      <ParameterType i:nil="true" />
    </FilterParameter>
    <FilterParameter>
      <Description>sample string 2</Description>
      <Id>c52d53d1-f276-4aa5-a3d5-0c301c39a925</Id>
      <ParameterType i:nil="true" />
    </FilterParameter>
  </Parameters>
  <ParentId>1819c5ef-ea09-4d64-9708-86883bf81792</ParentId>
</Filter>