POST {version}/DeleteContactFilter

Delete Contact Filter

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

Filter
NameDescriptionTypeAdditional 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": "a0ef7c77-5903-428a-8b4a-164875712e2d",
  "Name": "sample string 2",
  "ExpressionId": "61313bf9-f749-4480-9e3c-08fe8198f3d7",
  "Description": "sample string 3",
  "Internal": true,
  "Inactive": true,
  "CreatedOn": "10/16/2024",
  "UpdatedOn": "10/16/2024",
  "LastModifiedOn": "10/16/2024",
  "ToBeDeleted": true,
  "SubOptions": [
    {
      "Id": "dba87bb8-9c6f-4ccb-848c-5cde01409a88",
      "DefId": "a7b4fb99-2a65-4f41-bf82-66e6cbf55971",
      "Type": "sample string 3",
      "Text": "sample string 4",
      "SelectedValue": "sample string 5",
      "Order": 6
    },
    {
      "Id": "dba87bb8-9c6f-4ccb-848c-5cde01409a88",
      "DefId": "a7b4fb99-2a65-4f41-bf82-66e6cbf55971",
      "Type": "sample string 3",
      "Text": "sample string 4",
      "SelectedValue": "sample string 5",
      "Order": 6
    }
  ],
  "Columns": [
    {
      "Id": "3a820dd2-03b7-447e-9754-6d9120c63edf",
      "FilterId": "45e7298e-95ae-4e56-8db1-06c0ab73936b",
      "ColumnId": "54020a20-26f2-4924-aa6c-c0b7102e5b7d",
      "Order": 4,
      "DynamicId": "sample string 5"
    },
    {
      "Id": "3a820dd2-03b7-447e-9754-6d9120c63edf",
      "FilterId": "45e7298e-95ae-4e56-8db1-06c0ab73936b",
      "ColumnId": "54020a20-26f2-4924-aa6c-c0b7102e5b7d",
      "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>54020a20-26f2-4924-aa6c-c0b7102e5b7d</ColumnId>
      <DynamicId>sample string 5</DynamicId>
      <FilterId>45e7298e-95ae-4e56-8db1-06c0ab73936b</FilterId>
      <Id>3a820dd2-03b7-447e-9754-6d9120c63edf</Id>
      <Order>4</Order>
    </FilterColumnAssociation>
    <FilterColumnAssociation>
      <ColumnId>54020a20-26f2-4924-aa6c-c0b7102e5b7d</ColumnId>
      <DynamicId>sample string 5</DynamicId>
      <FilterId>45e7298e-95ae-4e56-8db1-06c0ab73936b</FilterId>
      <Id>3a820dd2-03b7-447e-9754-6d9120c63edf</Id>
      <Order>4</Order>
    </FilterColumnAssociation>
  </Columns>
  <CreatedOn>2024-10-16T12:25:03.282612-04:00</CreatedOn>
  <DataFilter>sample string 8</DataFilter>
  <Description>sample string 3</Description>
  <ExpressionId>61313bf9-f749-4480-9e3c-08fe8198f3d7</ExpressionId>
  <Id>a0ef7c77-5903-428a-8b4a-164875712e2d</Id>
  <Inactive>true</Inactive>
  <Internal>true</Internal>
  <Name>sample string 2</Name>
  <SortAsc>true</SortAsc>
  <SortCol>sample string 9</SortCol>
  <SubOptions>
    <FilterOptionDefinitionSubOption>
      <DefId>a7b4fb99-2a65-4f41-bf82-66e6cbf55971</DefId>
      <Id>dba87bb8-9c6f-4ccb-848c-5cde01409a88</Id>
      <Order>6</Order>
      <SelectedValue>sample string 5</SelectedValue>
      <Text>sample string 4</Text>
      <Type>sample string 3</Type>
    </FilterOptionDefinitionSubOption>
    <FilterOptionDefinitionSubOption>
      <DefId>a7b4fb99-2a65-4f41-bf82-66e6cbf55971</DefId>
      <Id>dba87bb8-9c6f-4ccb-848c-5cde01409a88</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:03.282612-04:00</UpdatedOn>
</Filter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.