Api Home > Enum > GetList

GET api/V3/Enum/GetList?id={id}&itemFilter={itemFilter}&Flatten={Flatten}&itemFilterIds={itemFilterIds} GetList retrieves the children of an enumeration class id that is a parent. Returns items that are only one level down from the root id that is sent.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Guid of the enumeration class

globally unique identifier

Required

itemFilter

Optional Filter Text

string

Default value is

Flatten

Whether to Flatten the display names

string

Default value is false

itemFilterIds

Used when we want to limit enum selection. A comma-separated list of enum Guid.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of EnumNodeTreeModel
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Text

string

None.

Name

string

None.

HasChildren

boolean

None.

Ordinal

decimal number

None.

EnumNodes

Collection of EnumNode

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "919a5610-163e-4de1-9351-c3463ef1e55f",
    "Text": "sample string 2",
    "Name": "sample string 2",
    "HasChildren": true,
    "Ordinal": 1.1,
    "EnumNodes": [
      {
        "$id": "1",
        "Id": "63bed86c-4a13-4ef3-ba11-8be00c01d4c2",
        "Text": "sample string 2",
        "Name": "sample string 2"
      },
      {
        "$ref": "1"
      }
    ]
  },
  {
    "Id": "919a5610-163e-4de1-9351-c3463ef1e55f",
    "Text": "sample string 2",
    "Name": "sample string 2",
    "HasChildren": true,
    "Ordinal": 1.1,
    "EnumNodes": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ]
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.