POST api/Collection/RenameCollection

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

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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": "1b3c34e8-34c5-4ba3-a399-21f7fe591dc1",
    "supportFts": true,
    "locked": true,
    "name": "sample string 12",
    "originName": "sample string 13",
    "readOnly": true,
    "dataType": "sample string 15"
  },
  "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