Oracle Prime Cloud Release 16

Returns the projects specified by the assigned Configured field value.

get

/primeapi/restapi/v16.2/project/configuredField/{viewColumnName}/{value}

Request

Path Parameters

value: Type: string

Required: true
viewColumnName: Type: string

Required: true

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityProject

Type: object

Properties

actualDuration: Type: object Duration
actualFinish: Type: string (date-time)

The Actual Finish displays the date on which a project is considered complete.
actualStart: Type: string (date-time)

The Actual Start indicates the date work on the project began.
addressLine1: Type: string

The first line of the address of a location. This might be the building number and street address.
addressLine2: Type: string

The second line of the address of a location. This might be a neighborhood or town.
calendarId: Type: integer (int64)

The unique identifier for the calendar.
cityName: Type: string

The city name for a location.
codeValuesProject: Type: array codeValuesProject

Unique Items Required: true

Lists all project code types assigned to the project with its corresponding value.
countryCode: Type: string

The country for a location.
currentApprovedFinishDate: Type: string (date-time)

The finish date for the Current Approved Budget set by the capital planner.
currentApprovedStartDate: Type: string (date-time)

The start date for the Current Approved Budget set by the capital planner.
dataDate: Type: string (date-time)

The progress point, or "as-of date", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually. The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities.
description: Type: string

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

The detailed summary for the project. The description provides more information than short names or titles. It can give background information or establish a purpose for the item. These details help differentiate between items with similar names and are especially useful in multi-user environments.
exchangeRateType: Type: string

Allowed Values: [ "FLOATING", "PEGGED" ]
finishDate: Type: string (date-time)

The date on which all project work is complete.
finishDateVariance: Type: object Duration
forecastFinishDate: Type: string (date-time)

The planned finish date of a project's remaining Forecast cost.
forecastStartDate: Type: string (date-time)

The planned start date of a project's remaining Forecast cost.
latitude: Type: number (double)

The geographical coordinate for the latitude of the location. The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
linkForecastToSpend: Type: boolean

Default Value: false

Enables you to link project Forecast data to project Actuals data. When linked, any updates to the project's Actuals values will automatically be applied to the project's Forecast values.
locationName: Type: string

A name for the location that your users will understand and recognize.
longitude: Type: number (double)

The geographical coordinate for the longitude of the location. The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
mustFinishByDate: Type: string (date-time)

The latest date on which the scheduled activities must be complete for a project.
owner: Type: string

The manager or person responsible for the project.
parentProject: Type: integer (int64)
pegRate: Type: number

The custom exchange rate for a pegged exchange rate.
percentComplete: Type: object Percent
percentCompleteWeightedBy: Type: string

Allowed Values: [ "COST", "QUANTITY", "HOURS", "MANUAL" ]

The weight for scope items is calculated using quantity.
planDuration: Type: object Duration
planEndDate: Type: string (date-time)

The finish date for the time phased Planned Budget of the project. Planned Budget cost spread will adjust when this date is changed.
planStartDate: Type: string (date-time)

The start date for the time phased Planned Budget of the project. Planned Budget cost spread will adjust when this date is changed. The Project Planned Start also represents the earliest date that activities can occur within a project schedule.
postalCode: Type: string

The postal code, post code, or zip code of a location.
priorityNum: Type: integer (int64)

The project's priority in the strategic plan. This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data.
projectCashFlows: Type: array projectCashFlows

Lists all project cost field spread data assigned to the project.
projectCode: Type: string

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

The unique identifier for a project set by the user who created the project.
projectCPFlexCost: Type: object ApiEntityProjectCPFlexCost
projectCPFlexOther: Type: object ApiEntityProjectCPFlexOther
projectCPFlexText: Type: object ApiEntityProjectCPFlexText
projectCurrency: Type: integer (int64)

KEY
projectFinancial: Type: object ApiEntityProjectFinancial
projectId: Type: integer (int64)

The unique identifier for the project.
projectIntegrationType: Type: string

Allowed Values: [ "P6", "UNIFIER" ]

Specifies if the project is integrated with another application.
projectName: Type: string

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

The name of the project.
projectSettings: Type: array projectSettings

Unique Items Required: true
proposedFinishDate: Type: string (date-time)

The finish date for the Proposed Budget of the project.
proposedStartDate: Type: string (date-time)

The start date for the Proposed Budget of the project.
recordCount: Type: integer (int32)

The number of comments on a project.
remainingDuration: Type: object Duration
reportCycleId: Type: integer (int64)

The reporting cycle assigned to the project.
reportCycleNamingBoundary: Type: string

