GET api/teams/Enum/GetList?id={id}&itemFilter={itemFilter}&Flatten={Flatten}&itemFilterIds={itemFilterIds}

Api Home > Enum > GetList

GET api/teams/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

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

Name	Type	Additional 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": "0b8c9e6f-3eb9-43ab-a252-e2febfc848c6",
    "Text": "sample string 2",
    "Name": "sample string 2",
    "HasChildren": true,
    "Ordinal": 1.1,
    "EnumNodes": [
      {
        "$id": "1",
        "Id": "cd3ed016-7659-42d2-9721-689d62e1c282",
        "Text": "sample string 2",
        "Name": "sample string 2"
      },
      {
        "$ref": "1"
      }
    ]
  },
  {
    "Id": "0b8c9e6f-3eb9-43ab-a252-e2febfc848c6",
    "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.