Batch Sync Portfolios
post
/api/restapi/portfolio/syncBatch
Send a request to this endpoint to create or update one or more portfolios.
Request
Header Parameters
-
singleTransaction:
Enabling this boolean flag fails to complete the request if an error occurred when processing any portfolio sent as part of the request.
Allowed Values: [ "true", "false" ]Default Value:false
Supported Media Types
- application/json
Root Schema : List<ApiEntityPortfolioInput>
Type:
array
Title:
Show Source
List<ApiEntityPortfolioInput>
-
Array of:
object ApiEntityPortfolioInput
Title:
ApiEntityPortfolioInput
This entity represents a Portfolio object, a unique Portfolio object can be identified by the following combinations of the fields.- portfolioId
- name,workspaceId
- name,workspaceCode
Nested Schema : ApiEntityPortfolioInput
Type:
object
Title:
ApiEntityPortfolioInput
This entity represents a Portfolio object, a unique Portfolio object can be identified by the following combinations of the fields.
Show Source
- portfolioId
- name,workspaceId
- name,workspaceCode
-
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)Read Only:true
Deprecated. As of 23.12.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)Read Only:true
Deprecated. As of 23.10.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(required): 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: arrayprojectsRead Only:true
Deprecated. As of 23.12.The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios. -
securityGuid: stringRead Only:true
Maximum Length:32
Deprecated. As of 23.12.Globally unique identifier of a portfolio. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.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(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
-
yearsPlannedInMonth(required): 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(required): 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(required): 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 ApiEntityCodeValuePortfolioInput
Title:
ApiEntityCodeValuePortfolioInput
This entity represents a CodeValuePortfolio object, a unique CodeValuePortfolio object can be identified by the following combinations of the fields.- codeValuePortfolioId
- codeValueId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeTypeCode,parentId,codeValueCode
- codeValueCode,codeTypeId,parentId
- codeTypeCode,codeValueCode,projectCode
- codeTypeCode,codeValueCode,projectId
- codeTypeCode,codeValueCode,parentId,projectCode
- codeTypeCode,codeValueCode,parentId,projectId
Nested Schema : configuredFields
Type:
array
The list of configured fields for a portfolio.
Show Source
-
Array of:
object ApiEntityPortfolioConfiguredFieldValueInput
Title:
ApiEntityPortfolioConfiguredFieldValueInput
This entity represents a PortfolioConfiguredFieldValue object, a unique PortfolioConfiguredFieldValue object can be identified by the following combinations of the fields.- capitalPortfolioConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : image
The image that represents the capital portfolio.
Match All
Show Source
-
object
ApiEntityPortfolioImageInput
Title:
ApiEntityPortfolioImageInput
Nested Schema : programFilter
Type:
array
CP_PORTFOLIO,PROGRAM_FILTER
Show Source
-
Array of:
object ApiEntityProgramFilterInput
Title:
ApiEntityProgramFilterInput
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 ApiEntityPortfolioProgramInput
Title:
ApiEntityPortfolioProgramInput
Nested Schema : projects
Type:
array
Read Only:
true
Deprecated. As of 23.12.The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
Show Source
-
Array of:
object ApiEntityPortfolioProjectInput
Title:
ApiEntityPortfolioProjectInput
Read Only:true
Nested Schema : ApiEntityCodeValuePortfolioInput
Type:
object
Title:
ApiEntityCodeValuePortfolioInput
This entity represents a CodeValuePortfolio object, a unique CodeValuePortfolio object can be identified by the following combinations of the fields.
Show Source
- codeValuePortfolioId
- codeValueId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeTypeCode,parentId,codeValueCode
- codeValueCode,codeTypeId,parentId
- codeTypeCode,codeValueCode,projectCode
- codeTypeCode,codeValueCode,projectId
- codeTypeCode,codeValueCode,parentId,projectCode
- codeTypeCode,codeValueCode,parentId,projectId
-
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: stringMinimum Length:0
Maximum Length:255
Deprecated. As of 23.11.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)Read Only:true
Deprecated. As of 23.10.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)Deprecated. As of 23.11.The number that specifies the position of the code value item within the code type list. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityPortfolioConfiguredFieldValueInput
Type:
object
Title:
ApiEntityPortfolioConfiguredFieldValueInput
This entity represents a PortfolioConfiguredFieldValue object, a unique PortfolioConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- capitalPortfolioConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
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: numberRead Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.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: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead Only:true
Deprecated. As of 23.10.Determines if formula calculation hit an error calculating a value for this field. -
link: string(url)Read Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityPortfolioImageInput
Type:
object
Title:
Show Source
ApiEntityPortfolioImageInput
-
image(required): array
image
The image that represents the portfolio.
-
imageType(required): 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 : ApiEntityProgramFilterInput
Type:
object
Title:
Show Source
ApiEntityProgramFilterInput
-
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 -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
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. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
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 : ApiEntityPortfolioProgramInput
Type:
object
Title:
Show Source
ApiEntityPortfolioProgramInput
-
action: string
Allowed Values:
[ "DELETE" ]
Provide the value as DELETE if the program needs to be unlinked from portfolio. Not needed for linking. -
link: string(url)Read Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityPortfolioProjectInput
Type:
object
Title:
ApiEntityPortfolioProjectInput
Read Only:
Show Source
true
-
capitalPortfolioId: integer
(int64)
The portfolio that includes the project.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
Back to Top
Response
Supported Media Types
- application/json
207 Response
The object was successfully integrated.
Root Schema : List<ApiEntitySyncApiResponse>
Type:
array
Title:
Show Source
List<ApiEntitySyncApiResponse>
-
Array of:
object ApiEntitySyncApiResponse
Title:
ApiEntitySyncApiResponse
Nested Schema : ApiEntitySyncApiResponse
Type:
object
Title:
Show Source
ApiEntitySyncApiResponse
-
identifier: object
identifier
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
message: string
Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
-
statusCode: integer
(int32)
The response code representing the state of the API operation.
Nested Schema : identifier
Type:
object
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.
Match One Schema
Show Source
-
object
ConstraintIdentifier
Title:
ConstraintIdentifier
-
object
CBSSheetSegmentIdentifier
Title:
CBSSheetSegmentIdentifier
-
object
CBSTemplateSegmentIdentifier
Title:
CBSTemplateSegmentIdentifier
-
object
ScopeAssignmentActualsTimePhasedDataIdentifier
Title:
ScopeAssignmentActualsTimePhasedDataIdentifier
-
object
ScopeAssignmentInstalledTimePhasedDataIdentifier
Title:
ScopeAssignmentInstalledTimePhasedDataIdentifier
-
object
ResourceWorkRateIdentifier
Title:
ResourceWorkRateIdentifier
-
object
ReasonIdentifier
Title:
ReasonIdentifier
-
object
WorkManagerTaskIdentifier
Title:
WorkManagerTaskIdentifier
-
object
ChangeRequestIdentifier
Title:
ChangeRequestIdentifier
-
object
ScopeItemAssignmentActivityIdentifier
Title:
ScopeItemAssignmentActivityIdentifier
-
object
RiskScoreTypeIdentifier
Title:
RiskScoreTypeIdentifier
-
object
RiskMatrixIdentifier
Title:
RiskMatrixIdentifier
-
object
ProjectRiskIdentifier
Title:
ProjectRiskIdentifier
-
object
ProgramRiskIdentifier
Title:
ProgramRiskIdentifier
-
object
ActivityRiskIdentifier
Title:
ActivityRiskIdentifier
-
object
RiskMitigationIdentifier
Title:
RiskMitigationIdentifier
-
object
ProgramRiskMitigationIdentifier
Title:
ProgramRiskMitigationIdentifier
-
object
ProgramRiskWeatherPeriodIdentifier
Title:
ProgramRiskWeatherPeriodIdentifier
-
object
HolidayGroupIdentifier
Title:
HolidayGroupIdentifier
-
object
RiskWeatherPeriodIdentifier
Title:
RiskWeatherPeriodIdentifier
-
object
PortfolioIdentifier
Title:
PortfolioIdentifier
-
object
PortfolioMeasureIdentifier
Title:
PortfolioMeasureIdentifier
-
object
EntityReferenceIdentifier
Title:
EntityReferenceIdentifier
-
object
PortfolioMeasureManualValueIdentifier
Title:
PortfolioMeasureManualValueIdentifier
-
object
CustomLogTypeObjectIdentifier
Title:
CustomLogTypeObjectIdentifier
-
object
CustomLogItemIdentifier
Title:
CustomLogItemIdentifier
-
object
ProjectRankIdentifier
Title:
ProjectRankIdentifier
-
object
ProjectDependencyIdentifier
Title:
ProjectDependencyIdentifier
-
object
LocationIdentifier
Title:
LocationIdentifier
-
object
MeasureIdentifier
Title:
MeasureIdentifier
-
object
MeasureThresholdIdentifier
Title:
MeasureThresholdIdentifier
-
object
ReportCycleIdentifier
Title:
ReportCycleIdentifier
-
object
UnitsOfMeasureIdentifier
Title:
UnitsOfMeasureIdentifier
-
object
WorkspaceIdentifier
Title:
WorkspaceIdentifier
-
object
ApplicationUserGroupIdentifier
Title:
ApplicationUserGroupIdentifier
-
object
CalendarIdentifier
Title:
CalendarIdentifier
-
object
CodeTypeIdentifier
Title:
CodeTypeIdentifier
-
object
CodeValueIdentifier
Title:
CodeValueIdentifier
-
object
CostCategoryIdentifier
Title:
CostCategoryIdentifier
-
object
CurveIdentifier
Title:
CurveIdentifier
-
object
DocumentFolderStructureTemplateIdentifier
Title:
DocumentFolderStructureTemplateIdentifier
-
object
IdeaIdentifier
Title:
IdeaIdentifier
-
object
OfficeIdentifier
Title:
OfficeIdentifier
-
object
ProjectCompanyIdentifier
Title:
ProjectCompanyIdentifier
-
object
ResourceDemandIdentifier
Title:
ResourceDemandIdentifier
-
object
ProjectBudgetChangeIdentifier
Title:
ProjectBudgetChangeIdentifier
-
object
ProjectBudgetTransferIdentifier
Title:
ProjectBudgetTransferIdentifier
-
object
ProjectResourceWorkRateIdentifier
Title:
ProjectResourceWorkRateIdentifier
-
object
ProjectActualsLineItemIdentifier
Title:
ProjectActualsLineItemIdentifier
-
object
ProjectActualsIdentifier
Title:
ProjectActualsIdentifier
-
object
ProjectBudgetItemIdentifier
Title:
ProjectBudgetItemIdentifier
-
object
ProgramIdentifier
Title:
ProgramIdentifier
-
object
StrategyIdentifier
Title:
StrategyIdentifier
-
object
StrategyTypeIdentifier
Title:
StrategyTypeIdentifier
-
object
RuleOfCreditIdentifier
Title:
RuleOfCreditIdentifier
-
object
ResourceRoleAssignmentIdentifier
Title:
ResourceRoleAssignmentIdentifier
-
object
BudgetPlanningScenarioIdentifier
Title:
BudgetPlanningScenarioIdentifier
-
object
ScopeAssignmentPlannedTimePhasedDataIdentifier
Title:
ScopeAssignmentPlannedTimePhasedDataIdentifier
-
object
ProgramBudgetTransferIdentifier
Title:
ProgramBudgetTransferIdentifier
-
object
ProgramBudgetChangeIdentifier
Title:
ProgramBudgetChangeIdentifier
-
object
ActivityIdentifier
Title:
ActivityIdentifier
-
object
AssignmentIdentifier
Title:
AssignmentIdentifier
-
object
RelationshipIdentifier
Title:
RelationshipIdentifier
-
object
FundActualIdentifier
Title:
FundActualIdentifier
-
object
ProgramBudgetItemIdentifier
Title:
ProgramBudgetItemIdentifier
Nested Schema : ConstraintIdentifier
Type:
object
Title:
Show Source
ConstraintIdentifier
-
constraintCode(required): string
The user specified identifier for a constraint.
-
constraintId: integer
(int64)
The unique identifier of a constraint.
-
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.
Nested Schema : CBSSheetSegmentIdentifier
Type:
object
Title:
Show Source
CBSSheetSegmentIdentifier
-
cbsSheetSegmentId: integer
(int64)
The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.
-
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.
-
segmentDefinitionName(required): string
Maximum Length:
255
The name of the level of the cost breakdown structure segment definition. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CBSTemplateSegmentIdentifier
Type:
object
Title:
Show Source
CBSTemplateSegmentIdentifier
-
cbsTemplateSegmentId: integer
(int64)
The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.
-
segmentDefinitionName(required): string
Maximum Length:
255
The name of the CBS segment. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ScopeAssignmentActualsTimePhasedDataIdentifier
Type:
object
Title:
Show Source
ScopeAssignmentActualsTimePhasedDataIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
scopeAssignmentActualsTimePhasedDataId: integer
(int64)
The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.
-
scopeItemAssignCode: string
Maximum Length:
60
The user-specified unique identifier for the scope assignment. -
scopeItemAssignmentId: integer
(int64)
The unique identifier for the scope item assigned to the work package.
-
scopeItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ScopeAssignmentInstalledTimePhasedDataIdentifier
Type:
object
Title:
Show Source
ScopeAssignmentInstalledTimePhasedDataIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
scopeAssignmentInstalledTimePhasedDataId: integer
(int64)
The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.
-
scopeItemAssignCode: string
Maximum Length:
60
The user-specified unique identifier for the scope assignment. -
scopeItemAssignmentId: integer
(int64)
The unique identifier for the scope item assigned to the work package.
-
scopeItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ResourceWorkRateIdentifier
Type:
object
Title:
Show Source
ResourceWorkRateIdentifier
-
effectiveStartDate: string
(date-time)
Date that the corresponding units/time period and rates go into effect for the resource or role.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
resourceWorkRateId: integer
(int64)
The system-generated identifier of the work rate.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
-
workspaceResourceId: integer
(int64)
The unique identifier for the resource.The resource object can also be identified by its unique criteria.
Nested Schema : ReasonIdentifier
Type:
object
Title:
Show Source
ReasonIdentifier
-
reasonId: integer
(int64)
The unique identifier of a reason.
-
reasonName: string
Maximum Length:
255
The name of the reason for recommitting to a task. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : WorkManagerTaskIdentifier
Type:
object
Title:
Show Source
WorkManagerTaskIdentifier
-
itemCode: string
Maximum Length:
60
The user-specified unique identifier assigned to the task. -
project: integer
(int64)
The unique identifier for the project.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
workManagerTaskId: integer
(int64)
The unique identifier for the resource or role.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ChangeRequestIdentifier
Type:
object
Title:
Show Source
ChangeRequestIdentifier
-
changeRequestCode: string
Maximum Length:
60
The user-specified unique identifier of the change request. -
changeRequestId: integer
(int64)
The unique identifier of the change request.
-
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.
Nested Schema : ScopeItemAssignmentActivityIdentifier
Type:
object
Title:
Show Source
ScopeItemAssignmentActivityIdentifier
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier for the activity.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
scopeItemAssignmentActivityId: integer
(int64)
The system-generated identifier of a scope item.
-
scopeItemAssignmentCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
scopeItemAssignmentId: integer
(int64)
The unique identifier for the scope item assigned to the work package.
-
scopeItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : RiskScoreTypeIdentifier
Type:
object
Title:
Show Source
RiskScoreTypeIdentifier
-
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.
-
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.
-
riskScoreTypeId: integer
(int64)
The unique identifier of a score type.
-
riskScoreTypeName: string
Maximum Length:
255
The name of the risk score type. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : RiskMatrixIdentifier
Type:
object
Title:
Show Source
RiskMatrixIdentifier
-
matrixName: string
Maximum Length:
60
The name of the risk scoring matrix. -
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.
-
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.
-
riskMatrixId: integer
(int64)
The system-generated identifier of the risk matrix.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ProjectRiskIdentifier
Type:
object
Title:
Show Source
ProjectRiskIdentifier
-
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.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ProgramRiskIdentifier
Type:
object
Title:
Show Source
ProgramRiskIdentifier
-
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.
-
programRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ActivityRiskIdentifier
Type:
object
Title:
Show Source
ActivityRiskIdentifier
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier of an activity assigned to a risk.
-
activityRiskId: integer
(int64)
The unique identifier for the activity.The activity object can also be identified by its unique criteria.
-
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.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : RiskMitigationIdentifier
Type:
object
Title:
Show Source
RiskMitigationIdentifier
-
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.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
riskMitigationCode: string
Maximum Length:
60
The unique identifier for the risk response action item. -
riskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProgramRiskMitigationIdentifier
Type:
object
Title:
Show Source
ProgramRiskMitigationIdentifier
-
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.
-
programRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
programRiskMitigationCode: string
Maximum Length:
60
The unique identifier for the risk response action item. -
programRiskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProgramRiskWeatherPeriodIdentifier
Type:
object
Title:
Show Source
ProgramRiskWeatherPeriodIdentifier
-
periodName: string
Maximum Length:
255
The name of the period. -
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.
-
programRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
programRiskWeatherPeriodId: integer
(int64)
The system-generated identifier for the period.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : HolidayGroupIdentifier
Type:
object
Title:
Show Source
HolidayGroupIdentifier
-
holidayGroupName: string
Maximum Length:
60
The name of the holiday list. -
holidayListId: integer
(int64)
The unique identifier for the holiday list.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : RiskWeatherPeriodIdentifier
Type:
object
Title:
Show Source
RiskWeatherPeriodIdentifier
-
periodName: string
Maximum Length:
255
The name of the period. -
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.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
riskWeatherPeriodId: integer
(int64)
The system-generated identifier for the period.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : PortfolioIdentifier
Type:
object
Title:
Show Source
PortfolioIdentifier
-
name: string
Minimum Length:
1
Maximum Length:255
The name of the portfolio. -
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.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : PortfolioMeasureIdentifier
Type:
object
Title:
Show Source
PortfolioMeasureIdentifier
-
measureId: integer
(int64)
The unique identifier of a portfolio measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
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.
-
portfolioMeasureId: integer
(int64)
The unique identifier of a portfolio measure.
-
portfolioName: string
Maximum Length:
255
The name of the portfolio. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : EntityReferenceIdentifier
Type:
object
Title:
Show Source
EntityReferenceIdentifier
-
entityReferenceId: integer
(int64)
The system-generated identifier of a reference.
Nested Schema : PortfolioMeasureManualValueIdentifier
Type:
object
Title:
Show Source
PortfolioMeasureManualValueIdentifier
-
beginDate: string
(date-time)
The start date of a portfolio.
-
capitalPortfolioId: integer
(int64)
The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
-
endDate: string
(date-time)
The end date of the portfolio.
-
measureId: integer
(int64)
The unique identifier of a portfolio measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
portfolioMeasureManualValueId: integer
(int64)
The unique identifier of a portfolio measure.
-
portfolioName: string
Maximum Length:
255
The name of the portfolio. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : CustomLogTypeObjectIdentifier
Type:
object
Title:
Show Source
CustomLogTypeObjectIdentifier
-
customLogTypeObjectId: integer
(int64)
The system-generated identifier of custom log type object.
-
customLogTypeObjectName: string
The user-defined identifier of a custom log type object.
-
scope: string
Maximum Length:
40
Allowed Values:[ "project", "program", "workspace" ]
The scope of an object. -
scopeCode: string
The user-defined identifier of a reference to another object.
-
scopeId: integer
(int64)
The system-generated identifier of a reference to another object.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CustomLogItemIdentifier
Type:
object
Title:
Show Source
CustomLogItemIdentifier
-
customLogItemCode: string
Maximum Length:
60
A unique identifier unique of the custom log item. -
customLogItemId: integer
(int64)
The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.
-
customLogTypeObjectId: integer
(int64)
The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.
-
customLogTypeObjectName: string
The user-specified identifier of a custom log type.
-
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.
-
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 : ProjectRankIdentifier
Type:
object
Title:
Show Source
ProjectRankIdentifier
-
evaluationCategoryId: integer
(int64)
Evaluation category ID.
-
evaluationSubCategoryId: integer
(int64)
Evaluation subcategory ID.
-
projectId: integer
(int64)
The system-generated identifier of the project.
-
projectRankId: integer
(int64)
The system-generated identifier of the project rank.
Nested Schema : ProjectDependencyIdentifier
Type:
object
Title:
Show Source
ProjectDependencyIdentifier
-
dependentProjectCode: string
The project code of a project that has other projects that it relies on for support.
-
dependentProjectId: integer
(int64)
The unique identifier of a project that has other projects that it relies on for support.
-
dependentProjectWorkspaceCode: string
The workspace code of a project that has other projects that it relies on for support.#project invalid inputs
-
projectCode: string
The project code of a project that has other projects depending on it.
-
projectDependencyId: integer
(int64)
The unique identifier of a project dependency.
-
projectId: integer
(int64)
The unique identifier of a project that has other projects depending on it.
-
projectWorkspaceCode: string
The workspace code of a project that has other projects depending on it.
Nested Schema : LocationIdentifier
Type:
object
Title:
Show Source
LocationIdentifier
-
locationCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier of the location. -
locationId: integer
(int64)
The unique identifier for the location.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : MeasureIdentifier
Type:
object
Title:
Show Source
MeasureIdentifier
-
measureId: integer
(int64)
The unique identifier of a measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : MeasureThresholdIdentifier
Type:
object
Title:
Show Source
MeasureThresholdIdentifier
-
computeAgainstType: string
Allowed Values:
[ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ]
The against type of a threshold. -
desirableState: string
Allowed Values:
[ "HIGH_VALUES", "LOW_VALUES" ]
The type of direction of a threshold. -
measureId: integer
(int64)
The unique identifier of a measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
measureThresholdId: integer
(int64)
The unique identifier of a threshold.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ReportCycleIdentifier
Type:
object
Title:
Show Source
ReportCycleIdentifier
-
cycleName: string
Maximum Length:
255
The name of the reporting cycle. -
reportCycleId: integer
(int64)
The unique identifier of a report cycle.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : UnitsOfMeasureIdentifier
Type:
object
Title:
Show Source
UnitsOfMeasureIdentifier
-
key: string
Maximum Length:
60
The abbreviation for the unit of measure name. -
unitOfMeasureId: integer
(int64)
The unique identifier for the unit of measure.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : WorkspaceIdentifier
Type:
object
Title:
Show Source
WorkspaceIdentifier
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApplicationUserGroupIdentifier
Type:
object
Title:
Show Source
ApplicationUserGroupIdentifier
-
applicationUserGroupId: integer
(int64)
The unique identifier of a user group.
-
groupName: string
Minimum Length:
1
Maximum Length:255
Name of a user group. -
scope: string
Allowed Values:
[ "PROJECT", "WORKSPACE" ]
Type of a user group. -
scopeCode: string
The unique identifier for a project/workspace set by the user who created the project/workspace.
-
scopeId: integer
(int64)
The unique identifier of a project/workspace.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CalendarIdentifier
Type:
object
Title:
Show Source
CalendarIdentifier
-
calendarCode: string
Maximum Length:
255
The unique code for the calendar. -
calendarId: integer
(int64)
The unique identifier for the calendar.
-
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 : 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 : CostCategoryIdentifier
Type:
object
Title:
Show Source
CostCategoryIdentifier
-
abbreviation: string
Minimum Length:
1
Maximum Length:10
The abbreviation for the cost category name. -
costCategoryId: integer
(int64)
The system-generated identifier of a cost category.
-
costCategoryName: string
Minimum Length:
1
Maximum Length:255
The name of the cost category. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CurveIdentifier
Type:
object
Title:
Show Source
CurveIdentifier
-
curveId: integer
(int64)
The unique identifier of a curve.
-
curveName: string
Maximum Length:
255
The name of the curve profile. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : DocumentFolderStructureTemplateIdentifier
Type:
object
Title:
Show Source
DocumentFolderStructureTemplateIdentifier
-
documentFolderStructureTemplateId: integer
(int64)
The system-generated identifier of a document folder structure template.
-
templateName: string
Maximum Length:
255
The name of the document template. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : IdeaIdentifier
Type:
object
Title:
Show Source
IdeaIdentifier
-
ideaId: integer
(int64)
The system-generated identifier of an idea.
-
ideaName: string
The name of the Idea.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : OfficeIdentifier
Type:
object
Title:
Show Source
OfficeIdentifier
-
companyId: integer
(int64)
The system-generated identifier of a company.
-
companyName: string
Minimum Length:
1
Maximum Length:255
The name of the company. -
countryCode: string
Maximum Length:
3
The country for a location. -
officeId: integer
(int64)
The unique identifier of an office.
-
officeName: string
Minimum Length:
1
Maximum Length:255
The name of the office. -
postalCode: string
Maximum Length:
20
The postal code, post code, or zip code of a location.
Nested Schema : ProjectCompanyIdentifier
Type:
object
Title:
Show Source
ProjectCompanyIdentifier
-
companyId: integer
(int64)
The system-generated identifier of a company.
-
companyName: string
Minimum Length:
1
Maximum Length:255
The name of the company. -
postalCode: string
Maximum Length:
20
The postal code, post code, or zip code of a location. -
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectCompanyId: integer
(int64)
The system-generated unique identifier of the project company.
-
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ResourceDemandIdentifier
Type:
object
Title:
Show Source
ResourceDemandIdentifier
-
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.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceDemandId: integer
(int64)
The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
-
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProjectBudgetChangeIdentifier
Type:
object
Title:
Show Source
ProjectBudgetChangeIdentifier
-
budgetChangeCode: string
Maximum Length:
60
The unique identifier of the project budget change request. -
budgetChangeId: integer
(int64)
The system-generated identifier of a budget change.
-
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
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.
Nested Schema : ProjectBudgetTransferIdentifier
Type:
object
Title:
Show Source
ProjectBudgetTransferIdentifier
-
budgetTransferCode: string
Maximum Length:
60
The unique identifier of the project budget transfer request. -
budgetTransferId: integer
(int64)
The system-generated identifier of a budget transfer.
-
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
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.
Nested Schema : ProjectResourceWorkRateIdentifier
Type:
object
Title:
Show Source
ProjectResourceWorkRateIdentifier
-
effectiveStartDate: string
(date-time)
Date that the corresponding units/time period and rates go into effect for the resource or role.
-
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.
-
projectResourceId: integer
(int64)
The unique identifier of a project resource.
-
projectResourceWorkRateId: integer
(int64)
The unique identifier of a project work rate.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
The code of a resource of a project resource.
-
resourceId: integer
(int64)
The unique identifier for the resource.The resource object can also be identified by its unique criteria.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProjectActualsLineItemIdentifier
Type:
object
Title:
Show Source
ProjectActualsLineItemIdentifier
-
projectActualsCode: string
The user-specified identifier of a project actual.
-
projectActualsId: integer
(int64)
The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.
-
projectActualsLineItemCode: string
Maximum Length:
60
The user-specified unique identifier for an actual line item. -
projectActualsLineItemId: integer
(int64)
The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
-
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 : ProjectActualsIdentifier
Type:
object
Title:
Show Source
ProjectActualsIdentifier
-
projectActualsCode: string
The user-specified identifier of a project actual.
-
projectActualsId: integer
(int64)
The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
-
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.
Nested Schema : ProjectBudgetItemIdentifier
Type:
object
Title:
Show Source
ProjectBudgetItemIdentifier
-
budgetItemCode: string
Maximum Length:
60
The unique identifier of the project budget item. -
budgetItemId: integer
(int64)
The system-generated identifier of a budget item.
-
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
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.
Nested Schema : ProgramIdentifier
Type:
object
Title:
Show Source
ProgramIdentifier
-
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.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : StrategyIdentifier
Type:
object
Title:
Show Source
StrategyIdentifier
-
strategyId: integer
(int64)
The system-generated identifier of the strategy.
-
strategyName: string
The name of a strategy.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : StrategyTypeIdentifier
Type:
object
Title:
Show Source
StrategyTypeIdentifier
-
levelName: string
The name of a strategy.
-
strategyTypeId: integer
(int64)
The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : RuleOfCreditIdentifier
Type:
object
Title:
Show Source
RuleOfCreditIdentifier
-
rocId: integer
(int64)
Unique identifier of the rule of credit.
-
rocName: string
Minimum Length:
1
Maximum Length:255
The name of the rule of credit. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ResourceRoleAssignmentIdentifier
Type:
object
Title:
Show Source
ResourceRoleAssignmentIdentifier
-
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.
-
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
resourceRoleAssignmentId: integer
(int64)
The system-generated identifier of the resource role assignment.
-
roleCode: string
The user-specified identifier of the role.
-
roleId: integer
(int64)
The unique identifier for the role.The role object can also be identified by its unique criteria.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : BudgetPlanningScenarioIdentifier
Type:
object
Title:
Show Source
BudgetPlanningScenarioIdentifier
-
planPeriod: integer
(int32)
The period during which budget is allocated to projects within the plan.
This value determines the year in which budget planning timescales start.
You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
After the planning period for a budget plan has been set it cannot be changed. -
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.
-
portfolioName: string
Maximum Length:
255
The name of the portfolio. -
scenarioId: integer
(int64)
The system-generated identifier of the Budget Plan Scenario.
-
scenarioName: string
Maximum Length:
255
The name of Budget Plan Scenario. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ScopeAssignmentPlannedTimePhasedDataIdentifier
Type:
object
Title:
Show Source
ScopeAssignmentPlannedTimePhasedDataIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
scopeAssignmentPlannedTimePhasedDataId: integer
(int64)
The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.
-
scopeItemAssignCode: string
Maximum Length:
60
The user-specified unique identifier for the scope assignment. -
scopeItemAssignmentId: integer
(int64)
The unique identifier for the scope item assigned to the work package.
-
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProgramBudgetTransferIdentifier
Type:
object
Title:
Show Source
ProgramBudgetTransferIdentifier
-
programBudgetId: integer
(int64)
The system-generated identifier of a program budget.
-
programBudgetTransferCode: string
Maximum Length:
60
The unique identifier of the program budget transfer request. -
programBudgetTransferId: integer
(int64)
The system-generated identifier of a program budget transfer.
-
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.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ProgramBudgetChangeIdentifier
Type:
object
Title:
Show Source
ProgramBudgetChangeIdentifier
-
programBudgetChangeCode: string
Maximum Length:
60
The unique identifier of the program budget change request. -
programBudgetChangeId: integer
(int64)
The system-generated identifier of a program budget change.
-
programBudgetId: integer
(int64)
The system-generated identifier of a program budget.
-
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.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ActivityIdentifier
Type:
object
Title:
Show Source
ActivityIdentifier
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier for the activity.
-
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 : AssignmentIdentifier
Type:
object
Title:
Show Source
AssignmentIdentifier
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier for the activity.The activity object can also be identified by its unique criteria.
-
assignmentCode: string
Maximum Length:
60
A unique identifier for the assignment. -
assignmentId: integer
(int64)
The system-generated identifier of an assignment.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class of the resource of an assignment. -
resourceCode: string
The user-specified identifier of a resource.
-
resourceId: integer
(int64)
The unique identifier for the resource.The resource object can also be identified by its unique criteria.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : RelationshipIdentifier
Type:
object
Title:
Show Source
RelationshipIdentifier
-
predActivityCode: string
The code of the predecessor activity.
-
predActivityId: integer
(int64)
The unique identifier of the predecessor of an activity.
-
predProjectCode: string
The code of the project of the predecessor of an activity.
-
predWorkspaceCode: string
The code of the workspace of the predecessor of an activity.
-
relationshipId: integer
(int64)
The system-generated identifier of an activity relationship.
-
succActivityCode: string
The code of the successor activity.
-
succActivityId: integer
(int64)
The unique identifier of the successor of an activity.
-
succProjectCode: string
The code of the project of the successor of an activity.
-
succWorkspaceCode: string
The code of the workspace of the successor of an activity.
Nested Schema : FundActualIdentifier
Type:
object
Title:
Show Source
FundActualIdentifier
-
fundActualId: integer
(int64)
The system-generated identifier of a fund actual.
-
fundCode: string
The user-specified unique identifier of a fund.
-
fundId: integer
(int64)
The system-generated identifier of a fund.
-
projectActualsCode: string
Maximum Length:
60
The unique identifier for an actual. -
projectActualsId: integer
(int64)
The system-generated identifier of a project actual.
-
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 : ProgramBudgetItemIdentifier
Type:
object
Title:
Show Source
ProgramBudgetItemIdentifier
-
programBudgetId: integer
(int64)
The ID of the program budget.
-
programBudgetItemCode: string
Maximum Length:
60
The unique identifier of the program budget item. -
programBudgetItemId: integer
(int64)
The system-generated identifier for a budget.
-
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.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
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
400 Response
Invalid Input.