Update a Configured Field
put
/api/restapi/configuredField
Send a request to this endpoint to update a configured field.
Request
Query Parameters
-
inheritedWorkspaceId: integer(int64)
The ID of the workspace where the configured field locale label change is needed. This is an optional parameter.
This is not applicable for PROGRAM, IDEA, STRATEGY, and DOCUMENT object types.
Supported Media Types
- application/json
Root Schema : ApiEntityColumnDefinitionInput
Type:
object
Title:
ApiEntityColumnDefinitionInput
This entity represents a ColumnDefinition object, a unique ColumnDefinition object can be identified by the following combinations of the fields.
Show Source
- columnDefinitionId
- flexObject,label,workspaceId
- flexObject,viewColumnName,workspaceId
- flexObject,label,workspaceCode
- flexObject,viewColumnName,workspaceCode
-
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
dataLength: integer
(int32)
Minimum Value:
0
Maximum Value:9999
The length of a configured field. Editable only for Text type fields. -
dataType(required): string
Allowed Values:
[ "FT_DATE", "FT_MONEY", "FT_MONEY_NO_MC", "FT_TEXT", "FT_INT", "FT_FLOAT_2_DECIMALS", "FT_LIST", "FT_BOOLEAN" ]
The data type of a configured field. -
flexObject(required): string
Allowed Values:
[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ]
Flex Object to be saved. -
flexType: string
Allowed Values:
[ "ACTIVITY", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "CAPITAL_PLAN_COST", "CAPITAL_PLAN_OTHER", "CAPITAL_PLAN_TEXT", "COMPANY", "CUSTOM_LOG", "DOCUMENT_COST", "DOCUMENT_OTHER", "DOCUMENT_TEXT", "FUND", "IDEA", "PORTFOLIO", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RESOURCE_ASSIGNMENT", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ]
The type of a flex object. -
label(required): string
Minimum Length:
1
Maximum Length:100
The label of a configured field. -
listValues: array
listValues
The list of available values for a List type configured field.
-
localizedColumnDefinitions: array
localizedColumnDefinitions
The list of column labels per locale for the configured field.
The configured field label you enter will be the default label for all locales. You can update the field label for each locale using the localizedColumnDefinitions. You will not need to re-enter the label for your locale in the array. -
physicalType: string
Allowed Values:
[ "DATE", "NUMBER", "STRING" ]
The physical percent complete of a configured field. -
restricted: boolean
The field to make a configured field restricted.
-
status: string
Allowed Values:
[ "ENABLED", "UPDATED", "DISABLED", "DELETED", "PENDING", "FAILED" ]
The status of a configured field. -
summaryCalculationType: string
Allowed Values:
[ "SUM", "AVERAGE", "MIN", "MAX", "FORMULA", "NONE", "MAX_NULL", "NULLABLE_SUM" ]
Specifies how the field should be calculated for a grouped row in a view. -
udfFormula: string
Maximum Length: 2,147,483,647
The formula of a configured field. -
udfType: string
Allowed Values:
[ "MANUAL", "FORMULA" ]
The type of a configured field. -
viewColumnName(required): string
Minimum Length:
1
Maximum Length:100
The view column name of a configured field. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : listValues
Type:
array
The list of available values for a List type configured field.
Show Source
-
Array of:
object ApiEntityFlexListValueInput
Title:
ApiEntityFlexListValueInput
Nested Schema : localizedColumnDefinitions
Type:
array
The list of column labels per locale for the configured field.
The configured field label you enter will be the default label for all locales. You can update the field label for each locale using the localizedColumnDefinitions. You will not need to re-enter the label for your locale in the array.
Show Source
The configured field label you enter will be the default label for all locales. You can update the field label for each locale using the localizedColumnDefinitions. You will not need to re-enter the label for your locale in the array.
-
Array of:
object ApiEntityColumnDefinitionLocalizationInput
Title:
ApiEntityColumnDefinitionLocalizationInput
Nested Schema : ApiEntityFlexListValueInput
Type:
object
Title:
Show Source
ApiEntityFlexListValueInput
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
displayValue: stringRead Only:true
Minimum Length:0
Maximum Length:255
Deprecated. As of 24.10, replaced by 'getListKey'.
List display value for field of type list. -
legacyValue: stringRead Only:true
Maximum Length:255
Deprecated. As of 24.10, replaced by 'getListKey'.
Display value for field of type list. -
listKey: string
Minimum Length:
0
Maximum Length:128
List key for field of type list. -
listValueId: integer
(int64)
The unique identifier for the list value.
-
localizedListValues: array
localizedListValues
The unique identifier for the list value.
Nested Schema : localizedListValues
Type:
array
The unique identifier for the list value.
Show Source
-
Array of:
object ApiEntityListValueNMInput
Title:
ApiEntityListValueNMInput
Nested Schema : ApiEntityListValueNMInput
Type:
object
Title:
Show Source
ApiEntityListValueNMInput
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
displayValue: string
Minimum Length:
0
Maximum Length:255
List display value for language code. -
languageCode: string
Minimum Length:
0
Maximum Length:6
Language code. -
listValueNMId: integer
(int64)
The unique identifier for the list value.
Nested Schema : ApiEntityColumnDefinitionLocalizationInput
Type:
object
Title:
Show Source
ApiEntityColumnDefinitionLocalizationInput
-
columnDefinitionId: integer
(int64)
Unique identifier of the column.
-
columnDefinitionLocalizationId: integer
(int64)
The unique identifier of a configured field locale label.
-
columnLabel(required): string
Minimum Length:
1
Maximum Length:100
The localized label of a configured field. -
languageCode(required): string
Maximum Length:
6
Allowed Values:[ "en", "es", "de", "ja", "zh_CN", "zh_TW", "pt_BR", "fr", "ru", "it", "ko", "nl" ]
The language code for the locale.
Examples
Back to Top
Response
204 Response
Successful operation with no content.
400 Response
Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request.