GET api/V3/Enum/GetList?id={id}&parentId={parentId}&itemFilter={itemFilter}&Flatten={Flatten} GetList retrieves the children of an enumeration class id that is a child. Used for lazy loading of the enum picker. 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 child enumeration. |
globally unique identifier |
Required |
parentId |
The Guid of the parent enumeration. |
globally unique identifier |
Required |
itemFilter |
Optional Filter Text |
string |
Default value is |
Flatten |
Whether to Flatten the display names |
string |
Default value is false |
Body Parameters
None.Response Information
Resource Description
Collection of EnumNodeTreeModelName | Description | 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": "4498bac6-233f-44ee-aaab-5463d7989e5a", "Text": "sample string 2", "Name": "sample string 2", "HasChildren": true, "Ordinal": 1.1, "EnumNodes": [ { "$id": "1", "Id": "bcfc3158-b4aa-4c00-b788-05d7c9ee8954", "Text": "sample string 2", "Name": "sample string 2" }, { "$ref": "1" } ] }, { "Id": "4498bac6-233f-44ee-aaab-5463d7989e5a", "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.