Batch Update Activities
put
/api/restapi/activity/batch
Send a request to this endpoint to update one or more activities. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityActivityInput>
Type:
array
Title:
Show Source
List<ApiEntityActivityInput>
-
Array of:
object ApiEntityActivityInput
Title:
ApiEntityActivityInput
This entity represents a Activity object, a unique Activity object can be identified by the following combinations of the fields.- activityId
- activityCode,projectId
- activityCode,projectCode,workspaceCode
Nested Schema : ApiEntityActivityInput
Type:
object
Title:
ApiEntityActivityInput
This entity represents a Activity object, a unique Activity object can be identified by the following combinations of the fields.
Show Source
- activityId
- activityCode,projectId
- activityCode,projectCode,workspaceCode
-
accountingVarianceLaborUnits: number
(double)
The difference between the planned value of work scheduled and the actual work performed.
-
activityCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of the activity. -
activityFinancial:
activityFinancial
An object containing the financial fields of an activity in the form of key-value pairs.
-
activityId: integer
(int64)
The unique identifier for the activity.
-
activityName: string
Minimum Length:
1
Maximum Length:255
The name of the activity. -
activityPercentComplete: number
(double)
The percentage of the activity that has been completed.
This value is based on the formula for the selected Percent Complete Type. The Percent Complete Type can be Physical, Duration, Units, or Scope.
Physical: The user records the percent complete manually.
Duration: Calculated as (Planned Duration minus Remaining Duration) divided by Planned Duration, multiplied by 100.
Units: Calculated as (Actual Labor Units plus Actual Nonlabor Units) divided by (Actual Labor Units plus Actual Nonlabor Units plus Remaining Labor Units plus Remaining Nonlabor Units), multiplied by 100.
Scope: Calculated as Installed Quantity divided by At Completion Quantity, multiplied by 100. -
activityPriority: string
Allowed Values:
[ "TOP", "HIGH", "NORMAL", "LOW", "LOWEST" ]
Determines the priority of the activity when performing role leveling. -
activityStatus: string
Allowed Values:
[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ]
Determines the status of the activity. Valid values are Not Started, In Progress, and Completed. -
activityType: string
Allowed Values:
[ "ACTIVITY", "RESOURCE_DEPENDENT", "LEVEL_OF_EFFORT", "START_MILESTONE", "FINISH_MILESTONE", "WBS_SUMMARY" ]
The type of activity. Valid values are Activity Dependent, Resource Dependent, Level of Effort, Start Milestone, and Finish Milestone. -
activityUncertainties: array
activityUncertainties
The uncertainties associated with an activity.
-
actualFinish: string
(date-time)
The date when the activity was completed.
-
actualLaborUnits: number
(double)
The number of units expended for all labor resources assigned to the activity.
-
actualNonLaborUnits: number
(double)
The number of nonlabor units that have been expended on the activity.
-
actualStart: string
(date-time)
The date work on the activity began.
-
actualThisPeriodLaborUnits: number
(double)
The number of labor units used during this financial period.
-
actualThisPeriodNonLaborUnits: number
(double)
The nonlabor units used during this financial period.
-
atCompletionDuration: number
(double)
Minimum Value:
0
Maximum Value:10000000
The total working time from the activity's current start date to the current finish date.
The current start date is the planned start date until the activity is started, and then it is the actual start date. The current finish date is the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. The total working time is calculated using the activity's calendar. -
atCompletionLaborUnits: number
(double)
The sum of the actual plus remaining units for all labor resources assigned to the activity.
It is the same as the planned labor units if the activity is not started, and the actual labor units after the activity is completed.
Calculated as Actual Labor Units plus Remaining Labor Units. -
atCompletionNonLaborUnits: number
(double)
The sum of the actual plus remaining units for all nonlabor resources assigned to the activity.
It is the same as the planned nonlabor units if the activity is not started, and the actual nonlabor units after the activity is completed.
Calculated as Actual Nonlabor Units plus Remaining Nonlabor Units. -
calendar: integer
(int64)
The calendar assigned to the activity.
-
calendarName: string
Minimum Length:
0
Maximum Length:255
The name of the calendar. -
codeValuesActivity: array
codeValuesActivity
The list of code values for an activity. This entity can only be used to assign codeValues or create codeValues on the fly.
-
configuredFields: array
configuredFields
The list of configured fields for an activity.
-
constraintDate: string
(date-time)
The constraint date for the activity, if the activity has a constraint.
-
constraintType: string
Allowed Values:
[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ]
The main restriction impacting the activity start or finish date. -
durationType: string
Allowed Values:
[ "FIXED_RATE", "FIXED_QUANTITY", "FIXED_DURATION_AND_UNITS", "FIXED_DURATION" ]
Determines how remaining duration, units, and units/time are calculated when you update an activity that has resources assigned. The valid values are Fixed Units/Time, Fixed Units, Fixed Duration & Units, and Fixed Duration & Units/Time. -
earlyFinish: string
(date-time)
The earliest possible date the activity can finish.
This date is calculated based on network logic, schedule constraints, and resource availability. -
earlyStart: string
(date-time)
The earliest possible date the remaining work for the activity can begin.
This date is calculated based on network logic, schedule constraints, and resource availability. -
expectedFinish: string
(date-time)
The date you expect work on the activity to finish.
-
finishDate: string
(date-time)
The current finish date for the activity.
-
floatPath: integer
(int64)
Indicates which critical path the activity is on. An activity with a floatPath value of 1 is on the most critical path, whereas an activity with a floatPath value of 2 is on the second most critical path, and so on.
-
floatPathOrder: integer
(int64)
The position of the activity on its critical path.
-
lateFinish: string
(date-time)
The latest possible date the activity can finish without delaying the project finish date.
This date is calculated based on activity relationships, schedule constraints, and resource availability. -
lateStart: string
(date-time)
The latest possible date the remaining work for the activity can begin without delaying the project finish date.
This date is calculated based on activity relationships, schedule constraints, and resource availability. -
owner: string
Maximum Length:
255
The user responsible for the activity. -
percentCompleteType: string
Allowed Values:
[ "PHYSICAL", "DURATION", "UNITS", "SCOPE" ]
Determines the way in which the application calculates the percent complete for the activity.
Physical: Percent complete is manually entered by a user based on the amount of physical work completed on the activity.
Duration: Percent complete is calculated from the actual and remaining duration.
Units: Percent complete is calculated from the actual and remaining units.
Scope: The percent complete for the activity is derived from the scope percent complete of the linked scope assignments. -
percentCompleteWeightedBy: string
Allowed Values:
[ "COST", "QUANTITY", "HOURS", "MANUAL" ]
The method used to calculate the scope percentage completion for scope assignments. The weight is calculated using cost, quantity, hours, or manually entered values. -
physicalPercentComplete: number
(double)
The activity percent complete, manually entered by a user.
-
plannedDuration: number
(double)
Minimum Value:
0
Maximum Value:10000000
The expected amount of time required to complete an activity.
The planned working time is calculated using the activity's calendar. The duration is measured from the activity's planned start date to its planned finish date. -
plannedFinish: string
(date-time)
The date the activity is scheduled to finish if the activity has not started.
This date is calculated by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has started. -
plannedLaborUnits: number
(double)
The planned number of units for all labor resources assigned to the activity.
-
plannedNonLaborUnits: number
(double)
The planned units for all nonlabor resources assigned to the activities in the project.
-
plannedStart: string
(date-time)
The date the activity is scheduled to start.
This date the activity is scheduled to begin is calculated by the project scheduler but can be updated manually by the project manager. This date cannot be changed by the project scheduler after the activity has started. -
programMilestone: boolean
Display Milestone on Program.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
remainingDuration: number
(double)
Minimum Value:
0
Maximum Value:10000000
The total working time from the activity remaining start date to the remaining finish date. -
remainingFinish: string
(date-time)
The date the remaining work for the activity is scheduled to finish.
If this activity is not started, this date is the planned finish. This date can be updated manually by the user, but it is overwritten when you schedule the project. -
remainingLaborUnits: number
(double)
The remaining units for all labor resources assigned to the activity.
The Remaining Labor Units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero. -
remainingLateFinish: string
(date-time)
The latest possible date the activity must finish without delaying the project finish date.
This date is calculated by the project scheduler based on activity relationships, schedule constraints, and resource availability. When the activity is complete, this field is blank. -
remainingLateStart: string
(date-time)
The latest possible date the remaining work for the activity must begin without delaying the project finish date.
This date is calculated by the project scheduler based on activity relationship, schedule constraints, and resource availability. -
remainingNonLaborUnits: number
(double)
The remaining units for all nonlabor resources assigned to the activity.
The remaining units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, there are zero remaining units. -
remainingStart: string
(date-time)
The date the remaining work for the activity is scheduled to begin.
This date can be updated manually by the user. Before the activity is started, this date is the same as the planned start. -
resumeDate: string
(date-time)
The date when a suspended task or activity is resumed.
-
secondaryConstraintDate: string
(date-time)
The date for the activity's secondary constraint, if the activity has a secondary constraint.
-
secondaryConstraintType: string
Allowed Values:
[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ]
The secondary restriction impacting the activity start or finish date. -
sequenceNumber: integer
(int32)
The number that specifies the position of the activity relative to others within the view.
-
startDate: string
(date-time)
The current start date of the activity.
For started activities, this is the actual start date. For not started activities, this is the planned start date until the project is scheduled. When scheduled, the start date field is set to the remaining early start date. -
suspendDate: string
(date-time)
The date work has temporarily stopped on a given activity.
-
wbscodes: array
wbscodes
List of WBS codes in hierarchy.
-
wbsId: integer
(int64)
The WBS that the activity is associated with.
-
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workPackageId: integer
(int64)
The unique identifier for the work package that the activity is associated with.
-
workPackageName: string
Minimum Length:
1
Maximum Length:255
The name of the work package. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : activityFinancial
An object containing the financial fields of an activity in the form of key-value pairs.
Match All
An object containing the financial fields of an activity in the form of key-value pairs.
Show Source
-
object
ApiEntityActivityFinancialInput
Title:
ApiEntityActivityFinancialInput
Nested Schema : activityUncertainties
Type:
array
The uncertainties associated with an activity.
Show Source
-
Array of:
object ApiEntityActivityUncertaintyInput
Title:
ApiEntityActivityUncertaintyInput
This entity represents a ActivityUncertainty object, a unique ActivityUncertainty object can be identified by the following combinations of the fields.- activityUncertaintyId
Nested Schema : codeValuesActivity
Type:
array
The list of code values for an activity. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueActivityInput
Title:
ApiEntityCodeValueActivityInput
This entity represents a CodeValueActivity object, a unique CodeValueActivity object can be identified by the following combinations of the fields.- codeValueActivityId
- codeValueId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeTypeCode,parentId,codeValueCode
- codeValueCode,codeTypeId,parentId
- codeTypeCode,codeValueCode,projectCode
- codeTypeCode,codeValueCode,projectId
- codeTypeCode,codeValueCode,parentId,projectCode
- codeTypeCode,codeValueCode,parentId,projectId
Nested Schema : configuredFields
Type:
array
The list of configured fields for an activity.
Show Source
-
Array of:
object ApiEntityActivityConfiguredFieldValueInput
Title:
ApiEntityActivityConfiguredFieldValueInput
This entity represents a ActivityConfiguredFieldValue object, a unique ActivityConfiguredFieldValue object can be identified by the following combinations of the fields.- activityConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : ApiEntityActivityFinancialInput
Type:
object
Title:
Show Source
ApiEntityActivityFinancialInput
-
activityId: integer
(int64)
The unique identifier of the activity.
-
actualLaborCost: number
(double)
The actual costs for all labor resources assigned to the activity. This field is in base currency and is calculated from actualLaborCostProject field based on the specified exchange rate.
-
actualLaborCostProject: number
(double)
The actual costs for all labor resources assigned to the activity. This value is based on the project currency.
-
actualMaterialCost: number
(double)
The actual cost for all material resources assigned to the activity. This field is in base currency and is calculated from actualMaterialCostProject field based on the specified exchange rate.
-
actualMaterialCostProject: number
(double)
The actual cost for all material resources assigned to the activity. This value is based on the project currency.
-
actualNonLaborCost: number
(double)
The actual costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from actualNonLaborCostProject field based on the specified exchange rate.
-
actualNonLaborCostProject: number
(double)
The actual costs for all nonlabor resources assigned to the activity. This value is based on the project currency.
-
actualThisPeriodLaborCost: number
(double)
The labor costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodLaborCostProject field based on the specified exchange rate.
-
actualThisPeriodLaborCostProject: number
(double)
The aggregation of all labor costs incurred during the current financial period. This value is based on the project currency.
-
actualThisPeriodMaterialCost: number
(double)
The material costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodMaterialCostProject field based on the specified exchange rate.
-
actualThisPeriodMaterialCostProject: number
(double)
The aggregation of all material costs incurred during the current financial period. This value is based on the project currency.
-
actualThisPeriodNonLaborCost: number
(double)
The nonlabor costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodNonLaborCostProject field based on the specified exchange rate.
-
actualThisPeriodNonLaborCostProject: number
(double)
The aggregation of all nonlabor costs incurred during the current financial period. This value is based on the project currency.
-
atCompletionLaborCost: number
(double)
The sum of the actual and remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from atCompletionLaborCostProject field based on the specified exchange rate.
-
atCompletionLaborCostProject: number
(double)
The sum of the actual costs plus remaining costs for all labor resource assignments on the activity. This value is based on the project currency.
-
atCompletionMaterialCost: number
(double)
The sum of the actual and remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from atCompletionMaterialCostProject field based on the specified exchange rate.
-
atCompletionMaterialCostProject: number
(double)
The sum of the actual costs plus remaining costs for all material resource assignments on the activity. This value is based on the project currency.
-
atCompletionNonLaborCost: number
(double)
The sum of the actual and remaining costs for all non-labor resource assigned to the activity. This field is in base currency and is calculated from atCompletionNonLaborCostProject field based on the specified exchange rate.
-
atCompletionNonLaborCostProject: number
(double)
The sum of the actual costs plus remaining costs for all nonlabor resource assignments on the activity. This value is based on the project currency.
-
blplannedExpenseCost: number
(double)
The planned cost for all project expenses associated with the activity.
-
expenseCostPercentComplete: number
(double)
The percent complete of cost for all expenses associated with the activity.
-
laborCostPercentComplete: number
(double)
The percent complete of costs for all labor resources assigned to the activity.
-
materialCostPercentComplete: number
(double)
The percent complete of costs for all material resource assigned to the activity.
-
nonLaborCostPercentComplete: number
(double)
The percent complete of costs for all nonlabor resources assigned to the activity.
-
plannedLaborCost: number
(double)
The planned costs for all labor resources assigned to the activity. This field is in base currency and is calculated from plannedLaborCostProject field based on the specified exchange rate.
-
plannedLaborCostProject: number
(double)
The planned cost for all labor resources assigned to the activity. This value is based on the project currency.
-
plannedMaterialCost: number
(double)
The planned costs for all material resources assigned to the activity. This field is in base currency and is calculated from plannedMaterialCostProject field based on the specified exchange rate.
-
plannedMaterialCostProject: number
(double)
The planned cost for all material resources assigned to the activity. This value is based on the project currency.
-
plannedNonLaborCost: number
(double)
The planned costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from plannedNonLaborCostProject field based on the specified exchange rate.
-
plannedNonLaborCostProject: number
(double)
The planned cost for all nonlabor resources assigned to the activity. This value is based on the project currency.
-
remainingLaborCost: number
(double)
The remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from remainingLaborCostProject field based on the specified exchange rate.
-
remainingLaborCostProject: number
(double)
The remaining cost for all labor resource assignments on the activity. This value is based on the project currency.
-
remainingMaterialCost: number
(double)
The remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from remainingMaterialCostProject field based on the specified exchange rate.
-
remainingMaterialCostProject: number
(double)
The remaining cost for all material resource assignments on the activity. This value is based on the project currency.
-
remainingNonLaborCost: number
(double)
The remaining costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from remainingNonLaborCostProject field based on the specified exchange rate.
-
remainingNonLaborCostProject: number
(double)
The remaining cost for all nonlabor resource assignments on the activity. This value is based on the project currency.
Nested Schema : ApiEntityActivityUncertaintyInput
Type:
object
Title:
ApiEntityActivityUncertaintyInput
This entity represents a ActivityUncertainty object, a unique ActivityUncertainty object can be identified by the following combinations of the fields.
Show Source
- activityUncertaintyId
-
activityUncertaintyId: integer
(int64)
The unique identifier of an uncertainty object.
-
distributionShape: string
Allowed Values:
[ "NONE", "TRIANGLE", "UNIFORM", "BETAPERT" ]
The probability distribution that best models the three-point estimate durations. -
existenceProbability: number
(double)
Signifies the probability that a particular activity occurs (exists) in a given project. For example, an activity that may or may not have to be done depending on circumstances.
-
maximumRemainingDuration: number
(double)
The estimated maximum amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.
-
minimumRemainingDuration: number
(double)
The estimated least amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.
-
monteCarloScenario: string
Allowed Values:
[ "PRE_MITIGATED", "POST_MITIGATED" ]
The type of risk analysis run on a project.- PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
- POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
-
mostLikelyRemainingDuration: number
(double)
The estimated most likely amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.
-
project: integer
(int64)
The ID of the project that the activity is in.
Nested Schema : ApiEntityCodeValueActivityInput
Type:
object
Title:
ApiEntityCodeValueActivityInput
This entity represents a CodeValueActivity object, a unique CodeValueActivity object can be identified by the following combinations of the fields.
Show Source
- codeValueActivityId
- codeValueId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeTypeCode,parentId,codeValueCode
- codeValueCode,codeTypeId,parentId
- codeTypeCode,codeValueCode,projectCode
- codeTypeCode,codeValueCode,projectId
- codeTypeCode,codeValueCode,parentId,projectCode
- codeTypeCode,codeValueCode,parentId,projectId
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
activityId: integer
(int64)
The unique identifier for the activity.
-
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeValueActivityId: integer
(int64)
The unique identifier of an activity code value.
-
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
Nested Schema : ApiEntityActivityConfiguredFieldValueInput
Type:
object
Title:
ApiEntityActivityConfiguredFieldValueInput
This entity represents a ActivityConfiguredFieldValue object, a unique ActivityConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- activityConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
activityConfiguredFieldValueId: integer
(int64)
The unique identifier for the Activity Configured Field.
-
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields.
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}
400 Response
Invalid input for the Activity service. Verify the request contains valid data, then resubmit the request.