Oracle Prime Cloud Release 16

Returns the configured field for the specified configured field ID.

get

/primeapi/restapi/v16.2/field/{id}

Request

Path Parameters

id: Type: integer (int64)

Required: true

ID of the configured field to be found.

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityColumnDefinition

Type: object

Properties

columnId: Type: integer (int64)

The column ID for the configured field in the database.
columnName: Type: string

Allowed Values: [ "Length[1-30]" ]

The system-generated name for the configured field in the database.
dataType: Type: string

Allowed Values: [ "Cost", "Date", "Integer", "Number", "Text" ]

Specifies the type of data a configured field can store. Configured Fields can have a data type of Start Date, Finish Date, Cost, Number, Integer, or Text. A single configured field cannot store multiple data types.
flexType: Type: string

Allowed Values: [ "PROJECT_CP_FLEX_TEXT", "PROJECT_CP_FLEX_COST", "PROJECT_CP_FLEX_OTHER", "ACTIVITY_FLEX_TEXT", "ACTIVITY_FLEX_COST", "ACTIVITY_FLEX_OTHER", "PROJECT_RISK_FLEX_TEXT", "PROJECT_RISK_FLEX_COST", "PROJECT_RISK_FLEX_OTHER", "RESOURCE_ASSIGNMENT_FLEX_TEXT", "RESOURCE_ASSIGNMENT_FLEX_COST", "RESOURCE_ASSIGNMENT_FLEX_OTHER", "WBS_FLEX_TEXT", "WBS_FLEX_COST", "WBS_FLEX_OTHER", "WP_FLEX_TEXT", "WP_FLEX_COST", "WP_FLEX_OTHER", "SCOPE_ITEM_FLEX_COST", "SCOPE_ITEM_FLEX_TEXT", "SCOPE_ITEM_FLEX_OTHER", "SCOPE_ITEM_ASSIGNMENT_FLEX_COST", "SCOPE_ITEM_ASSIGNMENT_FLEX_TEXT", "SCOPE_ITEM_ASSIGNMENT_FLEX_OTHER", "COMPANY_FLEX_COST", "COMPANY_FLEX_TEXT", "COMPANY_FLEX_OTHER", "PROJECT_ACTUALS_FLEX_TEXT", "PROJECT_ACTUALS_FLEX_COST", "PROJECT_ACTUALS_FLEX_OTHER", "CAPITAL_PLAN_FLEX_COST", "CAPITAL_PLAN_FLEX_TEXT", "CAPITAL_PLAN_FLEX_OTHER", "DOCUMENT_FLEX_COST", "DOCUMENT_FLEX_TEXT", "DOCUMENT_FLEX_OTHER", "WORKSPACE_COST_SHEET_FLEX_COST", "WORKSPACE_COST_SHEET_FLEX_TEXT", "WORKSPACE_COST_SHEET_FLEX_OTHER", "PROJECT_COST_SHEET_FLEX_COST", "PROJECT_COST_SHEET_FLEX_TEXT", "PROJECT_COST_SHEET_FLEX_OTHER" ]
label: Type: string

Allowed Values: [ "Length[1-60]" ]

The user entered name for the configured field. The value of this field will display on grids and forms in the application.
physicalType: Type: string

Allowed Values: [ "DOUBLE", "INTEGER", "NUMBER", "DATE", "STRING" ]

The data type of the configured field stored in the database.
status: Type: string

Allowed Values: [ "Enabled", "Pending", "Disabled", "Failed", "Updated", "Deleted" ]

The status of the configured field determines if the field is available for use. Values include, Updated, Pending, Deleted, Disable, Enabled, and Failed.
summaryCalculationType: Type: string

Allowed Values: [ "Average", "Max", "Min", "None", "Sum", "Formula" ]

The type of summary calculation applied towards the configured field. Values include, Maximum, Minimum, Use Formula, None, Sum, Average.
udfFormula: Type: string

The formula used in the calculation of the value of the configured field.
udfType: Type: string

Allowed Values: [ "Manual", "Formula" ]

Determines whether the configured field will be used to store data entered directly into the field or whether the data will be calculated from the contents of other fields. The options are Manual (for a field into which users will enter data directly) or Formula (for a field whose data will be calculated).
workspaceId: Type: integer (int64)

404 Response

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