POST {version}/ManipulateTags

Add/Remove Tags to Entities

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

FilterTag
NameDescriptionTypeAdditional information
FilterId

globally unique identifier

None.

EntityIds

string

None.

TagIds

string

None.

ToBeAdded

boolean

None.

RandomPick

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "FilterId": "53e97e67-aa7c-4cc1-adcf-5a2d3170ce59",
  "EntityIds": "sample string 1",
  "TagIds": "sample string 2",
  "ToBeAdded": true,
  "RandomPick": 1
}

application/xml, text/xml

Sample:
<FilterTag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact">
  <EntityIds>sample string 1</EntityIds>
  <FilterId>53e97e67-aa7c-4cc1-adcf-5a2d3170ce59</FilterId>
  <RandomPick>1</RandomPick>
  <TagIds>sample string 2</TagIds>
  <ToBeAdded>true</ToBeAdded>
</FilterTag>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

count of entities impacted

Result
NameDescriptionTypeAdditional information
Count

integer

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Count": 1,
  "Success": true
}

application/xml, text/xml

Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <Count>1</Count>
  <Success>true</Success>
</Result>