POST {version}/GetContactFilters
Get Contact Filters
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of Contact Filters
Collection of FilterName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
ExpressionId | globally unique identifier |
None. |
|
Description | string |
None. |
|
Internal | boolean |
None. |
|
Inactive | boolean |
None. |
|
CreatedOn | date |
None. |
|
UpdatedOn | date |
None. |
|
LastModifiedOn | date |
None. |
|
ToBeDeleted | boolean |
None. |
|
SubOptions | Collection of FilterOptionDefinitionSubOption |
None. |
|
Columns | Collection of FilterColumnAssociation |
None. |
|
DataFilter | string |
None. |
|
SortCol | string |
None. |
|
SortAsc | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "a90a0679-10a4-488a-a8b5-e10a2f6dcb11", "Name": "sample string 2", "ExpressionId": "e7259804-c5a0-4517-9af4-16b22cd79422", "Description": "sample string 3", "Internal": true, "Inactive": true, "CreatedOn": "10/16/2024", "UpdatedOn": "10/16/2024", "LastModifiedOn": "10/16/2024", "ToBeDeleted": true, "SubOptions": [ { "Id": "817fbebd-3f58-4955-b96a-393a36551a9f", "DefId": "43dd2b7f-0555-4c6b-8c4a-fe9bdb4040bf", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 }, { "Id": "817fbebd-3f58-4955-b96a-393a36551a9f", "DefId": "43dd2b7f-0555-4c6b-8c4a-fe9bdb4040bf", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 } ], "Columns": [ { "Id": "d7e4ae10-268e-41cd-b0b8-9361d49e2bd3", "FilterId": "35025ca4-4e68-4dcd-ad0d-c869a6c855c3", "ColumnId": "544c0fb8-443c-4c65-babc-c4d66ebaa67c", "Order": 4, "DynamicId": "sample string 5" }, { "Id": "d7e4ae10-268e-41cd-b0b8-9361d49e2bd3", "FilterId": "35025ca4-4e68-4dcd-ad0d-c869a6c855c3", "ColumnId": "544c0fb8-443c-4c65-babc-c4d66ebaa67c", "Order": 4, "DynamicId": "sample string 5" } ], "DataFilter": "sample string 8", "SortCol": "sample string 9", "SortAsc": true }, { "Id": "a90a0679-10a4-488a-a8b5-e10a2f6dcb11", "Name": "sample string 2", "ExpressionId": "e7259804-c5a0-4517-9af4-16b22cd79422", "Description": "sample string 3", "Internal": true, "Inactive": true, "CreatedOn": "10/16/2024", "UpdatedOn": "10/16/2024", "LastModifiedOn": "10/16/2024", "ToBeDeleted": true, "SubOptions": [ { "Id": "817fbebd-3f58-4955-b96a-393a36551a9f", "DefId": "43dd2b7f-0555-4c6b-8c4a-fe9bdb4040bf", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 }, { "Id": "817fbebd-3f58-4955-b96a-393a36551a9f", "DefId": "43dd2b7f-0555-4c6b-8c4a-fe9bdb4040bf", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 } ], "Columns": [ { "Id": "d7e4ae10-268e-41cd-b0b8-9361d49e2bd3", "FilterId": "35025ca4-4e68-4dcd-ad0d-c869a6c855c3", "ColumnId": "544c0fb8-443c-4c65-babc-c4d66ebaa67c", "Order": 4, "DynamicId": "sample string 5" }, { "Id": "d7e4ae10-268e-41cd-b0b8-9361d49e2bd3", "FilterId": "35025ca4-4e68-4dcd-ad0d-c869a6c855c3", "ColumnId": "544c0fb8-443c-4c65-babc-c4d66ebaa67c", "Order": 4, "DynamicId": "sample string 5" } ], "DataFilter": "sample string 8", "SortCol": "sample string 9", "SortAsc": true } ]
application/xml, text/xml
Sample:
<ArrayOfFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact"> <Filter> <Columns> <FilterColumnAssociation> <ColumnId>544c0fb8-443c-4c65-babc-c4d66ebaa67c</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>35025ca4-4e68-4dcd-ad0d-c869a6c855c3</FilterId> <Id>d7e4ae10-268e-41cd-b0b8-9361d49e2bd3</Id> <Order>4</Order> </FilterColumnAssociation> <FilterColumnAssociation> <ColumnId>544c0fb8-443c-4c65-babc-c4d66ebaa67c</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>35025ca4-4e68-4dcd-ad0d-c869a6c855c3</FilterId> <Id>d7e4ae10-268e-41cd-b0b8-9361d49e2bd3</Id> <Order>4</Order> </FilterColumnAssociation> </Columns> <CreatedOn>2024-10-16T12:25:51.7235088-04:00</CreatedOn> <DataFilter>sample string 8</DataFilter> <Description>sample string 3</Description> <ExpressionId>e7259804-c5a0-4517-9af4-16b22cd79422</ExpressionId> <Id>a90a0679-10a4-488a-a8b5-e10a2f6dcb11</Id> <Inactive>true</Inactive> <Internal>true</Internal> <Name>sample string 2</Name> <SortAsc>true</SortAsc> <SortCol>sample string 9</SortCol> <SubOptions> <FilterOptionDefinitionSubOption> <DefId>43dd2b7f-0555-4c6b-8c4a-fe9bdb4040bf</DefId> <Id>817fbebd-3f58-4955-b96a-393a36551a9f</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> <FilterOptionDefinitionSubOption> <DefId>43dd2b7f-0555-4c6b-8c4a-fe9bdb4040bf</DefId> <Id>817fbebd-3f58-4955-b96a-393a36551a9f</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> </SubOptions> <ToBeDeleted>true</ToBeDeleted> <UpdatedOn>2024-10-16T12:25:51.7235088-04:00</UpdatedOn> </Filter> <Filter> <Columns> <FilterColumnAssociation> <ColumnId>544c0fb8-443c-4c65-babc-c4d66ebaa67c</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>35025ca4-4e68-4dcd-ad0d-c869a6c855c3</FilterId> <Id>d7e4ae10-268e-41cd-b0b8-9361d49e2bd3</Id> <Order>4</Order> </FilterColumnAssociation> <FilterColumnAssociation> <ColumnId>544c0fb8-443c-4c65-babc-c4d66ebaa67c</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>35025ca4-4e68-4dcd-ad0d-c869a6c855c3</FilterId> <Id>d7e4ae10-268e-41cd-b0b8-9361d49e2bd3</Id> <Order>4</Order> </FilterColumnAssociation> </Columns> <CreatedOn>2024-10-16T12:25:51.7235088-04:00</CreatedOn> <DataFilter>sample string 8</DataFilter> <Description>sample string 3</Description> <ExpressionId>e7259804-c5a0-4517-9af4-16b22cd79422</ExpressionId> <Id>a90a0679-10a4-488a-a8b5-e10a2f6dcb11</Id> <Inactive>true</Inactive> <Internal>true</Internal> <Name>sample string 2</Name> <SortAsc>true</SortAsc> <SortCol>sample string 9</SortCol> <SubOptions> <FilterOptionDefinitionSubOption> <DefId>43dd2b7f-0555-4c6b-8c4a-fe9bdb4040bf</DefId> <Id>817fbebd-3f58-4955-b96a-393a36551a9f</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> <FilterOptionDefinitionSubOption> <DefId>43dd2b7f-0555-4c6b-8c4a-fe9bdb4040bf</DefId> <Id>817fbebd-3f58-4955-b96a-393a36551a9f</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> </SubOptions> <ToBeDeleted>true</ToBeDeleted> <UpdatedOn>2024-10-16T12:25:51.7235088-04:00</UpdatedOn> </Filter> </ArrayOfFilter>