GET api/teams/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
Name | Description | Type | Additional 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 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": "d9b441ba-ef6e-4185-946b-57f74872712f", "Text": "sample string 2", "Name": "sample string 2", "HasChildren": true, "Ordinal": 1.1, "EnumNodes": [ { "$id": "1", "Id": "600f0a7b-02cc-4547-a21d-6876d1ab8a30", "Text": "sample string 2", "Name": "sample string 2" }, { "$ref": "1" } ] }, { "Id": "d9b441ba-ef6e-4185-946b-57f74872712f", "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.