1. Oracle Primavera Cloud REST API
  2. Tasks
  3. Portfolio

View a Portfolio by Name and Workspace

get

/api/restapi/portfolio/workspaceId/{workspaceId}/name/{name}

This endpoint returns portfolios that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
  • The object has a name that matches the value of the {name} path parameter.
Portfolios are collections of projects or other portfolios that enable you to plan resource and budget allocations across the collection.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : ApiEntityPortfolio
Type: object
Title: ApiEntityPortfolio
Show Source
  • Indicates whether the portfolio is set to refresh automatically.
  • The setting to enable capital and expense breakdown for a portfolio.
  • Allowed Values: [ "CAPITAL", "EXPENSE" ]
    The sub-cost curve to which the existing portfolio cost data will be mapped. The selected sub-cost curve will be used when linking a project's cost curve values.
  • codeValuesPortfolio
    The list of code values for a portfolio. This entity can only be used to assign codeValues or create codeValues on the fly.
  • configuredFields
    The list of configured fields for a portfolio.
  • Minimum Length: 0
    Maximum Length: 4000
    The detailed summary for the portfolio.
    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.
  • Maximum Length: 4000
    Determines if projects included in the portfolio must meet all or any of the defined filter rules.
    Selecting an appropriate filter criteria helps specify the portfolio's project inclusions.
  • image
    The image that represents the capital portfolio.
  • The date a refresh was last performed on the filter for the portfolio. The projects available in the portfolio are up-to-date as of the last refresh date.
  • Allowed Values: [ "FORECAST", "PLANNED_BUDGET" ]
    Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget.
    Linked values will be factored into a budget plan's Proposed Budget.
    Planner's can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans.
    Any portfolio budget plans added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.
  • Minimum Length: 1
    Maximum Length: 255
    The name of the portfolio.
  • The owner of a portfolio.
  • The unique identifier of a portfolio period.
  • Allowed Values: [ "DAILY", "WEEKLY_END_ON_SUN", "WEEKLY_END_ON_MON", "WEEKLY_END_ON_TUE", "WEEKLY_END_ON_WED", "WEEKLY_END_ON_THU", "WEEKLY_END_ON_FRI", "WEEKLY_END_ON_SAT", "SEMIMONTHLY", "MONTHLY_START_OF_MONTH", "MONTHLY_MID_MONTH" ]
    The frequency of portfolio refresh period.
  • Minimum Value: 1
    Maximum Value: 30
    The Planning Horizon defines the duration of budget planning within the portfolio.
    For example, the U.S. government plans six years of capital spending, in this case their planning horizon would be six years.
    The Planning Horizon is separated by yearly Planning Periods, during which budget values allocated to yearly projects, and planning for the year takes place.
    Returning to the example, the U.S. Government would establish a Planning Period budget six times, as they have a Planning Horizon of six years.
    Planning Horizon can be edited at any point in time during the planning process.
  • The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
  • programFilter
    CP_PORTFOLIO,PROGRAM_FILTER
  • programs
    The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
  • projects
    The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
  • Maximum Length: 32
    Globally unique identifier of a portfolio.
  • Date when the record was last updated.
  • The workspace ID for the portfolio.
  • Minimum Length: 0
    Maximum Length: 60
    The user-specified identifier of a workspace.
  • The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
  • Years Planned in Months specifies the number of years within the Planning Horizon that will be time phased in monthly increments.
    The number of years planned in months cannot be greater than the portfolio's Planning Horizon.
  • Years Planned in Quarters specifies the number of years within the Planning Horizon that will be time phased in quarterly increments.
    The number of years planned in quarters cannot be greater than the portfolio's Planning Horizon.
  • Years Planned in Years specifies the number of years within the Planning Horizon that will be time phased in yearly increments.
    The number of Years Planned In Years cannot be greater than the portfolio's Planning Horizon.
Nested Schema : codeValuesPortfolio
Type: array
The list of code values for a portfolio. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for a portfolio.
Show Source
Nested Schema : image
The image that represents the capital portfolio.
Match All
Show Source
Nested Schema : programFilter
Type: array
CP_PORTFOLIO,PROGRAM_FILTER
Show Source
Nested Schema : programs
Type: array
The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
Show Source
Nested Schema : projects
Type: array
The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
Show Source
Nested Schema : ApiEntityCodeValuePortfolio
Type: object
Title: ApiEntityCodeValuePortfolio
Show Source
Nested Schema : ApiEntityPortfolioConfiguredFieldValue
Type: object
Title: ApiEntityPortfolioConfiguredFieldValue
Show Source
Nested Schema : ApiEntityPortfolioImage
Type: object
Title: ApiEntityPortfolioImage
Show Source
Nested Schema : image
Type: array
The image that represents the portfolio.
Show Source
Nested Schema : ApiEntityProgramFilter
Type: object
Title: ApiEntityProgramFilter
Show Source
  • fieldName
    The program field on which the filter needs to be applied.
    • The list of fields supported for filtering with String type are: spendEffectiveDate, actualFinish, actualStart, forecastFinishDate, forecastStartDate, plannedFinish, plannedStart, statusDate, businessImpact, updateDate, description, programCode, linkForecastToSpend, programName, problemOrOpportunity, status, strategicObjective, evaluationScore. In addition, filtering is also possible on the following non-API exposed program fields: createDate and strategyProgramAlignScore.
    • The ConfiguredFieldIdentifier type is used for filtering program configured fields.
    • The CodeTypeIdentifier type is used for filtering program code types.
  • fieldValue
    Field value for filtering.
    • ApiEntityDateFilter type is for performing filtering on any date fields, such as when the fieldName is provided with any dates.
    • The CodeValueIdentifier type is for performing filtering on program code types i.e. when the fieldName is provided with the CodeTypeIdentifier value
    • The String type value is for any other fields other than the ones mentioned already.
  • Allowed Values: [ "AND", "OR", "NULL" ]
    Join condition
  • Allowed Values: [ "EQUALS", "NOT_EQUALS", "EQUALS_IGNORE_CASE", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "IN", "NOT_IN", "STARTS_WITH", "ENDS_WITH", "LIKE", "NOT_LIKE", "BETWEEN", "NOT_BETWEEN", "IS_NULL", "NOT_NULL", "IS_EMPTY", "IS_UNDER" ]
    Equality condition.
