POST api/Collection/CreateCollection

Deprecated endpoint. It will be removed in the upcoming versions.

Request Information

URI Parameters

None.

Body Parameters

CollectionData
NameDescriptionTypeAdditional information
Name

Collection name

string

None.

Parent

Parent value ID

integer

None.

ItemIds

List of Items Ids in this collection

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "parent": 2,
  "itemIds": [
    1,
    2
  ]
}

Response Information

Resource Description

IndexedTagValues
NameDescriptionTypeAdditional information
Values

Tag values

Collection of IndexedTagValueWeb

None.

Path

Array of parent tag values, where the first element is the parent located at the root level and the last element is the immediate current parent.

Collection of IndexedTagValueWeb

None.

Tag

An object containing information about the tag where the search is performed

IndexedTag

None.

TotalCount

Number of elements in the list

integer

None.

Error

Error description

string

None.

Success

Flag of successful operation

boolean

None.

ErrorCode

Error code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "values": [
    {
      "text": "sample string 1",
      "ancestors": "sample string 2",
      "id": 3,
      "isSelected": true,
      "isDefaultValue": true,
      "hasTagLinks": true,
      "tagId": 7,
      "isApproved": true,
      "rawValue": {},
      "tagName": "sample string 10",
      "itemsCount": 11,
      "location": "sample string 12",
      "hasChilds": true,
      "count": 14
    },
    {
      "text": "sample string 1",
      "ancestors": "sample string 2",
      "id": 3,
      "isSelected": true,
      "isDefaultValue": true,
      "hasTagLinks": true,
      "tagId": 7,
      "isApproved": true,
      "rawValue": {},
      "tagName": "sample string 10",
      "itemsCount": 11,
      "location": "sample string 12",
      "hasChilds": true,
      "count": 14
    }
  ],
  "path": [
    {
      "text": "sample string 1",
      "ancestors": "sample string 2",
      "id": 3,
      "isSelected": true,
      "isDefaultValue": true,
      "hasTagLinks": true,
      "tagId": 7,
      "isApproved": true,
      "rawValue": {},
      "tagName": "sample string 10",
      "itemsCount": 11,
      "location": "sample string 12",
      "hasChilds": true,
      "count": 14
    },
    {
      "text": "sample string 1",
      "ancestors": "sample string 2",
      "id": 3,
      "isSelected": true,
      "isDefaultValue": true,
      "hasTagLinks": true,
      "tagId": 7,
      "isApproved": true,
      "rawValue": {},
      "tagName": "sample string 10",
      "itemsCount": 11,
      "location": "sample string 12",
      "hasChilds": true,
      "count": 14
    }
  ],
  "tag": {
    "isAllowAssign": true,
    "maxHierarchy": 2,
    "strongHierarchy": true,
    "isMultiplyValues": true,
    "allowSearch": true,
    "customTag": "sample string 6",
    "id": 7,
    "indexed": true,
    "guid": "ce62cf7f-9543-4123-bfd6-b47454114298",
    "locked": true,
    "name": "sample string 11",
    "originName": "sample string 12",
    "readOnly": true,
    "dataType": "sample string 14"
  },
  "totalCount": 1,
  "error": "sample string 2",
  "success": true,
  "errorCode": 4
}

Parameter Information

data

Collection properties

Property Description
Name (String)
Collection name
Parent (Int64)
Parent value ID
ItemIds (Int64[])
List of Items Ids in this collection