Create project risks
post
/primeapi/restapi/projectRisk/batch
Send a request to this endpoint to create project risks using json data provided in the request body.
Request
Supported Media Types
- application/json
Project Risks to be created.
Nested Schema : ApiEntityProjectRisk
Type:
Show Source
object
-
cause:
object RichTextString
-
cbsSheetCodeId:
integer(int64)
The cost breakdown structure code assigned to the risk.
-
codeValuesRisk:
array codeValuesRisk
Unique Items Required:
true
Code Values assigned to Project Risk. -
costCategoryId:
integer(int64)
The category name used to organize and define the cost.
-
costImpactQuantified:
boolean
Default Value:
false
When selected, the quantified cost distribution is used to determine the cost impact for each iteration. -
description:
object RichTextString
-
effect:
object RichTextString
-
hasPostResponseData:
boolean
Default Value:
false
-
identifiedById:
integer(int64)
-
identifiedDate:
string(date-time)
-
impacts:
array impacts
Unique Items Required:
true
-
itemPrefix:
string
The auto numbering prefix of a code.
-
itemSuffix:
integer(int64)
The auto numbering suffix of a code.
-
link:
string(uri)
Read Only:
true
-
ownerId:
integer(int64)
-
postScore:
integer(int32)
The risk calculation based on the post-response values defined for probability, cost impact, schedule impact, and any additional user-defined impacts for the risk.
-
probabilityImpactQuantified:
boolean
Default Value:
false
When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration. -
project:
object ApiEntityProject
-
projectId:
integer(int64)
-
projectRiskConfiguredFields:
object ApiEntityProjectRiskConfiguredFields
-
projectRiskFinancial:
object ApiEntityProjectRiskFinancial
-
projectRiskId:
integer(int64)
-
quantifiedPostResponseProbabilityThreshold:
number(double)
The probability threshold that a risk will occur after implementing a response action.
-
quantifiedPostResponseScheduleThreshold:
number(double)
The estimated impact size that the risk will have on the project schedule after implementing a response action.
-
quantifiedProbabilityThreshold:
number(double)
The estimated probability that a risk will occur before implementing a response action.
-
quantifiedScheduleThreshold:
number(double)
The estimated impact size that the risk will have on the project schedule before implementing a response action.
-
riskCategory:
object ApiEntityRiskCategory
-
riskCategoryId:
integer(int64)
The unique identifier for the risk type.
-
riskCode:
string
The unique identifier for the risk.
-
riskName:
string
The name of the risk.
-
riskQuantifiedCostImpact:
object ApiEntityRiskQuantifiedCostImpact
-
riskQuantifiedOtherImpacts:
array riskQuantifiedOtherImpacts
Unique Items Required:
true
projectRisk_resource_quantified_otherImpacts -
riskStatus:
string
Allowed Values:
[ "PROPOSED", "OPEN", "ACTIVE", "REJECTED", "MANAGED", "IMPACTED" ]
-
riskType:
string
Allowed Values:
[ "THREAT", "OPPORTUNITY" ]
The type of risk. Valid values are Threat and Opportunity. -
scheduleImpactQuantified:
boolean
Default Value:
false
When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration. -
score:
integer(int32)
The risk calculation based on the pre-response values defined for probability, cost impact, schedule impact, and any additional user-defined impacts for the risk.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : codeValuesRisk
Type:
array
Unique Items Required:
true
Code Values assigned to Project Risk.
Show Source
Nested Schema : ApiEntityProject
Type:
Show Source
object
-
actualDuration:
object Duration
-
actualFinish:
string(date-time)
The Actual Finish displays the date on which a project is considered complete.
This value can be entered manually or can be imported. -
actualLinkType:
string
Allowed Values:
[ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]
The field source for the actuals curve in cash flow. -
actualStart:
string(date-time)
The Actual Start indicates the date work on the project began.
This value can be entered manually or can be imported. -
addressLine1:
string
The first line of the address of a location.
This might be the building number and street address. -
addressLine2:
string
The second line of the address of a location.
This might be a neighborhood or town. -
calendarId:
integer(int64)
The unique identifier for the calendar.
-
cityName:
string
The city name for a location.
-
codeValuesProject:
array codeValuesProject
Unique Items Required:
true
Lists all project code types assigned to the project with its corresponding value. -
copyFromProjectId:
integer(int64)
Id of the project/template from which a new project/template has to be created. Project creation may take slightly longer to complete using this copy method.
-
countryCode:
string
The country for a location.
-
currentApprovedFinishDate:
string(date-time)
Read Only:
true
The finish date for the Current Approved Budget set by the budget planner. -
currentApprovedStartDate:
string(date-time)
Read Only:
true
The start date for the Current Approved Budget set by the budget planner. -
dataDate:
string(date-time)
The progress point, or "as-of date", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually.
The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities. -
description:
string
Allowed Values:
[ "Length[1-4000]" ]
The detailed summary for the project.
The description provides more information than short names or titles.
It can give background information or establish a purpose for the item.
These details help differentiate between items with similar names and are especially useful in multi-user environments. -
evaluationMatrixId:
integer(int64)
The evaluation matrix of a calendar.
-
evaluationScore:
object Percent
-
exchangeRateType:
string
Allowed Values:
[ "FLOATING", "PEGGED" ]
??CO_PROJECT,EXCH_RATE_TYPE?? -
finishDate:
string(date-time)
The date on which all project work is complete.
This value can be entered manually or can be imported. -
finishDateVariance:
object Duration
-
forecastFinishDate:
string(date-time)
The planned finish date of a project's remaining Forecast cost.
-
forecastLinkType:
string
Allowed Values:
[ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]
The field source for the forecast curve in cash flow. -
forecastStartDate:
string(date-time)
The planned start date of a project's remaining Forecast cost.
-
image:
object ApiEntityProjectImage
-
isPSyncManaged:
boolean
Read Only:
true
Default Value:false
Indicates the project is synchronized with P6 EPPM. -
isTemplateFlag:
boolean
Default Value:
false
Indicates the project is a template for creating other projects. -
lastProjectEvaluationDate:
string(date-time)
The date on which the project was last evaluated.
-
latitude:
number(double)
The geographical coordinate for the latitude of the location.
The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
link:
string(uri)
Read Only:
true
-
linkActualTo:
integer(int64)
Specifies data to which project actuals data is linked.
-
linkForecastTo:
integer(int64)
Specifies data to which a project forecast is linked.
-
linkForecastToSpend:
boolean
Default Value:
false
Enables you to link project Forecast data to project Actuals data.
When linked, any updates to the project's Actuals values will automatically be applied to the project's Forecast values. -
linkPlannedBudgetTo:
integer(int64)
Read Only:
true
Specifies data to which a project planned budget is linked. -
locationName:
string
A name for the location that your users will understand and recognize.
-
longitude:
number(double)
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
manager:
string
The manager or person responsible for the project.
-
mustFinishByDate:
string(date-time)
The latest date on which the scheduled activities must be complete for a project.
-
parentProject:
integer(int64)
Read Only:
true
The workspace the project is associated with. -
pegRate:
number
The custom exchange rate for a pegged exchange rate.
-
percentComplete:
object Percent
-
percentCompleteWeightedBy:
string
Read Only:
true
Allowed Values:[ "COST", "QUANTITY", "HOURS", "MANUAL" ]
The weight for scope items is calculated using quantity. -
planDuration:
object Duration
-
planEndDate:
string(date-time)
The finish date for the time phased Planned Budget of the project.
Planned Budget cost spread will adjust when this date is changed. -
plannedBudgetLinkType:
string
Allowed Values:
[ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]
The field source for the planned budget curve in cash flow. -
planStartDate:
string(date-time)
The start date for the time phased Planned Budget of the project.
Planned Budget cost spread will adjust when this date is changed.
The Project Planned Start also represents the earliest date that activities can occur within a project schedule. -
postalCode:
string
The postal code, post code, or zip code of a location.
-
priorityNum:
integer(int64)
The project's priority in the strategic plan.
This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data. -
projectAutoNumber:
array projectAutoNumber
Read Only:
true
Unique Items Required:true
Lists all project auto number fields with its corresponding value. -
projectCashFlows:
array projectCashFlows
Lists all project cost field spread data assigned to the project.
-
projectCode:
string
Title:
create
Allowed Values:[ "Length[1-60]" ]
The unique identifier for a project set by the user who created the project. -
projectConfiguredFields:
object ApiEntityProjectConfiguredFields
-
projectCurrency:
integer(int64)
The unique identifier of a currency.
-
projectFinancial:
object ApiEntityProjectFinancial
-
projectId:
integer(int64)
Title:
update
The unique identifier for the project. Should not be given for Create, required for Update methods. -
projectIntegrationType:
string
Allowed Values:
[ "P6", "UNIFIER" ]
Specifies if the project is integrated with another application. -
projectName:
string
Title:
create
Allowed Values:[ "Length[1-255]" ]
The name of the project. -
projectSettings:
array projectSettings
Read Only:
true
Unique Items Required:true
-
proposedFinishDate:
string(date-time)
Read Only:
true
The finish date for the Proposed Budget of the project. -
proposedStartDate:
string(date-time)
Read Only:
true
The start date for the Proposed Budget of the project. -
recordCount:
integer(int32)
The number of comments on a project.
-
remainingDuration:
object Duration
-
reportCycleId:
integer(int64)
The reporting cycle assigned to the project.
-
reportCycleNamingBoundary:
string
Read Only:
true
Allowed Values:[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
Determines when period names will be reset. The options available are based on the selection for Reporting Cycle. The standard calendar start and end dates are used as boundaries for resetting periods. -
riskLevel:
string
Allowed Values:
[ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ]
The risk level assigned to the project.
Projects can have a risk level of very high, high, medium, low, or very low.
You can use risk level to determine what projects should be included in your plans, as well as which projects should be of priority. -
riskMatrixId:
integer(int64)
The risk matrix assigned to the project for calculating project risk scores.
-
riskScore:
integer(int32)
The risk score value is based on the probability and impacts of a risk. It is derived from the probability impact matrix and any associated rules.
-
scheduledFinishDate:
string(date-time)
The calculated latest early finish date, which is based on the schedule most recently generated for the project.
-
securityGuid:
string
Read Only:
true
Globally unique identifier of a project. -
sequenceNumber:
integer(int32)
Determines the order of appearance of projects in a list.
-
sourceId:
string
Title:
sync
CO_PROJECT.EXT_SOURCE -
spendEffectiveDate:
string(date-time)
Read Only:
true
The month in which an actuals value was last added to the project. -
spendFinishDate:
string(date-time)
Read Only:
true
The finish date for the project actuals. -
spendStartDate:
string(date-time)
Read Only:
true
The start date for the project actuals. -
startDate:
string(date-time)
The date on which work on the project starts.
This value can be entered manually or can be imported. -
startDateVariance:
object Duration
-
stateCode:
string
A unique identifier for the state or province.
-
stateName:
string
The state, region, or province of a location.
-
status:
string
Allowed Values:
[ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETE" ]
The current status of a project.
Proposal: The project is a project proposal and has not been extensively planned nor accrued any costs.
Rejected: The project proposal has been rejected and will not be initiated as a project.
Planned: The project is currently planned for execution. Project managers input expected project costs and other project data during this stage.
Active: The project is currently active and being executed.
Inactive: The project has been rendered inactive and will temporarily accrue no costs.
Complete: The project has been successfully completed and will no longer accrue costs. -
strgyPriorityNum:
integer(int64)
The project's priority in the strategic plan.
This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data. -
summarizedDataDate:
string(date-time)
The project summarized data date.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
websiteUrl:
string
Allowed Values:
[ "Length[1-200]" ]
The link to a website related to the project. -
workspaceId:
integer(int64)
Title:
create
The workspace the project is associated with.
Nested Schema : ApiEntityProjectRiskConfiguredFields
Type:
Show Source
object
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesLists all configured cost fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesLists all configured date, number, integer fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
-
primaryKey:
integer(int64)
-
projectRisk:
object ApiEntityProjectRisk
-
projectRiskId:
integer(int64)
Project ID.
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesLists all configured text fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
-
uniqueName:
string
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityProjectRiskFinancial
Type:
Show Source
object
-
actualResponseCost:
object Cost
-
actualResponseCostProject:
object Cost
-
link:
string(uri)
Read Only:
true
-
plannedResponseCost:
object Cost
-
plannedResponseCostProject:
object Cost
-
postExposureCost:
object Cost
-
postExposureCostProject:
object Cost
-
postQuantifiedCostThreshold:
object Cost
-
postResponseExposureWorkspace1:
object Cost
-
postResponseExposureWorkspace2:
object Cost
-
postResponseExposureWorkspace3:
object Cost
-
preExposureCost:
object Cost
-
preExposureCostProject:
object Cost
-
preQuantifiedCostThreshold:
object Cost
-
preResponseExposureWorkspace1:
object Cost
-
preResponseExposureWorkspace2:
object Cost
-
preResponseExposureWorkspace3:
object Cost
-
projectRiskId:
integer(int64)
The unique identifier of a project.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRiskCategory
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
parentRiskCategory:
object ApiEntityRiskCategory
-
parentRiskCategoryId:
integer(int64)
The unique identifier of the parent of a risk type.
-
riskCategoryId:
integer(int64)
The unique identifier of a risk type.
-
riskCategoryName:
string
The category to which the risk belongs.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
object ApiEntityWorkspace
-
workspaceId:
integer(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityRiskQuantifiedCostImpact
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
postResponseDistributionShape:
string
Allowed Values:
[ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]
Determines the distribution that best models the three-point estimates for activity durations after a response. -
postResponseMaximum:
object Cost
-
postResponseMaximumProject:
object Cost
-
postResponseMaximumWorkspace1:
object Cost
-
postResponseMaximumWorkspace2:
object Cost
-
postResponseMaximumWorkspace3:
object Cost
-
postResponseMinimum:
object Cost
-
postResponseMinimumProject:
object Cost
-
postResponseMinimumWorkspace1:
object Cost
-
postResponseMinimumWorkspace2:
object Cost
-
postResponseMinimumWorkspace3:
object Cost
-
postResponseMostLikely:
object Cost
-
postResponseMostLikelyProject:
object Cost
-
postResponseMostLikelyWorkspace1:
object Cost
-
postResponseMostLikelyWorkspace2:
object Cost
-
postResponseMostLikelyWorkspace3:
object Cost
-
preResponseDistributionShape:
string
Allowed Values:
[ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]
Determines the distribution that best models the three-point estimates for activity durations before a response. -
preResponseMaximum:
object Cost
-
preResponseMaximumProject:
object Cost
-
preResponseMaximumWorkspace1:
object Cost
-
preResponseMaximumWorkspace2:
object Cost
-
preResponseMaximumWorkspace3:
object Cost
-
preResponseMinimum:
object Cost
-
preResponseMinimumProject:
object Cost
-
preResponseMinimumWorkspace1:
object Cost
-
preResponseMinimumWorkspace2:
object Cost
-
preResponseMinimumWorkspace3:
object Cost
-
preResponseMostLikely:
object Cost
-
preResponseMostLikelyProject:
object Cost
-
preResponseMostLikelyWorkspace1:
object Cost
-
preResponseMostLikelyWorkspace2:
object Cost
-
preResponseMostLikelyWorkspace3:
object Cost
-
projectRiskId:
integer(int64)
The unique identifier of a project.
-
quantifiedCostImpactId:
integer(int64)
The unique identifier of a cost impact.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : riskQuantifiedOtherImpacts
Type:
array
Unique Items Required:
true
projectRisk_resource_quantified_otherImpacts
Show Source
Nested Schema : ApiEntityCodeValueRisk
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueRiskId:
integer(int64)
The unique identifier of a risk code value.
-
link:
string(uri)
Read Only:
true
-
projectRiskId:
integer(int64)
The unique identifier of a project.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCodeType
Type:
Show Source
object
-
assignments:
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId:
integer(int64)
PRIMAVERA_DB_DOCUMENT:CO_CODE_TYPE,CODE_TYPE_ID
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link:
string(uri)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
WS_CODE_TYPE.PUSH_DOWN -
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]
The unique identifier for the code value. -
codeValueId:
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link:
string(uri)
Read Only:
true
-
parentCodeValue:
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
Indicates the type of object the code is associated to. -
link:
string(uri)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRiskImpact
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
postRiskScoreThresholdCode:
string
-
postRiskScoreThresholdId:
integer(int64)
The unique identifier for the post response impact threshold.
-
projectName:
string
-
projectRisk:
object ApiEntityProjectRisk
-
projectRiskId:
integer(int64)
The unique identifier of the project to which the risk is assigned.
-
riskCode:
string
-
riskImpactId:
integer(int64)
A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the scoretype.
-
riskScoreThreshold:
object ApiEntityRiskScoreThreshold
-
riskScoreThresholdCode:
string
-
riskScoreThresholdId:
integer(int64)
The threshold of the risk score.
-
riskScoreType:
object ApiEntityRiskScoreType
-
riskScoreTypeId:
integer(int64)
The risk score type.
-
riskScoreTypeName:
string
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRiskScoreThreshold
Type:
Show Source
object
-
color:
string
The color that represents the urgency of the risk.
-
level:
integer(int32)
The level of the risk threshold.
-
link:
string(uri)
Read Only:
true
-
lower:
number(double)
The lower limit of the risk score threshold range.
-
riskScoreThresholdCode:
string
The unique identifier for the risk scoring threshold.
-
riskScoreThresholdId:
integer(int64)
The unique ID of the risk score threshold.
-
riskScoreThresholdName:
string
The name of the risk threshold.
-
riskScoreType:
object ApiEntityRiskScoreType
-
riskScoreTypeId:
integer(int64)
The category to which the risk score belongs.
-
riskScoreTypeName:
string
The name of the risk score type.
-
stringValue:
string
The value of the string.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
upper:
number(double)
The upper limit of the risk score threshold range.
Nested Schema : ApiEntityRiskScoreType
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
projectId:
integer(int64)
The unique identifier of a project.
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
WS_RSK_SCORE_TYPE.PUSH_DOWN -
referencedScoreTypeId:
integer(int64)
The unique identifier of a copied score type.
-
riskScoreThresholds:
array riskScoreThresholds
Unique Items Required:
true
Risk Score Thresholds. -
riskScoreTypeId:
integer(int64)
The unique identifier of a score type.
-
riskScoreTypeName:
string
The name of the risk score type.
-
scoreType:
string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The type of risk score. -
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
object ApiEntityWorkspace
-
workspaceId:
integer(int64)
The unique identifier of a workspace.
Nested Schema : riskScoreThresholds
Type:
array
Unique Items Required:
true
Risk Score Thresholds.
Show Source
Nested Schema : ApiEntityWorkspace
Type:
Show Source
object
-
description:
string
Summary of the workspace.
-
image:
object ApiEntityWorkspaceImage
-
isProduction:
boolean
Read Only:
true
Default Value:false
Indicates a workspace that is in production.
All workspaces created under the Production workspace are automatically designated as production.
This cannot be changed. -
isSysGenerated:
boolean
Read Only:
true
Default Value:false
Indicates a workspace that was created by the system.
System generated workspaces cannot be deleted. -
link:
string(uri)
Read Only:
true
-
parentWorkspace:
integer(int64)
The unique identifier of the workspace hierarchically above another workspace.
-
securityGuid:
string
The Globally Unique Identifier of the workspace.
-
sequenceNumber:
integer(int32)
Determines the order of appearance of workspaces in a list.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceAutonumSettings:
array workspaceAutonumSettings
Unique Items Required:
true
workspace_entity_workspaceAutonumSettings -
workspaceCode:
string
Workspace Code.
-
workspaceId:
integer(int64)
The unique identifier of a workspace.
-
workspaceName:
string
Name of a workspace.
-
workspaceSettings:
array workspaceSettings
Unique Items Required:
true
workspace_entity_workspaceSettings
Nested Schema : ApiEntityWorkspaceImage
Type:
Show Source
object
-
image:
array image
An image object represented in binary format.
-
imageType:
string
Allowed Values:
[ "PNG", "JPEG", "GIF" ]
The file type of the image. Valid values are PNG, JPEG, and GIF. -
link:
string(uri)
Read Only:
true
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of the workspace that contains this image.
-
workspaceImageId:
integer(int64)
The unique identifier of the image.
Nested Schema : workspaceAutonumSettings
Type:
array
Unique Items Required:
true
workspace_entity_workspaceAutonumSettings
Show Source
Nested Schema : workspaceSettings
Type:
array
Unique Items Required:
true
workspace_entity_workspaceSettings
Show Source
Nested Schema : ApiEntityWorkspaceAutonumSetting
Type:
Show Source
object
-
area:
string
Allowed Values:
[ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]
Identifies the type of object used for auto numbering. -
autonumId:
integer(int64)
The unique identifier of an auto numbering sequence.
-
link:
string(uri)
Read Only:
true
-
name:
string
Name of the auto numbering sequence.
-
prefix:
string
Initial characters for the workspace auto numbering sequence.
-
suffix:
string
The first number in the workspace auto numbering sequence.
-
suffixIncrement:
integer(int32)
Number by which the auto numbering suffix is incremented.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityWorkspaceSetting
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
settingName:
string
Name of a workspace setting.
-
settingValue:
string
Value of a workspace setting.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of a workspace setting.
-
workspaceSettingId:
integer(int64)
The unique identifier of a workspace setting.
Nested Schema : codeValuesProject
Type:
array
Unique Items Required:
true
Lists all project code types assigned to the project with its corresponding value.
Show Source
Nested Schema : ApiEntityProjectImage
Type:
Show Source
object
-
image:
array image
The image file uploaded to the project.
Displayed throughout the application in areas like news feeds. -
imageType:
string
Allowed Values:
[ "PNG", "JPEG", "GIF" ]
AP_PROJECT_IMAGE.MIME_TYPE -
link:
string(uri)
Read Only:
true
-
project:
integer(int64)
AP_PROJECT_IMAGE.PROJ_ID
-
projectImageId:
integer(int64)
AP_PROJECT_IMAGE.PROJECT_IMAGE_ID Should not be given for Create, required for Update methods.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : projectAutoNumber
Type:
array
Read Only:
true
Unique Items Required:
true
Lists all project auto number fields with its corresponding value.
Show Source
Nested Schema : projectCashFlows
Type:
array
Lists all project cost field spread data assigned to the project.
Show Source
Nested Schema : ApiEntityProjectConfiguredFields
Type:
Show Source
object
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesCost fields assigned to the Project with its corresponding value as a (key,value) pair.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesOther fields assigned to the Project with its corresponding value as a (key,value) pair.
-
project:
object ApiEntityProject
-
projectId:
integer(int64)
The unique identifier for the project.
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesText fields assigned to the Project with its corresponding value as a (key,value) pair.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityProjectFinancial
Type:
Show Source
object
-
actualCost:
object Cost
-
allocatedFundApprovedBudgetVariance:
object Cost
-
allocatedFundForecastVariance:
object Cost
-
allocatedFundPlannedBudgetVariance:
object Cost
-
annualDiscountRate:
object Percent
-
atCompletionCost:
object Cost
-
constructionValue:
object Cost
-
costPerfIndex:
number(double)
The measure of a project's cost efficiency.
A value of less than 1 indicates the project is over budget, while a value greater than 1 indicates the project is under budget.
This value can be entered manually or can be imported. -
costVariance:
object Cost
-
currentApprovedBudget:
object Cost
-
currentApprovedBudgetBaseDistributed:
object Cost
-
currentApprovedBudgetBaseUndistributed:
object Cost
-
currentApprovedSpendVariance:
object Cost
-
earnedValueCost:
object Cost
-
estAtCompleteCost:
object Cost
-
estToCompleteCost:
object Cost
-
forecastCost:
object Cost
-
forecastCostDistributed:
object Cost
-
forecastCostUndistributed:
object Cost
-
forecastCurrApprVar:
object Cost
-
intRateReturn:
object Percent
-
link:
string(uri)
Read Only:
true
-
netPresentValue:
object Cost
-
paybackPeriod:
number(double)
The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected project.
This value can be entered manually or can be imported. -
plannedBudget:
object Cost
-
plannedBudgetDistributed:
object Cost
-
plannedBudgetUndistributed:
object Cost
-
plannedValueCost:
object Cost
-
profitabilityIndex:
number(double)
The index based on the value of a project's present values divided by initial project investments.
-
project:
object ApiEntityProject
-
projectId:
integer(int64)
The unique identifier for a project set by the user who created the project.
-
proposedBudget:
object Cost
-
proposedBudgetBaseDistributed:
object Cost
-
proposedBudgetBaseUndistributed:
object Cost
-
proposedForecastVariance:
object Cost
-
proposedPlannedVar:
object Cost
-
remainingCost:
object Cost
-
returnInvestment:
object Percent
-
schedPerfIndex:
number(double)
The measure of the work accomplished as a percentage of the work scheduled on a project.
Schedule Performance Index indicates whether you are meeting earned and planned values within your project schedule.
A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the project is ahead of schedule.
This value can be entered manually or can be imported. -
scheduleVariance:
object Cost
-
spendCost:
object Cost
-
spendForecastVar:
object Cost
-
spendPlannedVariance:
object Cost
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
yearEndForecastCost:
object Cost
-
ytdSpendCost:
object Cost
Nested Schema : ApiEntityCodeValueProject
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueProjectId:
integer(int64)
The unique identifier of the workspace where the code value was created. Should not be given for Create, required for Update methods.
-
link:
string(uri)
Read Only:
true
-
projectId:
integer(int64)
The unique identifier for the project.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : image
Type:
array
The image file uploaded to the project.
Displayed throughout the application in areas like news feeds.
Show Source
Displayed throughout the application in areas like news feeds.
Nested Schema : ApiEntityProjectAutoNumber
Type:
Show Source
object
-
area:
string
Allowed Values:
[ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]
Identifies the type of object used for auto numbering. -
increment:
integer(int32)
The number to increment the starting number by.
-
link:
string(uri)
Read Only:
true
-
name:
string
This is an internal field.
-
prefix:
string
Allowed Values:
[ "Length[1-20]" ]
The initial characters for the auto numbering sequence. -
projectAutoNumberId:
integer(int64)
The auto generated ID for the object. Should not be given for Create, required for Update methods.
-
suffix:
string
The first number in the auto numbering sequence.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityProjectCashFlow
Type:
Show Source
object
-
actualCost:
object Cost
-
actualForecastVar:
object Cost
-
atCompletionCost:
object Cost
-
currentApprovedBudget:
object Cost
-
currentApprovedSpendVariance:
object Cost
-
forecastCost:
object Cost
-
forecastCurrApprVar:
object Cost
-
link:
string(uri)
Read Only:
true
-
month:
integer(int32)
The time period during which budget planning for the project takes place in months.
-
plannedBudget:
object Cost
-
projectId:
integer(int64)
The unique identifier for the project.
-
projectPhaseFinancialId:
integer(int64)
The unique internal identifier for the project's time-phased cost spread. Should not be given for Create, required for Update methods.
-
proposedBudget:
object Cost
-
proposedForecastVariance:
object Cost
-
proposedPlannedVar:
object Cost
-
spendCost:
object Cost
-
spendForecastVar:
object Cost
-
spendPlannedVariance:
object Cost
-
spreadDate:
string(date-time)
The starting date for a time phase of the project life cycle.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
year:
integer(int32)
The time period during which budget planning for the project takes place in years.
-
yearEndBudger:
object Cost
-
yearEndForecastCost:
object Cost
-
ytdActualCost:
object Cost
-
ytdSpendCost:
object Cost
Nested Schema : Cost
Type:
object
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
Cost fields assigned to the Project with its corresponding value as a (key,value) pair.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
Other fields assigned to the Project with its corresponding value as a (key,value) pair.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
Text fields assigned to the Project with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : ApiEntityProjectSetting
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
projectId:
integer(int64)
The unique identifier of a project.
-
projectSettingId:
integer(int64)
The unique identifier of a project setting. Should not be given for Create, required for Update methods.
-
settingName:
string
The name of a project button.
-
settingValue:
string
Value of a project setting.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
Lists all configured cost fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
Lists all configured date, number, integer fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
Lists all configured text fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : ApiEntityRiskQuantifiedOtherImpact
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
maximum:
number(double)
The maximum probability that a risk event will occur.
-
minimum:
number(double)
The minimum probability that a risk event will occur.
-
mostLikely:
number(double)
The most likely probability that a risk event will occur.
-
preOrPostResponse:
string
Allowed Values:
[ "PRE_RESPONSE", "POST_RESPONSE" ]
Indicates whether a risk impact is measured pre or post response. -
projectRiskId:
integer(int64)
The unique identifier of a project.
-
quantifiedOtherImpactId:
integer(int64)
The unique identifier of a risk impact.
-
scoreType:
string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The type of an impact score. -
shape:
string
Allowed Values:
[ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]
The distribution that best models the three-point estimates for risk probabilities. -
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Nested Schema : ApiEntityProjectRisk
Type:
Show Source
object
-
cause:
object RichTextString
-
cbsSheetCodeId:
integer(int64)
The cost breakdown structure code assigned to the risk.
-
codeValuesRisk:
array codeValuesRisk
Unique Items Required:
true
Code Values assigned to Project Risk. -
costCategoryId:
integer(int64)
The category name used to organize and define the cost.
-
costImpactQuantified:
boolean
Default Value:
false
When selected, the quantified cost distribution is used to determine the cost impact for each iteration. -
description:
object RichTextString
-
effect:
object RichTextString
-
hasPostResponseData:
boolean
Default Value:
false
-
identifiedById:
integer(int64)
-
identifiedDate:
string(date-time)
-
impacts:
array impacts
Unique Items Required:
true
-
itemPrefix:
string
The auto numbering prefix of a code.
-
itemSuffix:
integer(int64)
The auto numbering suffix of a code.
-
link:
string(uri)
Read Only:
true
-
ownerId:
integer(int64)
-
postScore:
integer(int32)
The risk calculation based on the post-response values defined for probability, cost impact, schedule impact, and any additional user-defined impacts for the risk.
-
probabilityImpactQuantified:
boolean
Default Value:
false
When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration. -
project:
object ApiEntityProject
-
projectId:
integer(int64)
-
projectRiskConfiguredFields:
object ApiEntityProjectRiskConfiguredFields
-
projectRiskFinancial:
object ApiEntityProjectRiskFinancial
-
projectRiskId:
integer(int64)
-
quantifiedPostResponseProbabilityThreshold:
number(double)
The probability threshold that a risk will occur after implementing a response action.
-
quantifiedPostResponseScheduleThreshold:
number(double)
The estimated impact size that the risk will have on the project schedule after implementing a response action.
-
quantifiedProbabilityThreshold:
number(double)
The estimated probability that a risk will occur before implementing a response action.
-
quantifiedScheduleThreshold:
number(double)
The estimated impact size that the risk will have on the project schedule before implementing a response action.
-
riskCategory:
object ApiEntityRiskCategory
-
riskCategoryId:
integer(int64)
The unique identifier for the risk type.
-
riskCode:
string
The unique identifier for the risk.
-
riskName:
string
The name of the risk.
-
riskQuantifiedCostImpact:
object ApiEntityRiskQuantifiedCostImpact
-
riskQuantifiedOtherImpacts:
array riskQuantifiedOtherImpacts
Unique Items Required:
true
projectRisk_resource_quantified_otherImpacts -
riskStatus:
string
Allowed Values:
[ "PROPOSED", "OPEN", "ACTIVE", "REJECTED", "MANAGED", "IMPACTED" ]
-
riskType:
string
Allowed Values:
[ "THREAT", "OPPORTUNITY" ]
The type of risk. Valid values are Threat and Opportunity. -
scheduleImpactQuantified:
boolean
Default Value:
false
When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration. -
score:
integer(int32)
The risk calculation based on the pre-response values defined for probability, cost impact, schedule impact, and any additional user-defined impacts for the risk.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : codeValuesRisk
Type:
array
Unique Items Required:
true
Code Values assigned to Project Risk.
Show Source
Nested Schema : ApiEntityProject
Type:
Show Source
object
-
actualDuration:
object Duration
-
actualFinish:
string(date-time)
The Actual Finish displays the date on which a project is considered complete.
This value can be entered manually or can be imported. -
actualLinkType:
string
Allowed Values:
[ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]
The field source for the actuals curve in cash flow. -
actualStart:
string(date-time)
The Actual Start indicates the date work on the project began.
This value can be entered manually or can be imported. -
addressLine1:
string
The first line of the address of a location.
This might be the building number and street address. -
addressLine2:
string
The second line of the address of a location.
This might be a neighborhood or town. -
calendarId:
integer(int64)
The unique identifier for the calendar.
-
cityName:
string
The city name for a location.
-
codeValuesProject:
array codeValuesProject
Unique Items Required:
true
Lists all project code types assigned to the project with its corresponding value. -
copyFromProjectId:
integer(int64)
Id of the project/template from which a new project/template has to be created. Project creation may take slightly longer to complete using this copy method.
-
countryCode:
string
The country for a location.
-
currentApprovedFinishDate:
string(date-time)
Read Only:
true
The finish date for the Current Approved Budget set by the budget planner. -
currentApprovedStartDate:
string(date-time)
Read Only:
true
The start date for the Current Approved Budget set by the budget planner. -
dataDate:
string(date-time)
The progress point, or "as-of date", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually.
The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities. -
description:
string
Allowed Values:
[ "Length[1-4000]" ]
The detailed summary for the project.
The description provides more information than short names or titles.
It can give background information or establish a purpose for the item.
These details help differentiate between items with similar names and are especially useful in multi-user environments. -
evaluationMatrixId:
integer(int64)
The evaluation matrix of a calendar.
-
evaluationScore:
object Percent
-
exchangeRateType:
string
Allowed Values:
[ "FLOATING", "PEGGED" ]
??CO_PROJECT,EXCH_RATE_TYPE?? -
finishDate:
string(date-time)
The date on which all project work is complete.
This value can be entered manually or can be imported. -
finishDateVariance:
object Duration
-
forecastFinishDate:
string(date-time)
The planned finish date of a project's remaining Forecast cost.
-
forecastLinkType:
string
Allowed Values:
[ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]
The field source for the forecast curve in cash flow. -
forecastStartDate:
string(date-time)
The planned start date of a project's remaining Forecast cost.
-
image:
object ApiEntityProjectImage
-
isPSyncManaged:
boolean
Read Only:
true
Default Value:false
Indicates the project is synchronized with P6 EPPM. -
isTemplateFlag:
boolean
Default Value:
false
Indicates the project is a template for creating other projects. -
lastProjectEvaluationDate:
string(date-time)
The date on which the project was last evaluated.
-
latitude:
number(double)
The geographical coordinate for the latitude of the location.
The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
link:
string(uri)
Read Only:
true
-
linkActualTo:
integer(int64)
Specifies data to which project actuals data is linked.
-
linkForecastTo:
integer(int64)
Specifies data to which a project forecast is linked.
-
linkForecastToSpend:
boolean
Default Value:
false
Enables you to link project Forecast data to project Actuals data.
When linked, any updates to the project's Actuals values will automatically be applied to the project's Forecast values. -
linkPlannedBudgetTo:
integer(int64)
Read Only:
true
Specifies data to which a project planned budget is linked. -
locationName:
string
A name for the location that your users will understand and recognize.
-
longitude:
number(double)
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
manager:
string
The manager or person responsible for the project.
-
mustFinishByDate:
string(date-time)
The latest date on which the scheduled activities must be complete for a project.
-
parentProject:
integer(int64)
Read Only:
true
The workspace the project is associated with. -
pegRate:
number
The custom exchange rate for a pegged exchange rate.
-
percentComplete:
object Percent
-
percentCompleteWeightedBy:
string
Read Only:
true
Allowed Values:[ "COST", "QUANTITY", "HOURS", "MANUAL" ]
The weight for scope items is calculated using quantity. -
planDuration:
object Duration
-
planEndDate:
string(date-time)
The finish date for the time phased Planned Budget of the project.
Planned Budget cost spread will adjust when this date is changed. -
plannedBudgetLinkType:
string
Allowed Values:
[ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]
The field source for the planned budget curve in cash flow. -
planStartDate:
string(date-time)
The start date for the time phased Planned Budget of the project.
Planned Budget cost spread will adjust when this date is changed.
The Project Planned Start also represents the earliest date that activities can occur within a project schedule. -
postalCode:
string
The postal code, post code, or zip code of a location.
-
priorityNum:
integer(int64)
The project's priority in the strategic plan.
This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data. -
projectAutoNumber:
array projectAutoNumber
Read Only:
true
Unique Items Required:true
Lists all project auto number fields with its corresponding value. -
projectCashFlows:
array projectCashFlows
Lists all project cost field spread data assigned to the project.
-
projectCode:
string
Title:
create
Allowed Values:[ "Length[1-60]" ]
The unique identifier for a project set by the user who created the project. -
projectConfiguredFields:
object ApiEntityProjectConfiguredFields
-
projectCurrency:
integer(int64)
The unique identifier of a currency.
-
projectFinancial:
object ApiEntityProjectFinancial
-
projectId:
integer(int64)
Title:
update
The unique identifier for the project. Should not be given for Create, required for Update methods. -
projectIntegrationType:
string
Allowed Values:
[ "P6", "UNIFIER" ]
Specifies if the project is integrated with another application. -
projectName:
string
Title:
create
Allowed Values:[ "Length[1-255]" ]
The name of the project. -
projectSettings:
array projectSettings
Read Only:
true
Unique Items Required:true
-
proposedFinishDate:
string(date-time)
Read Only:
true
The finish date for the Proposed Budget of the project. -
proposedStartDate:
string(date-time)
Read Only:
true
The start date for the Proposed Budget of the project. -
recordCount:
integer(int32)
The number of comments on a project.
-
remainingDuration:
object Duration
-
reportCycleId:
integer(int64)
The reporting cycle assigned to the project.
-
reportCycleNamingBoundary:
string
Read Only:
true
Allowed Values:[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
Determines when period names will be reset. The options available are based on the selection for Reporting Cycle. The standard calendar start and end dates are used as boundaries for resetting periods. -
riskLevel:
string
Allowed Values:
[ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ]
The risk level assigned to the project.
Projects can have a risk level of very high, high, medium, low, or very low.
You can use risk level to determine what projects should be included in your plans, as well as which projects should be of priority. -
riskMatrixId:
integer(int64)
The risk matrix assigned to the project for calculating project risk scores.
-
riskScore:
integer(int32)
The risk score value is based on the probability and impacts of a risk. It is derived from the probability impact matrix and any associated rules.
-
scheduledFinishDate:
string(date-time)
The calculated latest early finish date, which is based on the schedule most recently generated for the project.
-
securityGuid:
string
Read Only:
true
Globally unique identifier of a project. -
sequenceNumber:
integer(int32)
Determines the order of appearance of projects in a list.
-
sourceId:
string
Title:
sync
CO_PROJECT.EXT_SOURCE -
spendEffectiveDate:
string(date-time)
Read Only:
true
The month in which an actuals value was last added to the project. -
spendFinishDate:
string(date-time)
Read Only:
true
The finish date for the project actuals. -
spendStartDate:
string(date-time)
Read Only:
true
The start date for the project actuals. -
startDate:
string(date-time)
The date on which work on the project starts.
This value can be entered manually or can be imported. -
startDateVariance:
object Duration
-
stateCode:
string
A unique identifier for the state or province.
-
stateName:
string
The state, region, or province of a location.
-
status:
string
Allowed Values:
[ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETE" ]
The current status of a project.
Proposal: The project is a project proposal and has not been extensively planned nor accrued any costs.
Rejected: The project proposal has been rejected and will not be initiated as a project.
Planned: The project is currently planned for execution. Project managers input expected project costs and other project data during this stage.
Active: The project is currently active and being executed.
Inactive: The project has been rendered inactive and will temporarily accrue no costs.
Complete: The project has been successfully completed and will no longer accrue costs. -
strgyPriorityNum:
integer(int64)
The project's priority in the strategic plan.
This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data. -
summarizedDataDate:
string(date-time)
The project summarized data date.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
websiteUrl:
string
Allowed Values:
[ "Length[1-200]" ]
The link to a website related to the project. -
workspaceId:
integer(int64)
Title:
create
The workspace the project is associated with.
Nested Schema : ApiEntityProjectRiskConfiguredFields
Type:
Show Source
object
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesLists all configured cost fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesLists all configured date, number, integer fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
-
primaryKey:
integer(int64)
-
projectRisk:
object ApiEntityProjectRisk
-
projectRiskId:
integer(int64)
Project ID.
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesLists all configured text fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
-
uniqueName:
string
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityProjectRiskFinancial
Type:
Show Source
object
-
actualResponseCost:
object Cost
-
actualResponseCostProject:
object Cost
-
link:
string(uri)
Read Only:
true
-
plannedResponseCost:
object Cost
-
plannedResponseCostProject:
object Cost
-
postExposureCost:
object Cost
-
postExposureCostProject:
object Cost
-
postQuantifiedCostThreshold:
object Cost
-
postResponseExposureWorkspace1:
object Cost
-
postResponseExposureWorkspace2:
object Cost
-
postResponseExposureWorkspace3:
object Cost
-
preExposureCost:
object Cost
-
preExposureCostProject:
object Cost
-
preQuantifiedCostThreshold:
object Cost
-
preResponseExposureWorkspace1:
object Cost
-
preResponseExposureWorkspace2:
object Cost
-
preResponseExposureWorkspace3:
object Cost
-
projectRiskId:
integer(int64)
The unique identifier of a project.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRiskCategory
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
parentRiskCategory:
object ApiEntityRiskCategory
-
parentRiskCategoryId:
integer(int64)
The unique identifier of the parent of a risk type.
-
riskCategoryId:
integer(int64)
The unique identifier of a risk type.
-
riskCategoryName:
string
The category to which the risk belongs.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
object ApiEntityWorkspace
-
workspaceId:
integer(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityRiskQuantifiedCostImpact
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
postResponseDistributionShape:
string
Allowed Values:
[ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]
Determines the distribution that best models the three-point estimates for activity durations after a response. -
postResponseMaximum:
object Cost
-
postResponseMaximumProject:
object Cost
-
postResponseMaximumWorkspace1:
object Cost
-
postResponseMaximumWorkspace2:
object Cost
-
postResponseMaximumWorkspace3:
object Cost
-
postResponseMinimum:
object Cost
-
postResponseMinimumProject:
object Cost
-
postResponseMinimumWorkspace1:
object Cost
-
postResponseMinimumWorkspace2:
object Cost
-
postResponseMinimumWorkspace3:
object Cost
-
postResponseMostLikely:
object Cost
-
postResponseMostLikelyProject:
object Cost
-
postResponseMostLikelyWorkspace1:
object Cost
-
postResponseMostLikelyWorkspace2:
object Cost
-
postResponseMostLikelyWorkspace3:
object Cost
-
preResponseDistributionShape:
string
Allowed Values:
[ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]
Determines the distribution that best models the three-point estimates for activity durations before a response. -
preResponseMaximum:
object Cost
-
preResponseMaximumProject:
object Cost
-
preResponseMaximumWorkspace1:
object Cost
-
preResponseMaximumWorkspace2:
object Cost
-
preResponseMaximumWorkspace3:
object Cost
-
preResponseMinimum:
object Cost
-
preResponseMinimumProject:
object Cost
-
preResponseMinimumWorkspace1:
object Cost
-
preResponseMinimumWorkspace2:
object Cost
-
preResponseMinimumWorkspace3:
object Cost
-
preResponseMostLikely:
object Cost
-
preResponseMostLikelyProject:
object Cost
-
preResponseMostLikelyWorkspace1:
object Cost
-
preResponseMostLikelyWorkspace2:
object Cost
-
preResponseMostLikelyWorkspace3:
object Cost
-
projectRiskId:
integer(int64)
The unique identifier of a project.
-
quantifiedCostImpactId:
integer(int64)
The unique identifier of a cost impact.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : riskQuantifiedOtherImpacts
Type:
array
Unique Items Required:
true
projectRisk_resource_quantified_otherImpacts
Show Source
Nested Schema : ApiEntityCodeValueRisk
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueRiskId:
integer(int64)
The unique identifier of a risk code value.
-
link:
string(uri)
Read Only:
true
-
projectRiskId:
integer(int64)
The unique identifier of a project.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCodeType
Type:
Show Source
object
-
assignments:
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId:
integer(int64)
PRIMAVERA_DB_DOCUMENT:CO_CODE_TYPE,CODE_TYPE_ID
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link:
string(uri)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
WS_CODE_TYPE.PUSH_DOWN -
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]
The unique identifier for the code value. -
codeValueId:
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link:
string(uri)
Read Only:
true
-
parentCodeValue:
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
Indicates the type of object the code is associated to. -
link:
string(uri)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRiskImpact
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
postRiskScoreThresholdCode:
string
-
postRiskScoreThresholdId:
integer(int64)
The unique identifier for the post response impact threshold.
-
projectName:
string
-
projectRisk:
object ApiEntityProjectRisk
-
projectRiskId:
integer(int64)
The unique identifier of the project to which the risk is assigned.
-
riskCode:
string
-
riskImpactId:
integer(int64)
A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the scoretype.
-
riskScoreThreshold:
object ApiEntityRiskScoreThreshold
-
riskScoreThresholdCode:
string
-
riskScoreThresholdId:
integer(int64)
The threshold of the risk score.
-
riskScoreType:
object ApiEntityRiskScoreType
-
riskScoreTypeId:
integer(int64)
The risk score type.
-
riskScoreTypeName:
string
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRiskScoreThreshold
Type:
Show Source
object
-
color:
string
The color that represents the urgency of the risk.
-
level:
integer(int32)
The level of the risk threshold.
-
link:
string(uri)
Read Only:
true
-
lower:
number(double)
The lower limit of the risk score threshold range.
-
riskScoreThresholdCode:
string
The unique identifier for the risk scoring threshold.
-
riskScoreThresholdId:
integer(int64)
The unique ID of the risk score threshold.
-
riskScoreThresholdName:
string
The name of the risk threshold.
-
riskScoreType:
object ApiEntityRiskScoreType
-
riskScoreTypeId:
integer(int64)
The category to which the risk score belongs.
-
riskScoreTypeName:
string
The name of the risk score type.
-
stringValue:
string
The value of the string.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
upper:
number(double)
The upper limit of the risk score threshold range.
Nested Schema : ApiEntityRiskScoreType
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
projectId:
integer(int64)
The unique identifier of a project.
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
WS_RSK_SCORE_TYPE.PUSH_DOWN -
referencedScoreTypeId:
integer(int64)
The unique identifier of a copied score type.
-
riskScoreThresholds:
array riskScoreThresholds
Unique Items Required:
true
Risk Score Thresholds. -
riskScoreTypeId:
integer(int64)
The unique identifier of a score type.
-
riskScoreTypeName:
string
The name of the risk score type.
-
scoreType:
string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The type of risk score. -
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
object ApiEntityWorkspace
-
workspaceId:
integer(int64)
The unique identifier of a workspace.
Nested Schema : riskScoreThresholds
Type:
array
Unique Items Required:
true
Risk Score Thresholds.
Show Source
Nested Schema : ApiEntityWorkspace
Type:
Show Source
object
-
description:
string
Summary of the workspace.
-
image:
object ApiEntityWorkspaceImage
-
isProduction:
boolean
Read Only:
true
Default Value:false
Indicates a workspace that is in production.
All workspaces created under the Production workspace are automatically designated as production.
This cannot be changed. -
isSysGenerated:
boolean
Read Only:
true
Default Value:false
Indicates a workspace that was created by the system.
System generated workspaces cannot be deleted. -
link:
string(uri)
Read Only:
true
-
parentWorkspace:
integer(int64)
The unique identifier of the workspace hierarchically above another workspace.
-
securityGuid:
string
The Globally Unique Identifier of the workspace.
-
sequenceNumber:
integer(int32)
Determines the order of appearance of workspaces in a list.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceAutonumSettings:
array workspaceAutonumSettings
Unique Items Required:
true
workspace_entity_workspaceAutonumSettings -
workspaceCode:
string
Workspace Code.
-
workspaceId:
integer(int64)
The unique identifier of a workspace.
-
workspaceName:
string
Name of a workspace.
-
workspaceSettings:
array workspaceSettings
Unique Items Required:
true
workspace_entity_workspaceSettings
Nested Schema : ApiEntityWorkspaceImage
Type:
Show Source
object
-
image:
array image
An image object represented in binary format.
-
imageType:
string
Allowed Values:
[ "PNG", "JPEG", "GIF" ]
The file type of the image. Valid values are PNG, JPEG, and GIF. -
link:
string(uri)
Read Only:
true
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of the workspace that contains this image.
-
workspaceImageId:
integer(int64)
The unique identifier of the image.
Nested Schema : workspaceAutonumSettings
Type:
array
Unique Items Required:
true
workspace_entity_workspaceAutonumSettings
Show Source
Nested Schema : workspaceSettings
Type:
array
Unique Items Required:
true
workspace_entity_workspaceSettings
Show Source
Nested Schema : ApiEntityWorkspaceAutonumSetting
Type:
Show Source
object
-
area:
string
Allowed Values:
[ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]
Identifies the type of object used for auto numbering. -
autonumId:
integer(int64)
The unique identifier of an auto numbering sequence.
-
link:
string(uri)
Read Only:
true
-
name:
string
Name of the auto numbering sequence.
-
prefix:
string
Initial characters for the workspace auto numbering sequence.
-
suffix:
string
The first number in the workspace auto numbering sequence.
-
suffixIncrement:
integer(int32)
Number by which the auto numbering suffix is incremented.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityWorkspaceSetting
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
settingName:
string
Name of a workspace setting.
-
settingValue:
string
Value of a workspace setting.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of a workspace setting.
-
workspaceSettingId:
integer(int64)
The unique identifier of a workspace setting.
Nested Schema : codeValuesProject
Type:
array
Unique Items Required:
true
Lists all project code types assigned to the project with its corresponding value.
Show Source
Nested Schema : ApiEntityProjectImage
Type:
Show Source
object
-
image:
array image
The image file uploaded to the project.
Displayed throughout the application in areas like news feeds. -
imageType:
string
Allowed Values:
[ "PNG", "JPEG", "GIF" ]
AP_PROJECT_IMAGE.MIME_TYPE -
link:
string(uri)
Read Only:
true
-
project:
integer(int64)
AP_PROJECT_IMAGE.PROJ_ID
-
projectImageId:
integer(int64)
AP_PROJECT_IMAGE.PROJECT_IMAGE_ID Should not be given for Create, required for Update methods.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : projectAutoNumber
Type:
array
Read Only:
true
Unique Items Required:
true
Lists all project auto number fields with its corresponding value.
Show Source
Nested Schema : projectCashFlows
Type:
array
Lists all project cost field spread data assigned to the project.
Show Source
Nested Schema : ApiEntityProjectConfiguredFields
Type:
Show Source
object
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesCost fields assigned to the Project with its corresponding value as a (key,value) pair.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesOther fields assigned to the Project with its corresponding value as a (key,value) pair.
-
project:
object ApiEntityProject
-
projectId:
integer(int64)
The unique identifier for the project.
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesText fields assigned to the Project with its corresponding value as a (key,value) pair.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityProjectFinancial
Type:
Show Source
object
-
actualCost:
object Cost
-
allocatedFundApprovedBudgetVariance:
object Cost
-
allocatedFundForecastVariance:
object Cost
-
allocatedFundPlannedBudgetVariance:
object Cost
-
annualDiscountRate:
object Percent
-
atCompletionCost:
object Cost
-
constructionValue:
object Cost
-
costPerfIndex:
number(double)
The measure of a project's cost efficiency.
A value of less than 1 indicates the project is over budget, while a value greater than 1 indicates the project is under budget.
This value can be entered manually or can be imported. -
costVariance:
object Cost
-
currentApprovedBudget:
object Cost
-
currentApprovedBudgetBaseDistributed:
object Cost
-
currentApprovedBudgetBaseUndistributed:
object Cost
-
currentApprovedSpendVariance:
object Cost
-
earnedValueCost:
object Cost
-
estAtCompleteCost:
object Cost
-
estToCompleteCost:
object Cost
-
forecastCost:
object Cost
-
forecastCostDistributed:
object Cost
-
forecastCostUndistributed:
object Cost
-
forecastCurrApprVar:
object Cost
-
intRateReturn:
object Percent
-
link:
string(uri)
Read Only:
true
-
netPresentValue:
object Cost
-
paybackPeriod:
number(double)
The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected project.
This value can be entered manually or can be imported. -
plannedBudget:
object Cost
-
plannedBudgetDistributed:
object Cost
-
plannedBudgetUndistributed:
object Cost
-
plannedValueCost:
object Cost
-
profitabilityIndex:
number(double)
The index based on the value of a project's present values divided by initial project investments.
-
project:
object ApiEntityProject
-
projectId:
integer(int64)
The unique identifier for a project set by the user who created the project.
-
proposedBudget:
object Cost
-
proposedBudgetBaseDistributed:
object Cost
-
proposedBudgetBaseUndistributed:
object Cost
-
proposedForecastVariance:
object Cost
-
proposedPlannedVar:
object Cost
-
remainingCost:
object Cost
-
returnInvestment:
object Percent
-
schedPerfIndex:
number(double)
The measure of the work accomplished as a percentage of the work scheduled on a project.
Schedule Performance Index indicates whether you are meeting earned and planned values within your project schedule.
A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the project is ahead of schedule.
This value can be entered manually or can be imported. -
scheduleVariance:
object Cost
-
spendCost:
object Cost
-
spendForecastVar:
object Cost
-
spendPlannedVariance:
object Cost
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
yearEndForecastCost:
object Cost
-
ytdSpendCost:
object Cost
Nested Schema : ApiEntityCodeValueProject
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueProjectId:
integer(int64)
The unique identifier of the workspace where the code value was created. Should not be given for Create, required for Update methods.
-
link:
string(uri)
Read Only:
true
-
projectId:
integer(int64)
The unique identifier for the project.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : image
Type:
array
The image file uploaded to the project.
Displayed throughout the application in areas like news feeds.
Show Source
Displayed throughout the application in areas like news feeds.
Nested Schema : ApiEntityProjectAutoNumber
Type:
Show Source
object
-
area:
string
Allowed Values:
[ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]
Identifies the type of object used for auto numbering. -
increment:
integer(int32)
The number to increment the starting number by.
-
link:
string(uri)
Read Only:
true
-
name:
string
This is an internal field.
-
prefix:
string
Allowed Values:
[ "Length[1-20]" ]
The initial characters for the auto numbering sequence. -
projectAutoNumberId:
integer(int64)
The auto generated ID for the object. Should not be given for Create, required for Update methods.
-
suffix:
string
The first number in the auto numbering sequence.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityProjectCashFlow
Type:
Show Source
object
-
actualCost:
object Cost
-
actualForecastVar:
object Cost
-
atCompletionCost:
object Cost
-
currentApprovedBudget:
object Cost
-
currentApprovedSpendVariance:
object Cost
-
forecastCost:
object Cost
-
forecastCurrApprVar:
object Cost
-
link:
string(uri)
Read Only:
true
-
month:
integer(int32)
The time period during which budget planning for the project takes place in months.
-
plannedBudget:
object Cost
-
projectId:
integer(int64)
The unique identifier for the project.
-
projectPhaseFinancialId:
integer(int64)
The unique internal identifier for the project's time-phased cost spread. Should not be given for Create, required for Update methods.
-
proposedBudget:
object Cost
-
proposedForecastVariance:
object Cost
-
proposedPlannedVar:
object Cost
-
spendCost:
object Cost
-
spendForecastVar:
object Cost
-
spendPlannedVariance:
object Cost
-
spreadDate:
string(date-time)
The starting date for a time phase of the project life cycle.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
year:
integer(int32)
The time period during which budget planning for the project takes place in years.
-
yearEndBudger:
object Cost
-
yearEndForecastCost:
object Cost
-
ytdActualCost:
object Cost
-
ytdSpendCost:
object Cost
Nested Schema : Cost
Type:
object
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
Cost fields assigned to the Project with its corresponding value as a (key,value) pair.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
Other fields assigned to the Project with its corresponding value as a (key,value) pair.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
Text fields assigned to the Project with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : ApiEntityProjectSetting
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
projectId:
integer(int64)
The unique identifier of a project.
-
projectSettingId:
integer(int64)
The unique identifier of a project setting. Should not be given for Create, required for Update methods.
-
settingName:
string
The name of a project button.
-
settingValue:
string
Value of a project setting.
-
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
Lists all configured cost fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
Lists all configured date, number, integer fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
Lists all configured text fields assigned to the Project Risk with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : ApiEntityRiskQuantifiedOtherImpact
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
maximum:
number(double)
The maximum probability that a risk event will occur.
-
minimum:
number(double)
The minimum probability that a risk event will occur.
-
mostLikely:
number(double)
The most likely probability that a risk event will occur.
-
preOrPostResponse:
string
Allowed Values:
[ "PRE_RESPONSE", "POST_RESPONSE" ]
Indicates whether a risk impact is measured pre or post response. -
projectRiskId:
integer(int64)
The unique identifier of a project.
-
quantifiedOtherImpactId:
integer(int64)
The unique identifier of a risk impact.
-
scoreType:
string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The type of an impact score. -
shape:
string
Allowed Values:
[ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]
The distribution that best models the three-point estimates for risk probabilities. -
updateDate:
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
400 Response
Invalid input.