Nested Schema : fieldName
Type: object
The program field on which the filter needs to be applied.
  • The list of fields supported for filtering with String type are: spendEffectiveDate, actualFinish, actualStart, forecastFinishDate, forecastStartDate, plannedFinish, plannedStart, statusDate, businessImpact, updateDate, description, programCode, linkForecastToSpend, programName, problemOrOpportunity, status, strategicObjective, evaluationScore. In addition, filtering is also possible on the following non-API exposed program fields: createDate and strategyProgramAlignScore.
  • The ConfiguredFieldIdentifier type is used for filtering program configured fields.
  • The CodeTypeIdentifier type is used for filtering program code types.
Match One Schema
Show Source
Nested Schema : fieldValue
Type: object
Field value for filtering.
  • ApiEntityDateFilter type is for performing filtering on any date fields, such as when the fieldName is provided with any dates.
  • The CodeValueIdentifier type is for performing filtering on program code types i.e. when the fieldName is provided with the CodeTypeIdentifier value
  • The String type value is for any other fields other than the ones mentioned already.
Match One Schema
Show Source
Nested Schema : ConfiguredFieldIdentifier
Type: object
Title: ConfiguredFieldIdentifier
Show Source
  • Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
  • 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.
  • The label of a configured field.
  • The view column name of a configured field.
  • The user-specified identifier of a workspace.
  • The unique identifier of a workspace.
Nested Schema : CodeTypeIdentifier
Type: object
Title: CodeTypeIdentifier
Show Source
Nested Schema : CodeValueIdentifier
Type: object
Title: CodeValueIdentifier
Show Source
Nested Schema : ApiEntityDateFilter
Type: object
Title: ApiEntityDateFilter
Show Source
  • Allowed Values: [ "CUSTOM_DATE", "COMPUTED_DATE" ]
    • CUSTOM_DATE: Custom date is used to provide a specific date in the dateValue field.
      • COMPUTED_DATE: Computed date is used to provide a calculated date in the dateValue field.
  • dateValue
    • String type is used for providing a specific date when the dateType is CUSTOM_DATE.
    • ApiEntityDateComputation type is for providing a calculated date when the dateType is COMPUTED_DATE.
Nested Schema : parentCVCodes
Type: array
List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : dateValue
Type: object
  • String type is used for providing a specific date when the dateType is CUSTOM_DATE.
  • ApiEntityDateComputation type is for providing a calculated date when the dateType is COMPUTED_DATE.
Match One Schema
Show Source
Nested Schema : ApiEntityDateComputation
Type: object
Title: ApiEntityDateComputation
Show Source
  • Allowed Values: [ "DAYS_FROM_CURRENT_DATE", "WEEKS_FROM_CURRENT_DATE", "MONTHS_FROM_CURRENT_DATE", "QUARTERS_FROM_CURRENT_DATE", "YEARS_FROM_CURRENT_DATE", "WEEKS_FROM_CURRENT_WEEK", "MONTHS_FROM_CURRENT_MONTH" ]
    • DAYS_FROM_CURRENT_DATE: It indicates the date calculated as an increment or decrement of the number of days provided in the computationValue from the current date.
    • WEEKS_FROM_CURRENT_DATE: It indicates the date calculated as an increment or decrement of the number of weeks provided in the computationValue from the current date.
    • MONTHS_FROM_CURRENT_DATE - It indicates the date calculated as an increment or decrement of the number of months provided in the computationValue from the current date.
    • QUARTERS_FROM_CURRENT_DATE: It indicates the date calculated as an increment or decrement of quarters in a year provided in the computationValue from the current date.
    • YEARS_FROM_CURRENT_DATE: It indicates the date calculated as an increment or decrement of the number of years provided in the computationValue from the current date.
    • WEEKS_FROM_CURRENT_WEEK: It indicates the date calculated as an increment or decrement of the number of weeks provided in the computationValue from the current week.
    • MONTHS_FROM_CURRENT_MONTH: It indicates the date calculated as an increment or decrement of the number of months provided in the computationValue from the current month.
  • The value used to calculate the date based on the value provided in computationType field.
Nested Schema : ApiEntityPortfolioProgram
Type: object
Title: ApiEntityPortfolioProgram
Show Source
Nested Schema : ApiEntityPortfolioProject
Type: object
Title: ApiEntityPortfolioProject
Show Source

204 Response

Successful operation with no content.

404 Response

The requested portfolio does not exist, or you do not have access to it.
Back to Top