Jump to

• Request
• Response

View a Configured Field

get

/api/restapi/configuredField/{columnDefinitionId}

This endpoint returns configured fields that meet the following requirements:

• The object has an ID that matches the value of the {columnDefinitionId} path parameter.

Request

Path Parameters

• columnDefinitionId(required): integer(int64)
  The system-generated identifier of a configured field.

Query Parameters

• objectType: string
  This is a required field for PROGRAM, IDEA, STRATEGY and DOCUMENT object types and optional for other object types.

  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" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityColumnDefinition

Type: object

Title: ApiEntityColumnDefinition

Show Source

• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the configured field and the workspace. Possible values are Owned and Inherited.
• 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: 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: 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: string
  Minimum Length: 1

  Maximum Length: 100

  The label of a configured field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.
• viewColumnName: 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: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityColumnDefinition",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "listValues":{
            "type":"array",
            "description":"The list of available values for a List type configured field.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFlexListValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "label":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The label of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ENABLED",
                "UPDATED",
                "DISABLED",
                "DELETED",
                "PENDING",
                "FAILED"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the configured field and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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/ApiEntityColumnDefinitionLocalization",
                "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"
            ]
        },
        "physicalType":{
            "type":"string",
            "description":"The physical percent complete of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DATE",
                "NUMBER",
                "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"
            ]
        },
        "viewColumnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The view column name of a configured field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "restricted":{
            "type":"boolean",
            "description":"The field to make a configured field restricted.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : listValues

Type: array

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

Show Source

• Array of: object ApiEntityFlexListValue
  Title: ApiEntityFlexListValue

{
    "type":"array",
    "description":"The list of available values for a List type configured field.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFlexListValue",
        "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 ApiEntityColumnDefinitionLocalization
  Title: ApiEntityColumnDefinitionLocalization

{
    "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/ApiEntityColumnDefinitionLocalization",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityFlexListValue

Type: object

Title: ApiEntityFlexListValue

Show Source

• displayValue: string
  Minimum Length: 0

  Maximum Length: 255

  List display value for field of type list.
• legacyValue: string
  Maximum Length: 255

  Display value for field of type list.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFlexListValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "displayValue":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"List display value for field of type list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "legacyValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Display value 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/ApiEntityListValueNM",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : localizedListValues

Type: array

The unique identifier for the list value.

Show Source

• Array of: object ApiEntityListValueNM
  Title: ApiEntityListValueNM

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

Nested Schema : ApiEntityListValueNM

Type: object

Title: ApiEntityListValueNM

Show Source

• displayValue: string
  Minimum Length: 0

  Maximum Length: 255

  List display value for language code.
• languageCode: string
  Minimum Length: 0

  Maximum Length: 6

  Language code.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• listValueNMId: integer (int64)
  The unique identifier for the list value.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityListValueNM",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityColumnDefinitionLocalization

Type: object

Title: ApiEntityColumnDefinitionLocalization

Show Source

• columnDefinitionId: integer (int64)
  Unique identifier of the column.
• columnDefinitionLocalizationId: integer (int64)
  The unique identifier of a configured field locale label.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The localized label of a configured field.
• languageCode: 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityColumnDefinitionLocalization",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested configured field does not exist, or you do not have access to it.

Back to Top