Batch Integrate Projects with an External Data Source
post
/primeapi/restapi/project/syncBatch
Send a request to this endpoint to create or update one or more integrated projects with an external data source.
Request
Supported Media Types
- application/json
The unique identifier of project data in an external source.S
Root Schema : List<ApiEntityExternallySourcedProject>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedProject>
Nested Schema : ApiEntityExternallySourcedProject
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. -
calendarCode:
string
The user-specified identifier of the project's assigned calendar.
-
calendarId:
integer(int64)
The unique identifier for the calendar.
-
cityName:
string
The city name for a location.
-
codeValuesProject:
array codeValuesProject
Unique Items Required:
true
The categories of a project. -
countryCode:
string
The country for a location.
-
currentApprovedFinishDate:
string(date-time)
The finish date for the Current Approved Budget set by the budget planner.
-
currentApprovedStartDate:
string(date-time)
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" ]
The type of an exchange rate. -
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
Read Only:
true
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
The autonumber settings of a project. -
projectCashFlows:
array projectCashFlows
The cash flow of a project.
-
projectCode:
string
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.
-
projectCurrencyCode:
string
The user-specified identifier of the project's assigned currency.
-
projectFinancial:
object ApiEntityProjectFinancial
-
projectId:
integer(int64)
The unique identifier for the project.
-
projectIntegrationType:
string
Allowed Values:
[ "P6", "UNIFIER" ]
Specifies if the project is integrated with another application. -
projectName:
string
Allowed Values:
[ "Length[1-255]" ]
The name of the project. -
projectSettings:
array projectSettings
Read Only:
true
Unique Items Required:true
-
proposedFinishDate:
string(date-time)
The finish date for the Proposed Budget of the project.
-
proposedStartDate:
string(date-time)
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:[ "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. -
riskMatrixCode:
string
The user-specified identifier of the project's assigned risk matrix.
-
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.
-
roleCommittedFte:
number
The total committed FTE. Calculated as total commitment units divided by total commitment duration.
-
roleDemandCommitDuration:
object Duration
-
roleDemandCommitEndDate:
string(date-time)
The finish date for committed demand data.
-
roleDemandCommitStartDate:
string(date-time)
The start date for committed demand data.
-
roleDemandCommittedUnit:
object Unit
-
roleDemandDuration:
object Duration
-
roleDemandEndDate:
string(date-time)
The finish date for the weekly demand data. Calculated as Start plus Total Demand.
-
roleDemandFte:
number
The total demand FTE. Calculated as total demand units divided by total demand duration.
-
roleDemandStartDate:
string(date-time)
The start date for weekly demand data.
-
roleDemandUnits:
object Unit
-
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
The unique identifier of a project in an external source.Example:
coarse
-
spendEffectiveDate:
string(date-time)
The month in which an actuals value was last added to the project.
-
spendFinishDate:
string(date-time)
The finish date for the project actuals.
-
spendStartDate:
string(date-time)
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", "COMPLETED" ]
The current status of a project.
Proposal: The project is a project proposal and has not been extensively planned nor accrued any costs.
Rejected: The project proposal has been rejected and will not be initiated as a project.
Planned: The project is currently planned for execution. Project managers input expected project costs and other project data during this stage.
Active: The project is currently active and being executed.
Inactive: The project has been rendered inactive and will temporarily accrue no costs.
Complete: The project has been successfully completed and will no longer accrue costs. -
street:
string
The first line of the address of a location.
This might be the building number and street address. -
street2:
string
The second line of the address of a location.
This might be a neighborhood or town. -
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 data date of a project.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
websiteUrl:
string
Allowed Values:
[ "Length[1-200]" ]
The link to a website related to the project. -
workspaceCode:
string
The user-specified identifier of the project's workspace.
-
workspaceId:
integer(int64)
The workspace the project is associated with.
Nested Schema : codeValuesProject
Type:
array
Unique Items Required:
true
The categories of a project.
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" ]
The mime type of an image associated with a project. -
link:
string(uri)
Read Only:
true
-
project:
integer(int64)
The system-generated identifier of a project.
-
projectImageId:
integer(int64)
The system-generated identifier of a project image.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : projectAutoNumber
Type:
array
Read Only:
true
Unique Items Required:
true
The autonumber settings of a project.
Show Source
Nested Schema : ApiEntityProjectConfiguredFields
Type:
Show Source
object
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a project.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe non-cost and non-text fields associated with a project.
-
project:
object ApiEntityProject
-
projectId:
integer(int64)
The unique identifier for the project.
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesThe text fields associated with a project.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
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
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
yearEndForecastCost:
object Cost
-
ytdSpendCost:
object Cost
Nested Schema : Unit
Type:
object
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.
-
link:
string(uri)
Read Only:
true
-
projectId:
integer(int64)
The unique identifier for the project.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
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" ]
The push down type of the workspace code. -
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
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
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
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
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
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:
[ "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER" ]
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.
-
suffix:
string
The first number in the auto numbering sequence.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
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.
-
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
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
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
The cost fields associated with a project.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The non-cost and non-text fields associated with a project.
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
The categories of a project. -
countryCode:
string
The country for a location.
-
currentApprovedFinishDate:
string(date-time)
The finish date for the Current Approved Budget set by the budget planner.
-
currentApprovedStartDate:
string(date-time)
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" ]
The type of an exchange rate. -
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
Read Only:
true
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
The autonumber settings of a project. -
projectCashFlows:
array projectCashFlows
The cash flow of a project.
-
projectCode:
string
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)
The unique identifier for the project.
-
projectIntegrationType:
string
Allowed Values:
[ "P6", "UNIFIER" ]
Specifies if the project is integrated with another application. -
projectName:
string
Allowed Values:
[ "Length[1-255]" ]
The name of the project. -
projectSettings:
array projectSettings
Read Only:
true
Unique Items Required:true
-
proposedFinishDate:
string(date-time)
The finish date for the Proposed Budget of the project.
-
proposedStartDate:
string(date-time)
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:[ "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
The unique identifier of a project in an external source.Example:
coarse
-
spendEffectiveDate:
string(date-time)
The month in which an actuals value was last added to the project.
-
spendFinishDate:
string(date-time)
The finish date for the project actuals.
-
spendStartDate:
string(date-time)
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", "COMPLETED" ]
The current status of a project.
Proposal: The project is a project proposal and has not been extensively planned nor accrued any costs.
Rejected: The project proposal has been rejected and will not be initiated as a project.
Planned: The project is currently planned for execution. Project managers input expected project costs and other project data during this stage.
Active: The project is currently active and being executed.
Inactive: The project has been rendered inactive and will temporarily accrue no costs.
Complete: The project has been successfully completed and will no longer accrue costs. -
strgyPriorityNum:
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 data date of a project.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
websiteUrl:
string
Allowed Values:
[ "Length[1-200]" ]
The link to a website related to the project. -
workspaceId:
integer(int64)
The workspace the project is associated with.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
The text fields associated with a project.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : codeValuesProject
Type:
array
Unique Items Required:
true
The categories of a project.
Show Source
Nested Schema : projectAutoNumber
Type:
array
Read Only:
true
Unique Items Required:
true
The autonumber settings of a project.
Show Source
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.
-
settingName:
string
The name of a project button.
-
settingValue:
string
Value of a project setting.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : additionalProperties
Type:
object
Response
Supported Media Types
- application/json
207 Response
Successful Sync Operation.
Nested Schema : ApiEntityERPSyncApiResponse
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
message:
string
-
primaryKey:
integer(int64)
-
primaryKeyName:
string
-
primaryKeyValue:
integer(int64)
-
sourceId:
string
-
statusCode:
integer(int32)
-
uniqueName:
string
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
400 Response
Invalid input for the Project service.