Help Page Home

GET api/users/me/filters

Get all filters for the currently logged in user.

Required Scopes

Assessment.MainIndex

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of filters.

FiltersForSession
NameDescriptionTypeAdditional information
Filters

Collection of Filter

None.

ExtraParameters

Collection of ExtraParameter

None.

Response Formats

{
  "Filters": [
    {
      "Id": "65d73e56-8f01-446a-9c60-e026144f09bf",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Notes": "sample string 4",
      "KeyField": "sample string 5",
      "DisplayKeyField": "sample string 6",
      "FilterType": null,
      "ParentId": "633a5a79-ec17-413e-b847-81b3486c7362",
      "Parameters": [
        {
          "Id": "705655c7-9b6a-4ed1-8afc-921d26c867e7",
          "ParameterType": null,
          "Description": "sample string 2"
        },
        {
          "Id": "705655c7-9b6a-4ed1-8afc-921d26c867e7",
          "ParameterType": null,
          "Description": "sample string 2"
        }
      ]
    },
    {
      "Id": "65d73e56-8f01-446a-9c60-e026144f09bf",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Notes": "sample string 4",
      "KeyField": "sample string 5",
      "DisplayKeyField": "sample string 6",
      "FilterType": null,
      "ParentId": "633a5a79-ec17-413e-b847-81b3486c7362",
      "Parameters": [
        {
          "Id": "705655c7-9b6a-4ed1-8afc-921d26c867e7",
          "ParameterType": null,
          "Description": "sample string 2"
        },
        {
          "Id": "705655c7-9b6a-4ed1-8afc-921d26c867e7",
          "ParameterType": null,
          "Description": "sample string 2"
        }
      ]
    }
  ],
  "ExtraParameters": [
    {
      "DisplayName": "sample string 1",
      "Id": "c90cc97e-d848-4b8b-85f3-a55bede228d6",
      "FilterType": null,
      "Options": [
        {
          "Description": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Description": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "ParameterName": "sample string 3",
      "ParameterType": null
    },
    {
      "DisplayName": "sample string 1",
      "Id": "c90cc97e-d848-4b8b-85f3-a55bede228d6",
      "FilterType": null,
      "Options": [
        {
          "Description": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Description": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "ParameterName": "sample string 3",
      "ParameterType": null
    }
  ]
}
<FiltersForSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models.Filters">
  <ExtraParameters>
    <ExtraParameter>
      <DisplayName>sample string 1</DisplayName>
      <FilterType i:nil="true" />
      <Id>c90cc97e-d848-4b8b-85f3-a55bede228d6</Id>
      <Options>
        <ExtraParameterOption>
          <Description>sample string 1</Description>
          <Value>sample string 2</Value>
        </ExtraParameterOption>
        <ExtraParameterOption>
          <Description>sample string 1</Description>
          <Value>sample string 2</Value>
        </ExtraParameterOption>
      </Options>
      <ParameterName>sample string 3</ParameterName>
      <ParameterType i:nil="true" />
    </ExtraParameter>
    <ExtraParameter>
      <DisplayName>sample string 1</DisplayName>
      <FilterType i:nil="true" />
      <Id>c90cc97e-d848-4b8b-85f3-a55bede228d6</Id>
      <Options>
        <ExtraParameterOption>
          <Description>sample string 1</Description>
          <Value>sample string 2</Value>
        </ExtraParameterOption>
        <ExtraParameterOption>
          <Description>sample string 1</Description>
          <Value>sample string 2</Value>
        </ExtraParameterOption>
      </Options>
      <ParameterName>sample string 3</ParameterName>
      <ParameterType i:nil="true" />
    </ExtraParameter>
  </ExtraParameters>
  <Filters>
    <Filter>
      <Description>sample string 3</Description>
      <DisplayKeyField>sample string 6</DisplayKeyField>
      <FilterType i:nil="true" />
      <Id>65d73e56-8f01-446a-9c60-e026144f09bf</Id>
      <KeyField>sample string 5</KeyField>
      <Name>sample string 2</Name>
      <Notes>sample string 4</Notes>
      <Parameters>
        <FilterParameter>
          <Description>sample string 2</Description>
          <Id>705655c7-9b6a-4ed1-8afc-921d26c867e7</Id>
          <ParameterType i:nil="true" />
        </FilterParameter>
        <FilterParameter>
          <Description>sample string 2</Description>
          <Id>705655c7-9b6a-4ed1-8afc-921d26c867e7</Id>
          <ParameterType i:nil="true" />
        </FilterParameter>
      </Parameters>
      <ParentId>633a5a79-ec17-413e-b847-81b3486c7362</ParentId>
    </Filter>
    <Filter>
      <Description>sample string 3</Description>
      <DisplayKeyField>sample string 6</DisplayKeyField>
      <FilterType i:nil="true" />
      <Id>65d73e56-8f01-446a-9c60-e026144f09bf</Id>
      <KeyField>sample string 5</KeyField>
      <Name>sample string 2</Name>
      <Notes>sample string 4</Notes>
      <Parameters>
        <FilterParameter>
          <Description>sample string 2</Description>
          <Id>705655c7-9b6a-4ed1-8afc-921d26c867e7</Id>
          <ParameterType i:nil="true" />
        </FilterParameter>
        <FilterParameter>
          <Description>sample string 2</Description>
          <Id>705655c7-9b6a-4ed1-8afc-921d26c867e7</Id>
          <ParameterType i:nil="true" />
        </FilterParameter>
      </Parameters>
      <ParentId>633a5a79-ec17-413e-b847-81b3486c7362</ParentId>
    </Filter>
  </Filters>
</FiltersForSession>