POST v1/core/accounts/{accID}/domainfiltering/customfilters

Creates a custom filter.

Request Information

Parameters

Name	Description	Additional information
accID	No documentation available.	Define this parameter in the request URI.
expandedFilter		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "CategoryNumbers": {
    "sample string 1": [
      1,
      2,
      3
    ],
    "sample string 2": [
      1,
      2,
      3
    ],
    "sample string 3": [
      1,
      2,
      3
    ]
  },
  "NameMatches": [
    {
      "Pattern": "sample string 1",
      "MatchCondition": "EqualTo|NotEqualTo|MatchesSuffix|DoesNotMatchSuffix|MatchesRegEx|DoesNotMatchRegex"
    },
    {
      "Pattern": "sample string 1",
      "MatchCondition": "EqualTo|NotEqualTo|MatchesSuffix|DoesNotMatchSuffix|MatchesRegEx|DoesNotMatchRegex"
    },
    {
      "Pattern": "sample string 1",
      "MatchCondition": "EqualTo|NotEqualTo|MatchesSuffix|DoesNotMatchSuffix|MatchesRegEx|DoesNotMatchRegex"
    }
  ],
  "ID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Type": "Whitelist|Blacklist|Custom|System"
}

text/javascript

Sample:

{"CategoryNumbers":{"sample string 1":[1,2,3],"sample string 2":[1,2,3],"sample string 3":[1,2,3]},"NameMatches":[{"Pattern":"sample string 1","MatchCondition":0},{"Pattern":"sample string 1","MatchCondition":0},{"Pattern":"sample string 1","MatchCondition":0}],"ID":1,"Name":"sample string 2","Description":"sample string 3","Type":0}

application/xml, text/xml

Sample:

<ExpandedFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models.dnf">
  <Description>sample string 3</Description>
  <ID>1</ID>
  <Name>sample string 2</Name>
  <Type>Whitelist|Blacklist|Custom|System</Type>
  <CategoryNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:int>1</d2p1:int>
        <d2p1:int>2</d2p1:int>
        <d2p1:int>3</d2p1:int>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:int>1</d2p1:int>
        <d2p1:int>2</d2p1:int>
        <d2p1:int>3</d2p1:int>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>
        <d2p1:int>1</d2p1:int>
        <d2p1:int>2</d2p1:int>
        <d2p1:int>3</d2p1:int>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
  </CategoryNumbers>
  <NameMatches>
    <NameMatch>
      <MatchCondition>EqualTo|NotEqualTo|MatchesSuffix|DoesNotMatchSuffix|MatchesRegEx|DoesNotMatchRegex</MatchCondition>
      <Pattern>sample string 1</Pattern>
    </NameMatch>
    <NameMatch>
      <MatchCondition>EqualTo|NotEqualTo|MatchesSuffix|DoesNotMatchSuffix|MatchesRegEx|DoesNotMatchRegex</MatchCondition>
      <Pattern>sample string 1</Pattern>
    </NameMatch>
    <NameMatch>
      <MatchCondition>EqualTo|NotEqualTo|MatchesSuffix|DoesNotMatchSuffix|MatchesRegEx|DoesNotMatchRegex</MatchCondition>
      <Pattern>sample string 1</Pattern>
    </NameMatch>
  </NameMatches>
</ExpandedFilter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ExpandedFilter'.

application/bson

Sample:

�CategoryNumbers�sample string 1012sample string 2012sample string 3012NameMatches�06Patternsample string 1MatchCondition16Patternsample string 1MatchCondition26Patternsample string 1MatchConditionIDNamesample string 2Descriptionsample string 3Type

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "ID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Type": "Whitelist|Blacklist|Custom|System"
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:

{"Success":true,"Data":{"ID":1,"Name":"sample string 2","Description":"sample string 3","Type":0},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:

<PBNBReturnOfFilter76FemLeQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/pbnb_models.dnf">
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Type>Whitelist|Blacklist|Custom|System</d2p1:Type>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfFilter76FemLeQ>

application/bson

Sample:

�SuccessDataRIDNamesample string 2Descriptionsample string 3TypeErrorCodeErrorDescriptionsample string 3Metasample string 4