Allowed Values: [ "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]

Determines when period names will be reset. The options available are based on the selection for Reporting Cycle. The standard calendar start and end dates are used as boundaries for resetting periods.
riskLevel: Type: string

Allowed Values: [ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ]

The risk level assigned to the project. Projects can have a risk level of very high, high, medium, low, or very low. You can use risk level to determine what projects should be included in your plans, as well as which projects should be of priority.
riskMatrixId: Type: integer (int64)

The risk matrix assigned to the project for calculating project risk scores.
riskScore: Type: integer (int32)

The risk score value is based on the probability and impacts of a risk. It is derived from the probability impact matrix and any associated rules.
scheduledFinishDate: Type: string (date-time)

The calculated latest early finish date, which is based on the schedule most recently generated for the project.
securityGuid: Type: string

STRING
sequenceNumber: Type: integer (int32)

Determines the order of appearance of projects in a list.
spendEffectiveDate: Type: string (date-time)

The month in which an actuals value was last added to the project.
spendFinishDate: Type: string (date-time)

The finish date for the project actuals.
spendStartDate: Type: string (date-time)

The start date for the project actuals.
startDate: Type: string (date-time)

The date on which work on the project starts.
startDateVariance: Type: object Duration
stateCode: Type: string

A unique identifier for the state or province.
stateName: Type: string

The state, region, or province of a location.
status: Type: string

Allowed Values: [ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETED" ]

The current status of a project. Proposal: The project is a project proposal and has not been extensively planned nor accrued any costs. Rejected: The project proposal has been rejected and will not be initiated as a project. Planned: The project is currently planned for execution. Project managers input expected project costs and other project data during this stage. Active: The project is currently active and being executed. Inactive: The project has been rendered inactive and will temporarily accrue no costs. Complete: The project has been successfully completed and will no longer accrue costs.
strgyPriorityNum: Type: integer (int64)

The project's priority in the strategic plan. This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data.
summarizedDataDate: Type: string (date-time)
websiteUrl: Type: string

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

The link to a website related to the project.
workspaceId: Type: integer (int64)

The workspace the project is associated with.

Nested Schema : Duration

Type: object

Properties

bigDecimal: Type: number
double: Type: number (double)

Nested Schema : codeValuesProject

Type: array

Unique Items Required: true

Lists all project code types assigned to the project with its corresponding value.

Items

Type: object ApiEntityCodeValueProject

Nested Schema : Percent

Type: object

Properties

bigDecimal: Type: number
double: Type: number (double)

Nested Schema : projectCashFlows

Type: array

Lists all project cost field spread data assigned to the project.

Items

Type: object ApiEntityProjectCashFlow

Nested Schema : ApiEntityProjectCPFlexCost

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured cost fields assigned to the project with its corresponding value as a (key,value) pair.
project: Type: object ApiEntityProject
projectId: Type: integer (int64)

Nested Schema : ApiEntityProjectCPFlexOther

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured date, number, integer fields assigned to the project with its corresponding value as a (key,value) pair.
project: Type: object ApiEntityProject
projectId: Type: integer (int64)

Nested Schema : ApiEntityProjectCPFlexText

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured text fields assigned to the project with its corresponding value as a (key,value) pair.
project: Type: object ApiEntityProject
projectId: Type: integer (int64)

Nested Schema : ApiEntityProjectFinancial

Type: object

Properties

actualCost: Type: object Cost
annualDiscountRate: Type: object Percent
atCompletionCost: Type: object Cost
costPerfIndex: Type: number (double)

The measure of a project's cost efficiency. A value of less than 1 indicates the project is over budget, while a value greater than 1 indicates the project is under budget.
costVariance: Type: object Cost
currentApprovedBudget: Type: object Cost
currentApprovedBudgetBaseDistributed: Type: object Cost
currentApprovedBudgetBaseUndistributed: Type: object Cost
currentApprovedSpendVariance: Type: object Cost
earnedValueCost: Type: object Cost
estAtCompleteCost: Type: object Cost
estToCompleteCost: Type: object Cost
forecastCost: Type: object Cost
forecastCostDistributed: Type: object Cost
forecastCostUndistributed: Type: object Cost
forecastCurrApprVar: Type: object Cost
intRateReturn: Type: object Percent
netPresentValue: Type: object Cost
paybackPeriod: Type: number (double)

The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected project.
plannedBudget: Type: object Cost
plannedBudgetDistributed: Type: object Cost
plannedBudgetUndistributed: Type: object Cost
plannedValueCost: Type: object Cost
profitabilityIndex: Type: number (double)

The index based on the value of a project's present values divided by initial project investments.
project: Type: object ApiEntityProject
projectId: Type: integer (int64)
proposedBudget: Type: object Cost
proposedBudgetBaseDistributed: Type: object Cost
proposedBudgetBaseUndistributed: Type: object Cost
proposedForecastVariance: Type: object Cost
proposedPlannedVar: Type: object Cost
remainingCost: Type: object Cost
returnInvestment: Type: object Percent
schedPerfIndex: Type: number (double)

The measure of the work accomplished as a percentage of the work scheduled on a project. Schedule Performance Index indicates whether you are meeting earned and planned values within your project schedule. A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the project is ahead of schedule.
scheduleVariance: Type: object Cost
spendCost: Type: object Cost
spendForecastVar: Type: object Cost
spendPlannedVariance: Type: object Cost
yearEndForecastCost: Type: object Cost
ytdSpendCost: Type: object Cost

Nested Schema : projectSettings

Type: array

Unique Items Required: true

Items

Type: object ApiEntityProjectSetting

Nested Schema : ApiEntityCodeValueProject

Type: object

Properties

codeType: Type: object ApiEntityCodeType
codeValue: Type: object ApiEntityCodeValue
codeValueProjectId: Type: integer (int64)

The unique identifier of the workspace where the code value was created.
projectId: Type: integer (int64)

Nested Schema : ApiEntityCodeType

Type: object

Properties

assignments: Type: array assignments

Unique Items Required: true
codeTypeCode: Type: string

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

This field displays the name of a code or value.
codeTypeId: Type: integer (int64)
codeTypeName: Type: string

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

STRING
workspace: Type: integer (int64)

The ID of the owning workspace.

Nested Schema : ApiEntityCodeValue

Type: object

Properties

codeTypeId: Type: integer (int64)

The ID for the code type.
codeValueCode: Type: string

Allowed Values: [ "LENGTH[1-32]" ]

The unique identifier for the code value.
codeValueId: Type: integer (int64)

The unique identifier for the code value.
codeValueName: Type: string

Allowed Values: [ "LENGTH[1-100]" ]

The name of the code value.
parentCodeValue: Type: integer (int64)

The parent code value.
sequenceNumber: Type: integer (int32)

The number that specifies the position of the code value item within the code type list.

Nested Schema : assignments

Type: array

Unique Items Required: true

Items

Type: object ApiEntityCodeEntityType

Nested Schema : ApiEntityCodeEntityType

Type: object

Properties

codeType: Type: object ApiEntityCodeType
entityType: Type: string

Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "PROJECT_FUND", "WORKSPACE_FUND" ]
primaryKey: Type: integer (int64)

Nested Schema : ApiEntityProjectCashFlow

Type: object

Properties

actualCost: Type: object Cost
actualForecastVar: Type: object Cost
atCompletionCost: Type: object Cost
currentApprovedBudget: Type: object Cost
currentApprovedSpendVariance: Type: object Cost
forecastCost: Type: object Cost
forecastCurrApprVar: Type: object Cost
plannedBudget: Type: object Cost
projectId: Type: integer (int64)

The unique identifier for the project.
projectPhaseFinancialId: Type: integer (int64)

The unique internal identifier for the project's time-phased cost spread.
proposedBudget: Type: object Cost
proposedForecastVariance: Type: object Cost
proposedPlannedVar: Type: object Cost
spendCost: Type: object Cost
spendForecastVar: Type: object Cost
spendPlannedVariance: Type: object Cost
spreadDate: Type: string (date-time)
yearEndBudger: Type: object Cost
yearEndForecastCost: Type: object Cost
ytdActualCost: Type: object Cost
ytdSpendCost: Type: object Cost

Nested Schema : Cost

Type: object

Nested Schema : flexMap

Type: object

Additional Properties Allowed

Type: object additionalProperties

Lists all configured cost fields assigned to the project with its corresponding value as a (key,value) pair.

Nested Schema : additionalProperties

Type: object

Nested Schema : flexMap

Type: object

Additional Properties Allowed

Type: object additionalProperties

Lists all configured date, number, integer fields assigned to the project with its corresponding value as a (key,value) pair.

Nested Schema : additionalProperties

Type: object

Nested Schema : flexMap

Type: object

Additional Properties Allowed

Type: object additionalProperties

Lists all configured text fields assigned to the project with its corresponding value as a (key,value) pair.

Nested Schema : additionalProperties

Type: object

Nested Schema : ApiEntityProjectSetting

Type: object

Properties

projectId: Type: integer (int64)

The unique identifier for the project.
projectSettingId: Type: integer (int64)
settingName: Type: string
settingValue: Type: string