Create a Configured Field
post
/primeapi/restapi/field?objectType={objectType}
Send a request to this endpoint to create a configured field.
Request
Supported Media Types
- application/json
Query Parameters
-
objectType: string
Object type.Allowed Values:
[ "PROJECT", "ACTIVITY", "ASSIGNMENT", "COMMITMENT", "CONTRACT", "CUSTOM_LOG", "CHANGE_ORDER", "PROJECT_COST_SHEET", "WORKSPACE_COST_SHEET", "FUND", "DOCUMENT", "COMPANY", "PROJECT_ACTUALS", "BUDGET_ITEM", "BUDGET_CHANGE", "BUDGET_TRANSFER", "BUDGET_TRANSACTION", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WBS", "WORK_PACKAGE", "PBS", "WORK_MANAGER_TASK", "PORTFOLIO", "STRATEGY", "RFI", "SUBMITTAL", "CHANGE_EVENT", "CHANGE_ESTIMATE" ]
A configured field object.
Root Schema : ApiEntityColumnDefinition
Type:
Show Source
object
-
columnId(optional):
integer(int64)
The system-generated identifier of a configured field column.
-
columnName(optional):
string
Allowed Values:
[ "Length[1-30]" ]
The view column name of a configured field. -
dataLength(optional):
integer(int32)
The length of a configured field.
-
dataType(optional):
string
Allowed Values:
[ "FT_DATE", "FT_MONEY", "FT_TEXT", "FT_INT", "FT_FLOAT_2_DECIMALS", "FT_BOOLEAN" ]
The data type of a configured field. -
flexObject(optional):
string
Allowed Values:
[ "PROJECT", "ACTIVITY", "ASSIGNMENT", "COMMITMENT", "CONTRACT", "CUSTOM_LOG", "CHANGE_ORDER", "PROJECT_COST_SHEET", "WORKSPACE_COST_SHEET", "FUND", "DOCUMENT", "COMPANY", "PROJECT_ACTUALS", "BUDGET_ITEM", "BUDGET_CHANGE", "BUDGET_TRANSFER", "BUDGET_TRANSACTION", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WBS", "WORK_PACKAGE", "PBS", "WORK_MANAGER_TASK", "PORTFOLIO", "STRATEGY", "RFI", "SUBMITTAL", "CHANGE_EVENT", "CHANGE_ESTIMATE" ]
Flex Object to be saved. -
flexType(optional):
string
Allowed Values:
[ "PROJECT_TEXT", "PROJECT_COST", "PROJECT_OTHER", "ACTIVITY_TEXT", "ACTIVITY_COST", "ACTIVITY_OTHER", "PROJECT_RISK_TEXT", "PROJECT_RISK_COST", "PROJECT_RISK_OTHER", "RESOURCE_ASSIGNMENT_TEXT", "RESOURCE_ASSIGNMENT_COST", "RESOURCE_ASSIGNMENT_OTHER", "WBS_TEXT", "WBS_COST", "WBS_OTHER", "WP_TEXT", "WP_COST", "WP_OTHER", "SCOPE_ITEM_COST", "SCOPE_ITEM_TEXT", "SCOPE_ITEM_OTHER", "SCOPE_ITEM_ASSIGNMENT_COST", "SCOPE_ITEM_ASSIGNMENT_TEXT", "SCOPE_ITEM_ASSIGNMENT_OTHER", "COMPANY_COST", "COMPANY_TEXT", "COMPANY_OTHER", "CAPITAL_PLAN_COST", "CAPITAL_PLAN_TEXT", "CAPITAL_PLAN_OTHER", "DOCUMENT_COST", "DOCUMENT_TEXT", "DOCUMENT_OTHER", "WORKSPACE_COST_SHEET_COST", "WORKSPACE_COST_SHEET_TEXT", "WORKSPACE_COST_SHEET_OTHER", "PROJECT_COST_SHEET_COST", "PROJECT_COST_SHEET_TEXT", "PROJECT_COST_SHEET_OTHER", "PROJECT_ACTUALS_TEXT", "PROJECT_ACTUALS_COST", "PROJECT_ACTUALS_OTHER", "BUDGET_CHANGE_TEXT", "BUDGET_CHANGE_COST", "BUDGET_CHANGE_OTHER", "BUDGET_TRANSFER_COST", "BUDGET_TRANSFER_TEXT", "BUDGET_TRANSFER_OTHER", "BUDGET_ITEM_COST", "BUDGET_ITEM_TEXT", "BUDGET_ITEM_OTHER", "BUDGET_TRANSACTION_COST", "BUDGET_TRANSACTION_TEXT", "BUDGET_TRANSACTION_OTHER", "WORK_MANAGER_TASK_COST", "WORK_MANAGER_TASK_TEXT", "WORK_MANAGER_TASK_OTHER", "CONTRACT_TEXT", "CONTRACT_COST", "CONTRACT_OTHER", "COMMITMENT_TEXT", "COMMITMENT_COST", "COMMITMENT_OTHER", "CHANGE_ORDER_TEXT", "CHANGE_ORDER_COST", "CHANGE_ORDER_OTHER", "CUSTOM_LOG_ITEM", "RFI_TEXT", "RFI_COST", "RFI_OTHER", "PORTFOLIO_TEXT", "PORTFOLIO_COST", "PORTFOLIO_OTHER", "SUBMITTAL_TEXT", "SUBMITTAL_COST", "SUBMITTAL_OTHER", "CHANGE_EVENT_TEXT", "CHANGE_EVENT_COST", "CHANGE_EVENT_OTHER", "CHANGE_ESTIMATE_TEXT", "CHANGE_ESTIMATE_COST", "CHANGE_ESTIMATE_OTHER", "FUND_TEXT", "FUND_COST", "FUND_OTHER" ]
-
label(optional):
string
Allowed Values:
[ "Length[1-60]" ]
The label of a configured field. -
link(optional):
string(url)
Read Only:
true
-
physicalType(optional):
string
Allowed Values:
[ "DOUBLE", "INTEGER", "NUMBER", "DATE", "STRING" ]
The physical percent complete of a configured field. -
status(optional):
string
Allowed Values:
[ "ENABLED", "UPDATED", "DISABLED", "DELETED", "PENDING", "FAILED" ]
The status of a configured field. -
summaryCalculationType(optional):
string
Allowed Values:
[ "SUM", "AVERAGE", "MIN", "MAX", "FORMULA", "NONE", "MAX_NULL" ]
The summary of a configured field. -
udfFormula(optional):
string
The formula of a configured field.
-
udfType(optional):
string
Allowed Values:
[ "MANUAL", "FORMULA" ]
The type of a configured field. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
viewColumnName(optional):
string
The view column name of a configured field.
-
workspaceId(optional):
integer(int64)
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityColumnDefinition
Type:
Show Source
object
-
columnId(optional):
integer(int64)
The system-generated identifier of a configured field column.
-
columnName(optional):
string
Allowed Values:
[ "Length[1-30]" ]
The view column name of a configured field. -
dataLength(optional):
integer(int32)
The length of a configured field.
-
dataType(optional):
string
Allowed Values:
[ "FT_DATE", "FT_MONEY", "FT_TEXT", "FT_INT", "FT_FLOAT_2_DECIMALS", "FT_BOOLEAN" ]
The data type of a configured field. -
flexObject(optional):
string
Allowed Values:
[ "PROJECT", "ACTIVITY", "ASSIGNMENT", "COMMITMENT", "CONTRACT", "CUSTOM_LOG", "CHANGE_ORDER", "PROJECT_COST_SHEET", "WORKSPACE_COST_SHEET", "FUND", "DOCUMENT", "COMPANY", "PROJECT_ACTUALS", "BUDGET_ITEM", "BUDGET_CHANGE", "BUDGET_TRANSFER", "BUDGET_TRANSACTION", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WBS", "WORK_PACKAGE", "PBS", "WORK_MANAGER_TASK", "PORTFOLIO", "STRATEGY", "RFI", "SUBMITTAL", "CHANGE_EVENT", "CHANGE_ESTIMATE" ]
Flex Object to be saved. -
flexType(optional):
string
Allowed Values:
[ "PROJECT_TEXT", "PROJECT_COST", "PROJECT_OTHER", "ACTIVITY_TEXT", "ACTIVITY_COST", "ACTIVITY_OTHER", "PROJECT_RISK_TEXT", "PROJECT_RISK_COST", "PROJECT_RISK_OTHER", "RESOURCE_ASSIGNMENT_TEXT", "RESOURCE_ASSIGNMENT_COST", "RESOURCE_ASSIGNMENT_OTHER", "WBS_TEXT", "WBS_COST", "WBS_OTHER", "WP_TEXT", "WP_COST", "WP_OTHER", "SCOPE_ITEM_COST", "SCOPE_ITEM_TEXT", "SCOPE_ITEM_OTHER", "SCOPE_ITEM_ASSIGNMENT_COST", "SCOPE_ITEM_ASSIGNMENT_TEXT", "SCOPE_ITEM_ASSIGNMENT_OTHER", "COMPANY_COST", "COMPANY_TEXT", "COMPANY_OTHER", "CAPITAL_PLAN_COST", "CAPITAL_PLAN_TEXT", "CAPITAL_PLAN_OTHER", "DOCUMENT_COST", "DOCUMENT_TEXT", "DOCUMENT_OTHER", "WORKSPACE_COST_SHEET_COST", "WORKSPACE_COST_SHEET_TEXT", "WORKSPACE_COST_SHEET_OTHER", "PROJECT_COST_SHEET_COST", "PROJECT_COST_SHEET_TEXT", "PROJECT_COST_SHEET_OTHER", "PROJECT_ACTUALS_TEXT", "PROJECT_ACTUALS_COST", "PROJECT_ACTUALS_OTHER", "BUDGET_CHANGE_TEXT", "BUDGET_CHANGE_COST", "BUDGET_CHANGE_OTHER", "BUDGET_TRANSFER_COST", "BUDGET_TRANSFER_TEXT", "BUDGET_TRANSFER_OTHER", "BUDGET_ITEM_COST", "BUDGET_ITEM_TEXT", "BUDGET_ITEM_OTHER", "BUDGET_TRANSACTION_COST", "BUDGET_TRANSACTION_TEXT", "BUDGET_TRANSACTION_OTHER", "WORK_MANAGER_TASK_COST", "WORK_MANAGER_TASK_TEXT", "WORK_MANAGER_TASK_OTHER", "CONTRACT_TEXT", "CONTRACT_COST", "CONTRACT_OTHER", "COMMITMENT_TEXT", "COMMITMENT_COST", "COMMITMENT_OTHER", "CHANGE_ORDER_TEXT", "CHANGE_ORDER_COST", "CHANGE_ORDER_OTHER", "CUSTOM_LOG_ITEM", "RFI_TEXT", "RFI_COST", "RFI_OTHER", "PORTFOLIO_TEXT", "PORTFOLIO_COST", "PORTFOLIO_OTHER", "SUBMITTAL_TEXT", "SUBMITTAL_COST", "SUBMITTAL_OTHER", "CHANGE_EVENT_TEXT", "CHANGE_EVENT_COST", "CHANGE_EVENT_OTHER", "CHANGE_ESTIMATE_TEXT", "CHANGE_ESTIMATE_COST", "CHANGE_ESTIMATE_OTHER", "FUND_TEXT", "FUND_COST", "FUND_OTHER" ]
-
label(optional):
string
Allowed Values:
[ "Length[1-60]" ]
The label of a configured field. -
link(optional):
string(url)
Read Only:
true
-
physicalType(optional):
string
Allowed Values:
[ "DOUBLE", "INTEGER", "NUMBER", "DATE", "STRING" ]
The physical percent complete of a configured field. -
status(optional):
string
Allowed Values:
[ "ENABLED", "UPDATED", "DISABLED", "DELETED", "PENDING", "FAILED" ]
The status of a configured field. -
summaryCalculationType(optional):
string
Allowed Values:
[ "SUM", "AVERAGE", "MIN", "MAX", "FORMULA", "NONE", "MAX_NULL" ]
The summary of a configured field. -
udfFormula(optional):
string
The formula of a configured field.
-
udfType(optional):
string
Allowed Values:
[ "MANUAL", "FORMULA" ]
The type of a configured field. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
viewColumnName(optional):
string
The view column name of a configured field.
-
workspaceId(optional):
integer(int64)
400 Response
Invalid input for the Configured Field service.