Jump to

• Request
• Response

Update Localized Column Labels of an Inherited Configured Field

put

/api/restapi/configuredField/label

Send a request to this endpoint to update the localized column labels of a configured field in an inherited workspace.
Configured fields for Document, Program, Idea, and Strategy are not supported.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityColumnDefinitionLabelInput

Type: object

Title: ApiEntityColumnDefinitionLabelInput

This entity represents a ColumnDefinitionLabel object, a unique ColumnDefinitionLabel object can be identified by the following combinations of the fields.

• columnDefinitionId,inheritedWorkspaceId
• columnDefinitionId,inheritedWorkspaceCode
• viewColumnName,owningWorkspaceId,inheritedWorkspaceId
• viewColumnName,owningWorkspaceId,inheritedWorkspaceCode
• viewColumnName,owningWorkspaceCode,inheritedWorkspaceId
• viewColumnName,owningWorkspaceCode,inheritedWorkspaceCode

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.
• flexObject(required): string
  Allowed Values: [ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "FUND", "PORTFOLIO", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ]

  Flex Object to be saved.
• inheritedWorkspaceCode: string
  The user-specified identifier for the inherited workspace where the localized column label of the configured field needs to be updated.
• inheritedWorkspaceId(required): integer (int64)
  The system-generated identifier for the inherited workspace where the localized column label of the configured field needs to be updated.
• 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.
• owningWorkspaceCode: string
  The user-specified identifier of the workspace that currently owns the configured field.
• owningWorkspaceId: integer (int64)
  The system-generated identifier of the workspace that currently owns the configured field.
• viewColumnName(required): string
  Minimum Length: 1

  Maximum Length: 100

  The view column name of a configured field.

{
    "title":"ApiEntityColumnDefinitionLabelInput",
    "required":[
        "flexObject",
        "inheritedWorkspaceId",
        "viewColumnName"
    ],
    "type":"object",
    "properties":{
        "inheritedWorkspaceCode":{
            "type":"string",
            "description":"The user-specified identifier for the inherited workspace where the localized column label of the configured field needs to be updated.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "inheritedWorkspaceId":{
            "type":"integer",
            "description":"The system-generated identifier for the inherited workspace where the localized column label of the configured field needs to be updated.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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",
                "FUND",
                "PORTFOLIO",
                "PROGRAM_BUDGET",
                "PROGRAM_BUDGET_CHANGES",
                "PROGRAM_BUDGET_TRANSACTIONS",
                "PROGRAM_BUDGET_TRANSFERS",
                "PROJECT",
                "PROJECT_ACTUALS",
                "PROJECT_COST_SHEET",
                "RISK",
                "SCOPE_ITEM",
                "SCOPE_ITEM_ASSIGNMENT",
                "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"
            ]
        },
        "owningWorkspaceId":{
            "type":"integer",
            "description":"The system-generated identifier of the workspace that currently owns the configured field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "owningWorkspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of the workspace that currently owns the configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        }
    },
    "description":"This entity represents a ColumnDefinitionLabel object, a unique ColumnDefinitionLabel object can be identified by the following combinations of the fields.<ul><li>columnDefinitionId,inheritedWorkspaceId</li><li>columnDefinitionId,inheritedWorkspaceCode</li><li>viewColumnName,owningWorkspaceId,inheritedWorkspaceId</li><li>viewColumnName,owningWorkspaceId,inheritedWorkspaceCode</li><li>viewColumnName,owningWorkspaceCode,inheritedWorkspaceId</li><li>viewColumnName,owningWorkspaceCode,inheritedWorkspaceCode</li>",
    "exampleSetFlag":false
}

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 : 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":{
        "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"
            ]
        },
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

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