GET api/workplan/fields?HideSystem={HideSystem}
Get plan level fields
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| HideSystem | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of PlannerColumn| Name | Description | Type | Additional information |
|---|---|---|---|
| Order | integer |
None. |
|
| InternalName | string |
None. |
|
| Baseline | string |
None. |
|
| DisplayName | string |
None. |
|
| ColumnType | ColumnTypeEnum |
None. |
|
| ColumnAggregate | ColumnAggEnum |
None. |
|
| Choices | Dictionary of string [key] and string [value] |
None. |
|
| ChoiceParents | Dictionary of string [key] and string [value] |
None. |
|
| NumericValues | Dictionary of string [key] and decimal number [value] |
None. |
|
| ParentFilterField | string |
None. |
|
| Locked | boolean |
None. |
|
| ReadOnly | boolean |
None. |
|
| Required | boolean |
None. |
|
| Percentage | boolean |
None. |
|
| DefaultValue | string |
None. |
|
| AllowAdditions | boolean |
None. |
|
| WriteablePlanTypes | Collection of globally unique identifier |
None. |
|
| PlanTypeId | globally unique identifier |
None. |
|
| Decimals | integer |
None. |
|
| Function | FieldFunction |
None. |
|
| RollupWorkType | globally unique identifier |
None. |
|
| RollupAggregate | ColumnAggEnum |
None. |
|
| RollupLookupField | string |
None. |
|
| RollupField | string |
None. |
|
| RollupFilter | string |
None. |
|
| MinValue | decimal number |
None. |
|
| MaxValue | decimal number |
None. |
|
| Description | string |
None. |
|
| AIEnabled | boolean |
None. |
|
| AIUseForPlanCreation | boolean |
None. |
|
| AICustomPrompt | string |
None. |
|
| Filter | TableFilter |
None. |
|
| Hidden | boolean |
None. |
|
| ShowInQuickStart | boolean |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.