POST {version}/SaveContactFilter
Save Contact Filter
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
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. |
Request Formats
application/json, text/json
Sample:
{ "Id": "76ae4d5d-8462-447b-90ea-0dd159fbf0fd", "Name": "sample string 2", "ExpressionId": "ae590d09-5111-4cad-b087-b202c75e7659", "Description": "sample string 3", "Internal": true, "Inactive": true, "CreatedOn": "10/16/2024", "UpdatedOn": "10/16/2024", "LastModifiedOn": "10/16/2024", "ToBeDeleted": true, "SubOptions": [ { "Id": "c8b5c149-a14c-4d6f-9f48-135d667472b2", "DefId": "789080cb-14ea-4035-a4bd-d7aebb501951", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 }, { "Id": "c8b5c149-a14c-4d6f-9f48-135d667472b2", "DefId": "789080cb-14ea-4035-a4bd-d7aebb501951", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 } ], "Columns": [ { "Id": "28455f7a-e903-4b01-b0be-a567698e7a7f", "FilterId": "89906679-7376-4d89-8d6b-654d13c4b7ad", "ColumnId": "f3cde9fd-3c7a-442f-b3da-f4826427e2d3", "Order": 4, "DynamicId": "sample string 5" }, { "Id": "28455f7a-e903-4b01-b0be-a567698e7a7f", "FilterId": "89906679-7376-4d89-8d6b-654d13c4b7ad", "ColumnId": "f3cde9fd-3c7a-442f-b3da-f4826427e2d3", "Order": 4, "DynamicId": "sample string 5" } ], "DataFilter": "sample string 8", "SortCol": "sample string 9", "SortAsc": true }
application/xml, text/xml
Sample:
<Filter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact"> <Columns> <FilterColumnAssociation> <ColumnId>f3cde9fd-3c7a-442f-b3da-f4826427e2d3</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>89906679-7376-4d89-8d6b-654d13c4b7ad</FilterId> <Id>28455f7a-e903-4b01-b0be-a567698e7a7f</Id> <Order>4</Order> </FilterColumnAssociation> <FilterColumnAssociation> <ColumnId>f3cde9fd-3c7a-442f-b3da-f4826427e2d3</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>89906679-7376-4d89-8d6b-654d13c4b7ad</FilterId> <Id>28455f7a-e903-4b01-b0be-a567698e7a7f</Id> <Order>4</Order> </FilterColumnAssociation> </Columns> <CreatedOn>2024-10-16T12:18:00.3911195-04:00</CreatedOn> <DataFilter>sample string 8</DataFilter> <Description>sample string 3</Description> <ExpressionId>ae590d09-5111-4cad-b087-b202c75e7659</ExpressionId> <Id>76ae4d5d-8462-447b-90ea-0dd159fbf0fd</Id> <Inactive>true</Inactive> <Internal>true</Internal> <Name>sample string 2</Name> <SortAsc>true</SortAsc> <SortCol>sample string 9</SortCol> <SubOptions> <FilterOptionDefinitionSubOption> <DefId>789080cb-14ea-4035-a4bd-d7aebb501951</DefId> <Id>c8b5c149-a14c-4d6f-9f48-135d667472b2</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> <FilterOptionDefinitionSubOption> <DefId>789080cb-14ea-4035-a4bd-d7aebb501951</DefId> <Id>c8b5c149-a14c-4d6f-9f48-135d667472b2</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:18:00.3911195-04:00</UpdatedOn> </Filter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
v
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": "d31a736e-a7b0-4754-83fb-79fe1d73ee78", "Name": "sample string 2", "ExpressionId": "31690bf2-03dc-47a5-9383-82015f3c6326", "Description": "sample string 3", "Internal": true, "Inactive": true, "CreatedOn": "10/16/2024", "UpdatedOn": "10/16/2024", "LastModifiedOn": "10/16/2024", "ToBeDeleted": true, "SubOptions": [ { "Id": "380b4438-a671-4b05-a8bd-7be2029e1212", "DefId": "c7695bbd-7f11-4686-90ae-19c4ca8d782f", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 }, { "Id": "380b4438-a671-4b05-a8bd-7be2029e1212", "DefId": "c7695bbd-7f11-4686-90ae-19c4ca8d782f", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 } ], "Columns": [ { "Id": "370129d0-ce16-4d6d-a676-71c319d7ac48", "FilterId": "72c27451-728d-45c1-bdb6-6e0be34f81fb", "ColumnId": "332e5792-319f-4940-a83c-5fb87e76e872", "Order": 4, "DynamicId": "sample string 5" }, { "Id": "370129d0-ce16-4d6d-a676-71c319d7ac48", "FilterId": "72c27451-728d-45c1-bdb6-6e0be34f81fb", "ColumnId": "332e5792-319f-4940-a83c-5fb87e76e872", "Order": 4, "DynamicId": "sample string 5" } ], "DataFilter": "sample string 8", "SortCol": "sample string 9", "SortAsc": true }
application/xml, text/xml
Sample:
<Filter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact"> <Columns> <FilterColumnAssociation> <ColumnId>332e5792-319f-4940-a83c-5fb87e76e872</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>72c27451-728d-45c1-bdb6-6e0be34f81fb</FilterId> <Id>370129d0-ce16-4d6d-a676-71c319d7ac48</Id> <Order>4</Order> </FilterColumnAssociation> <FilterColumnAssociation> <ColumnId>332e5792-319f-4940-a83c-5fb87e76e872</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>72c27451-728d-45c1-bdb6-6e0be34f81fb</FilterId> <Id>370129d0-ce16-4d6d-a676-71c319d7ac48</Id> <Order>4</Order> </FilterColumnAssociation> </Columns> <CreatedOn>2024-10-16T12:18:00.3911195-04:00</CreatedOn> <DataFilter>sample string 8</DataFilter> <Description>sample string 3</Description> <ExpressionId>31690bf2-03dc-47a5-9383-82015f3c6326</ExpressionId> <Id>d31a736e-a7b0-4754-83fb-79fe1d73ee78</Id> <Inactive>true</Inactive> <Internal>true</Internal> <Name>sample string 2</Name> <SortAsc>true</SortAsc> <SortCol>sample string 9</SortCol> <SubOptions> <FilterOptionDefinitionSubOption> <DefId>c7695bbd-7f11-4686-90ae-19c4ca8d782f</DefId> <Id>380b4438-a671-4b05-a8bd-7be2029e1212</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> <FilterOptionDefinitionSubOption> <DefId>c7695bbd-7f11-4686-90ae-19c4ca8d782f</DefId> <Id>380b4438-a671-4b05-a8bd-7be2029e1212</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:18:00.3911195-04:00</UpdatedOn> </Filter>