View Portfolios by Workspace
get
/api/restapi/portfolio/workspace/{workspaceId}
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.
Request
Path Parameters
-
workspaceId(required): integer(int64)
The unique identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityPortfolio>
Type:
array
Title:
Show Source
List<ApiEntityPortfolio>
-
Array of:
object ApiEntityPortfolio
Title:
ApiEntityPortfolio
Nested Schema : ApiEntityPortfolio
Type:
object
Title:
Show Source
ApiEntityPortfolio
-
autoRefresh: boolean
Indicates whether the portfolio is set to refresh automatically.
-
breakdownEnabled: boolean
The setting to enable capital and expense breakdown for a portfolio.
-
breakdownType: string
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: array
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: array
configuredFields
The list of configured fields for a portfolio.
-
description: string
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. -
filter: string
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:
image
The image that represents the capital portfolio.
-
lastRefreshDate: string
(date-time)
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.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
linkType: string
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. -
name: string
Minimum Length:
1
Maximum Length:255
The name of the portfolio. -
ownerId: integer
(int64)
The owner of a portfolio.
-
periodId: integer
(int64)
The unique identifier of a portfolio period.
-
periodType: string
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. -
planningHorizon: integer
(int32)
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. -
portfolioId: integer
(int64)
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: array
programFilter
CP_PORTFOLIO,PROGRAM_FILTER
-
programs: array
programs
The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
-
projects: array
projects
The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
-
securityGuid: string
Maximum Length:
32
Globally unique identifier of a portfolio. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspace: integer
(int64)
The workspace ID for the portfolio.
-
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.
-
yearsPlannedInMonth: integer
(int32)
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. -
yearsPlannedInQuarter: integer
(int32)
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. -
yearsPlannedInYear: integer
(int32)
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
-
Array of:
object ApiEntityCodeValuePortfolio
Title:
ApiEntityCodeValuePortfolio
Nested Schema : configuredFields
Type:
array
The list of configured fields for a portfolio.
Show Source
-
Array of:
object ApiEntityPortfolioConfiguredFieldValue
Title:
ApiEntityPortfolioConfiguredFieldValue
Nested Schema : image
The image that represents the capital portfolio.
Match All
Show Source
-
object
ApiEntityPortfolioImage
Title:
ApiEntityPortfolioImage
Nested Schema : programFilter
Type:
array
CP_PORTFOLIO,PROGRAM_FILTER
Show Source
-
Array of:
object ApiEntityProgramFilter
Title:
ApiEntityProgramFilter
Nested Schema : programs
Type:
array
The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
Show Source
-
Array of:
object ApiEntityPortfolioProgram
Title:
ApiEntityPortfolioProgram
Nested Schema : projects
Type:
array
The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
Show Source
-
Array of:
object ApiEntityPortfolioProject
Title:
ApiEntityPortfolioProject
Nested Schema : ApiEntityCodeValuePortfolio
Type:
object
Title:
Show Source
ApiEntityCodeValuePortfolio
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: string
Minimum Length:
0
Maximum Length:255
The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
codeValuePortfolioId: integer
(int64)
The system-generated identifier of a portfolio.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
portfolioId: integer
(int64)
The system-generated identifier of a portfolio.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
sequenceNumber: integer
(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityPortfolioConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityPortfolioConfiguredFieldValue
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
capitalPortfolioConfiguredFieldValueId: integer
(int64)
The unique identifier for the Portfolio Configured Field.
-
capitalPortfolioId: integer
(int64)
The system-generated identifier for a Portfolio.
-
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.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: number
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: string
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityPortfolioImage
Type:
object
Title:
Show Source
ApiEntityPortfolioImage
-
image: array
image
The image that represents the portfolio.
-
imageType: string
Allowed Values:
[ "PNG", "JPEG", "GIF" ]
The mime type of an image associated with a portfolio. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
portfolio(required): integer
(int64)
Unique identifier of the portfolio.
-
portfolioImageId: integer
(int64)
Unique identifier of the portfolio image.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityProgramFilter
Type:
object
Title:
Show Source
ApiEntityProgramFilter
-
fieldName: object
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: object
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.
-
join: string
Allowed Values:
[ "AND", "OR", "NULL" ]
Join condition -
operator: string
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
-
string
-
object
ConfiguredFieldIdentifier
Title:
ConfiguredFieldIdentifier
-
object
CodeTypeIdentifier
Title:
CodeTypeIdentifier
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
-
string
-
object
CodeValueIdentifier
Title:
CodeValueIdentifier
-
object
ApiEntityDateFilter
Title:
ApiEntityDateFilter
Nested Schema : ConfiguredFieldIdentifier
Type:
object
Title:
Show Source
ConfiguredFieldIdentifier
-
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.
-
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. -
label: string
The label of a configured field.
-
viewColumnName: string
The view column name of a configured field.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CodeTypeIdentifier
Type:
object
Title:
Show Source
CodeTypeIdentifier
-
codeTypeCode: string
Displays the code or ID of the Code Type.
-
codeTypeId: integer
(int64)
The system-generated identifier of a code type.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CodeValueIdentifier
Type:
object
Title:
Show Source
CodeValueIdentifier
-
codeTypeCode: string
Displays the code or ID of the Code Type.
-
codeTypeId: integer
(int64)
The system-generated identifier of a code type.
-
codeValueCode: string
Maximum Length:
60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
parentCVCodes: array
parentCVCodes
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.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ApiEntityDateFilter
Type:
object
Title:
Show Source
ApiEntityDateFilter
-
dateType: string
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: object
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
-
string
-
object
ApiEntityDateComputation
Title:
ApiEntityDateComputation
Nested Schema : ApiEntityDateComputation
Type:
object
Title:
Show Source
ApiEntityDateComputation
-
computationType: string
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.
-
computationValue: number
The value used to calculate the date based on the value provided in computationType field.
Nested Schema : ApiEntityPortfolioProgram
Type:
object
Title:
Show Source
ApiEntityPortfolioProgram
-
action: stringAllowed Values:[ "DELETE" ]
Deprecated. As of 23.12.Provide the value as DELETE if the program needs to be unlinked from portfolio. Not needed for linking. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
portfolioId: integer
(int64)
The portfolio that includes the project.
-
portfolioProgramId: integer
(int64)
The unique identifier for the program.
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityPortfolioProject
Type:
object
Title:
Show Source
ApiEntityPortfolioProject
-
capitalPortfolioId: integer
(int64)
The portfolio that includes the project.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
projectId: integer
(int64)
The unique identifier for the portfolio.
-
projectPortfolioProjectId: integer
(int64)
The unique identifier of a project contained in a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
-
review: boolean
Indicates a project in the capital plan is currently undergoing review.
-
updateDate: string
(date-time)
Date when the record was last updated.
204 Response
Successful operation with no content.
404 Response
The requested portfolio does not exist, or you do not have access to it.