GET api/IndexedTagValues/GetIndexedTagValues?indexedTagId={indexedTagId}&parentValueId={parentValueId}&filter={filter}&pageIndex={pageIndex}&pageSize={pageSize}

Getting tag values

Request Information

URI Parameters

NameDescriptionTypeAdditional information
indexedTagId

ID of the tag which values should be found

integer

Required

parentValueId

Parameter to limit the search level. This parameter can take special values or tag value ID. The following special values are possible: 0 – searching for values only at the root level (the search of child values will not be performed in this case) -2 – throughout search (the search will be performed at the root level and among the child values) If the parameter sends the ID of any tag value that has child values, the search will be performed only among the child values of the first level.

integer

Required

filter

Case-insensitive search string to filter values. This parameter can take an empty value. If the string is filled in, only those values ​​will be found whose text representation contains the searched string.

string

Required

pageIndex

Page serial number. An integer from 0 to 2 147 483 647 (inclusive).

integer

Required

pageSize

Page size. A positive integer no greater than 2 147 483 647.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Result containing a list of values of the indexed tag

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": "04d7776f-b9b6-406a-8d24-1c3a4f0bad91",
    "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

filter

Property Description
Chars (Char)

				
Length (Int32)