POST {version}/QBManipulateTags

Add/Remove Tags to Entities

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

QBFilterTag
NameDescriptionTypeAdditional information
ToBeAdded

boolean

None.

GroupATagIds

string

None.

GroupBTagIds

string

None.

OperationType

string

None.

ExpressionId

globally unique identifier

None.

UserId

globally unique identifier

None.

TagIds

string

None.

RandomPick

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ToBeAdded": true,
  "GroupATagIds": "sample string 2",
  "GroupBTagIds": "sample string 3",
  "OperationType": "sample string 4",
  "ExpressionId": "6249c17c-7820-4cb6-86dc-b017571c3ce9",
  "UserId": "5a752832-989c-49f6-958c-8f7a55f02d5f",
  "TagIds": "sample string 7",
  "RandomPick": 1
}

application/xml, text/xml

Sample:
<QBFilterTag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.QueryBuilder">
  <ExpressionId>6249c17c-7820-4cb6-86dc-b017571c3ce9</ExpressionId>
  <GroupATagIds>sample string 2</GroupATagIds>
  <GroupBTagIds>sample string 3</GroupBTagIds>
  <OperationType>sample string 4</OperationType>
  <RandomPick>1</RandomPick>
  <TagIds>sample string 7</TagIds>
  <ToBeAdded>true</ToBeAdded>
  <UserId>5a752832-989c-49f6-958c-8f7a55f02d5f</UserId>
</QBFilterTag>

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>