Jump to

• Request
• Response

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

Request Body - 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.

• columnDefinitionId
• flexObject,label,workspaceId
• flexObject,viewColumnName,workspaceId
• flexObject,label,workspaceCode
• flexObject,viewColumnName,workspaceCode

Show Source

• 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.

{
    "title":"ApiEntityColumnDefinitionInput",
    "required":[
        "dataType",
        "flexObject",
        "label",
        "viewColumnName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "listValues":{
            "type":"array",
            "description":"The list of available values for a List type configured field.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFlexListValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ENABLED",
                "UPDATED",
                "DISABLED",
                "DELETED",
                "PENDING",
                "FAILED"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "summaryCalculationType":{
            "type":"string",
            "description":"Specifies how the field should be calculated for a grouped row in a view.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SUM",
                "AVERAGE",
                "MIN",
                "MAX",
                "FORMULA",
                "NONE",
                "MAX_NULL",
                "NULLABLE_SUM"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "localizedColumnDefinitions":{
            "type":"array",
            "description":"The list of column labels per locale for the configured field. <br />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.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityColumnDefinitionLocalizationInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "flexType":{
            "type":"string",
            "description":"The type of a flex object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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"
            ]
        },
        "label":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The label of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "udfType":{
            "type":"string",
            "description":"The type of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "FORMULA"
            ]
        },
        "dataType":{
            "type":"string",
            "description":"The data type of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FT_DATE",
                "FT_MONEY",
                "FT_MONEY_NO_MC",
                "FT_TEXT",
                "FT_INT",
                "FT_FLOAT_2_DECIMALS",
                "FT_LIST",
                "FT_BOOLEAN"
            ]
        },
        "physicalType":{
            "type":"string",
            "description":"The physical percent complete of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DATE",
                "NUMBER",
                "STRING"
            ]
        },
        "udfFormula":{
            "type":"string",
            "description":"Maximum Length: 2,147,483,647<br />The formula of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flexObject":{
            "type":"string",
            "description":"Flex Object to be saved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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"
            ]
        },
        "viewColumnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The view column name of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dataLength":{
            "maximum":9999,
            "minimum":0,
            "type":"integer",
            "description":"The length of a configured field. Editable only for Text type fields. ",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "restricted":{
            "type":"boolean",
            "description":"The field to make a configured field restricted.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ColumnDefinition object, a unique ColumnDefinition object can be identified by the following combinations of the fields.<ul><li>columnDefinitionId</li><li>flexObject,label,workspaceId</li><li>flexObject,viewColumnName,workspaceId</li><li>flexObject,label,workspaceCode</li><li>flexObject,viewColumnName,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : listValues

Type: array

The list of available values for a List type configured field.

Show Source

• Array of: object ApiEntityFlexListValueInput
  Title: ApiEntityFlexListValueInput

{
    "type":"array",
    "description":"The list of available values for a List type configured field.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFlexListValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

• Array of: object ApiEntityColumnDefinitionLocalizationInput
  Title: ApiEntityColumnDefinitionLocalizationInput

{
    "type":"array",
    "description":"The list of column labels per locale for the configured field. <br />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.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityColumnDefinitionLocalizationInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityFlexListValueInput

Type: object

Title: ApiEntityFlexListValueInput

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• displayValue: string
  Read 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: string
  Read 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.

{
    "title":"ApiEntityFlexListValueInput",
    "type":"object",
    "properties":{
        "listValueId":{
            "type":"integer",
            "description":"The unique identifier for the list value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "listKey":{
            "maxLength":128,
            "minLength":0,
            "type":"string",
            "description":"List key for field of type list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "localizedListValues":{
            "type":"array",
            "description":"The unique identifier for the list value.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityListValueNMInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "displayValue":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.10</i>,  replaced by <i>'getListKey'</i>.</br>List display value for field of type list.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "legacyValue":{
            "maxLength":255,
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.10</i>,  replaced by <i>'getListKey'</i>.</br>Display value for field of type list.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : localizedListValues

Type: array

The unique identifier for the list value.

Show Source

• Array of: object ApiEntityListValueNMInput
  Title: ApiEntityListValueNMInput

{
    "type":"array",
    "description":"The unique identifier for the list value.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityListValueNMInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityListValueNMInput

Type: object

Title: ApiEntityListValueNMInput

Show Source

• 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.

{
    "title":"ApiEntityListValueNMInput",
    "type":"object",
    "properties":{
        "listValueNMId":{
            "type":"integer",
            "description":"The unique identifier for the list value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "languageCode":{
            "maxLength":6,
            "minLength":0,
            "type":"string",
            "description":"Language code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "displayValue":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"List display value for language code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityColumnDefinitionLocalizationInput

Type: object

Title: ApiEntityColumnDefinitionLocalizationInput

Show Source

• 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.

{
    "title":"ApiEntityColumnDefinitionLocalizationInput",
    "required":[
        "columnLabel",
        "languageCode"
    ],
    "type":"object",
    "properties":{
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnDefinitionLocalizationId":{
            "type":"integer",
            "description":"The unique identifier of a configured field locale label.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "languageCode":{
            "maxLength":6,
            "type":"string",
            "description":"The language code for the locale.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "en",
                "es",
                "de",
                "ja",
                "zh_CN",
                "zh_TW",
                "pt_BR",
                "fr",
                "ru",
                "it",
                "ko",
                "nl"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The localized label of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Update a Configured Fields Using Column Definition ID

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.

Back to Top