POST {version}/GetFilterOptionDefinitions

Get Filter Option Definitions

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

None.

Response Information

Resource Description

List of Filter Option Definitions

Collection of FilterOptionDefinition

Name	Type	Additional information
Id	globally unique identifier	None.
Group	string	None.
Label	string	None.
Order	integer	None.
SubOptions	Collection of FilterOptionDefinitionSubOption	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "e397bc98-4b11-4173-99ed-f04442ebe210",
    "Group": "sample string 2",
    "Label": "sample string 3",
    "Order": 4,
    "SubOptions": [
      {
        "Id": "c6d87fc6-dc2e-4f9e-8ec2-e3d75488d6f6",
        "DefId": "23646f8f-18cb-420b-9d77-d78e8bd45604",
        "Type": "sample string 3",
        "Text": "sample string 4",
        "SelectedValue": "sample string 5",
        "Order": 6
      },
      {
        "Id": "c6d87fc6-dc2e-4f9e-8ec2-e3d75488d6f6",
        "DefId": "23646f8f-18cb-420b-9d77-d78e8bd45604",
        "Type": "sample string 3",
        "Text": "sample string 4",
        "SelectedValue": "sample string 5",
        "Order": 6
      }
    ]
  },
  {
    "Id": "e397bc98-4b11-4173-99ed-f04442ebe210",
    "Group": "sample string 2",
    "Label": "sample string 3",
    "Order": 4,
    "SubOptions": [
      {
        "Id": "c6d87fc6-dc2e-4f9e-8ec2-e3d75488d6f6",
        "DefId": "23646f8f-18cb-420b-9d77-d78e8bd45604",
        "Type": "sample string 3",
        "Text": "sample string 4",
        "SelectedValue": "sample string 5",
        "Order": 6
      },
      {
        "Id": "c6d87fc6-dc2e-4f9e-8ec2-e3d75488d6f6",
        "DefId": "23646f8f-18cb-420b-9d77-d78e8bd45604",
        "Type": "sample string 3",
        "Text": "sample string 4",
        "SelectedValue": "sample string 5",
        "Order": 6
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfFilterOptionDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact">
  <FilterOptionDefinition>
    <Group>sample string 2</Group>
    <Id>e397bc98-4b11-4173-99ed-f04442ebe210</Id>
    <Label>sample string 3</Label>
    <Order>4</Order>
    <SubOptions>
      <FilterOptionDefinitionSubOption>
        <DefId>23646f8f-18cb-420b-9d77-d78e8bd45604</DefId>
        <Id>c6d87fc6-dc2e-4f9e-8ec2-e3d75488d6f6</Id>
        <Order>6</Order>
        <SelectedValue>sample string 5</SelectedValue>
        <Text>sample string 4</Text>
        <Type>sample string 3</Type>
      </FilterOptionDefinitionSubOption>
      <FilterOptionDefinitionSubOption>
        <DefId>23646f8f-18cb-420b-9d77-d78e8bd45604</DefId>
        <Id>c6d87fc6-dc2e-4f9e-8ec2-e3d75488d6f6</Id>
        <Order>6</Order>
        <SelectedValue>sample string 5</SelectedValue>
        <Text>sample string 4</Text>
        <Type>sample string 3</Type>
      </FilterOptionDefinitionSubOption>
    </SubOptions>
  </FilterOptionDefinition>
  <FilterOptionDefinition>
    <Group>sample string 2</Group>
    <Id>e397bc98-4b11-4173-99ed-f04442ebe210</Id>
    <Label>sample string 3</Label>
    <Order>4</Order>
    <SubOptions>
      <FilterOptionDefinitionSubOption>
        <DefId>23646f8f-18cb-420b-9d77-d78e8bd45604</DefId>
        <Id>c6d87fc6-dc2e-4f9e-8ec2-e3d75488d6f6</Id>
        <Order>6</Order>
        <SelectedValue>sample string 5</SelectedValue>
        <Text>sample string 4</Text>
        <Type>sample string 3</Type>
      </FilterOptionDefinitionSubOption>
      <FilterOptionDefinitionSubOption>
        <DefId>23646f8f-18cb-420b-9d77-d78e8bd45604</DefId>
        <Id>c6d87fc6-dc2e-4f9e-8ec2-e3d75488d6f6</Id>
        <Order>6</Order>
        <SelectedValue>sample string 5</SelectedValue>
        <Text>sample string 4</Text>
        <Type>sample string 3</Type>
      </FilterOptionDefinitionSubOption>
    </SubOptions>
  </FilterOptionDefinition>
</ArrayOfFilterOptionDefinition>