Api Home > Enum > GetFlatList

GET api/V3/Enum/GetFlatList?id={id}&itemFilter={itemFilter}&includeParents={includeParents}&itemFilterIds={itemFilterIds} GetFlatList retrieves a flattened list of enumeration children. This is used for client side filtering of the enum picker autocomplete. This will only return the first 250 that match the filter. For example: A, A\B, A\B\C

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Guid of the parent enumeration.

globally unique identifier

Required

itemFilter

The text to filter by using contains.

string

Required

includeParents

Boolean on whether to include parent levels

boolean

Default value is True

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": "1ad056e2-937d-4efa-a6d6-eb672deda6e8",
    "Text": "sample string 2",
    "Name": "sample string 2",
    "HasChildren": true,
    "Ordinal": 1.1,
    "EnumNodes": [
      {
        "$id": "1",
        "Id": "3fe0bdc1-c920-4682-8197-11eb6ab6fbc2",
        "Text": "sample string 2",
        "Name": "sample string 2"
      },
      {
        "$ref": "1"
      }
    ]
  },
  {
    "Id": "1ad056e2-937d-4efa-a6d6-eb672deda6e8",
    "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.