GET api/Collection/GetCollections?parent={parent}&index={index}&pageSize={pageSize}

Get list of collections

Request Information

URI Parameters

NameDescriptionTypeAdditional information
parent

Collection Parent id. Use 0 as a parent to get all zero level based collections.

integer

Required

index

Page Index

integer

Required

pageSize

Page Size

integer

Required

Body Parameters

None.

Response Information

Resource Description

IndexedTagValues
NameDescriptionTypeAdditional information
Values

Values List

Collection of IndexedTagValue

None.

Path

Whole parent path for Catalog Tags supporting hierarchy

Collection of IndexedTagValue

None.

Tag

Catalog Tag description

IndexedTag

None.

TotalCount

Total number of items in the list

integer

None.

Error

Error description if the operation failed

string

None.

Success

Operation result

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": "e674e344-e572-4db8-8c3c-89f393ce5a52",
    "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
}
bool hasModels = Model.ParameterModels.Count > 0; if (hasModels) {

Parameter Information

}