Batch Update Assignments
put
/primeapi/restapi/assignment/batch
Send a request to this endpoint to update one or more assignments. 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
Supported Media Types
- application/json
One or more assignment objects.
Nested Schema : ApiEntityAssignment
Type:
Show Source
object
-
activity(optional):
integer(int64)
The unique identifier for the activity.
-
actualCurve(optional):
integer(int64)
-
actualDuration(optional):
object Duration
-
actualFinish(optional):
string(date-time)
The date on which the assignment was completed.
-
actualOverTimeUnits(optional):
object Unit
-
actualRegularUnits(optional):
object Unit
-
actualStart(optional):
string(date-time)
If the activity has started, the date work began on the activity.
-
actualThisPeriodQuantity(optional):
object Unit
-
actualUnits(optional):
object Unit
-
assignmentCode(optional):
string
A unique identifier for the assignment.
-
assignmentConfiguredFields(optional):
object ApiEntityAssignmentConfiguredFields
-
assignmentFinancial(optional):
object ApiEntityAssignmentFinancial
-
assignmentId(optional):
integer(int64)
The system-generated identifier of an assignment.
-
atCompletionDuration(optional):
object Duration
-
atCompletionUnits(optional):
object Unit
-
baselineUnits(optional):
object Unit
-
calendar(optional):
integer(int64)
-
costPerQuantitySourceType(optional):
string
Allowed Values:
[ "RESOURCE", "ROLE", "OVERRIDE" ]
The price/unit used to calculate costs for the resource or role assignment. -
curveId(optional):
integer(int64)
The resource's units and costs distributed over the duration of an activity.
-
driveActivityDates(optional):
boolean
Determines whether new resource or role assignments determine activity dates.
-
earnedValueUnits(optional):
object Unit
-
estimateAtCompletionUnits(optional):
object Unit
-
estimateToCompletionUnits(optional):
object Unit
-
finishDate(optional):
string(date-time)
The finish date for the assignment.
-
link(optional):
string(url)
Read Only:
true
-
overtimeFactor(optional):
number(double)
The overtime factor used to compute the overtime price for the resource assignment on this activity.
-
performancePercentComplete(optional):
object Percent
-
plannedDuration(optional):
object Duration
-
plannedFinish(optional):
string(date-time)
The date the assignment is scheduled to be finished.
-
plannedLag(optional):
object Duration
-
plannedStart(optional):
string(date-time)
The planned start date for the assignment on the activity.
-
plannedUnits(optional):
object Unit
-
plannedUnitsPerHour(optional):
object Unit
-
plannedValueUnits(optional):
object Unit
-
proficiency(optional):
string
Allowed Values:
[ "ONE", "TWO", "THREE", "FOUR", "FIVE" ]
The skill level of the resource an activity is assigned to. The valid values are Master, Expert, Skilled, Proficient, and Inexperienced. -
project(optional):
integer(int64)
The unique identifier for the project.
-
rateType(optional):
string
Allowed Values:
[ "COST_PER_QTY" ]
The type of rate that defines the activity. -
remainingCurve(optional):
integer(int64)
The remaining units of work to be performed by the resource on the activity.
Calculated as Planned Units minus Actual Units. -
remainingDuration(optional):
object Duration
-
remainingFinish(optional):
string(date-time)
The date the assignment is scheduled to be finished.
-
remainingLag(optional):
object Duration
-
remainingLateFinish(optional):
string(date-time)
The latest possible date the assignment must be finished to not delay the project finish date.
-
remainingLateStart(optional):
string(date-time)
The latest possible date the assignment must begin to not delay the project finish date.
-
remainingStart(optional):
string(date-time)
The date the assignment is scheduled to begin.
-
remainingUnits(optional):
object Unit
-
remainingUnitsPerHour(optional):
object Unit
-
resource(optional):
integer(int64)
The unique identifier for the resource assigned to the activity.
-
resourceCode(optional):
string
The user-specified identfier of a resource.
-
resourceCurve(optional):
object ApiEntityCurve
-
resourceRole(optional):
integer(int64)
The identifier for the role assigned to the resource.
-
resourceRoleCode(optional):
string
The user-specified identfier of a contract.
-
resourceType(optional):
string
Allowed Values:
[ "LABOR", "NONLABOR", "MATERIAL", "ROLE" ]
The resource type. Valid values are Labor, Nonlabor, and Material. -
schedulePercentComplete(optional):
object Percent
-
spreads(optional):
array spreads
Unique Items Required:
true
The Assignment spread control objects associated with the specified assignment object. -
staffedRemainingUnits(optional):
object Unit
-
starred(optional):
boolean
Specifies whether the assignment has been marked as important.
-
startDate(optional):
string(date-time)
The start date for the activity assignment.
-
syncUnitsFromCost(optional):
boolean
Determines whether to recalculate actual or actual this period units and costs when one of these values is updated.
-
totalRemainingLag(optional):
object Duration
-
unitsPercentComplete(optional):
object Percent
-
unstaffedRemainingUnits(optional):
object Unit
-
updateDate(optional):
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 : Unit
Type:
object
Nested Schema : ApiEntityAssignmentConfiguredFields
Type:
Show Source
object
-
assignmentId(optional):
integer(int64)
The system-generated identifier of an assignment.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with an asssignment.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with an asssignment.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with an asssignment.
-
updateDate(optional):
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 : ApiEntityAssignmentFinancial
Type:
Show Source
object
-
activity(optional):
integer(int64)
The system-generated identifier of an activity.
-
actualCost(optional):
object Cost
-
actualOvertimeCost(optional):
object Cost
-
actualRegularCost(optional):
object Cost
-
assignment(optional):
integer(int64)
The unique identifier for the assignment.
-
assignmentId(optional):
integer(int64)
The unique identifier for the assignment.
-
atCompletionCost(optional):
object Cost
-
costPerQuantity(optional):
object Cost
-
earnedValueCost(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
plannedCost(optional):
object Cost
-
plannedValueCost(optional):
object Cost
-
project(optional):
integer(int64)
The system-generated identifier of a project.
-
remainingCost(optional):
object Cost
-
resource(optional):
integer(int64)
The system-generated identifier of a resource.
-
staffedRemainingCost(optional):
object Cost
-
unstaffedRemainingCost(optional):
object Cost
-
updateDate(optional):
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 : ApiEntityCurve
Type:
Show Source
object
-
buckets(optional):
array buckets
Unique Items Required:
true
The buckets of a cost curve. -
curveId:
integer(int64)
The unique identifier of a curve.
-
curveName:
string
The name of the curve profile.
-
link(optional):
string(url)
Read Only:
true
-
pushDownType(optional):
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
How data is shared between parent and child workspaces.
Manual: Data can be pulled down by child workspaces. This is the default option.
Automatic: Data is automatically shared with all child workspaces. -
updateDate(optional):
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 : spreads
Type:
array
Unique Items Required:
true
The Assignment spread control objects associated with the specified assignment object.
Show Source
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with an asssignment.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with an asssignment.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with an asssignment.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
Nested Schema : buckets
Type:
array
Unique Items Required:
true
The buckets of a cost curve.
Show Source
Nested Schema : ApiEntityCurveBucket
Type:
Show Source
object
-
bucketLevel(optional):
integer(int32)
The level of a curve bucket.
-
curveBucketId:
integer(int64)
The unique identifier of a curve bucket.
-
curveId:
integer(int64)
The unique identifier of a curve.
-
link(optional):
string(url)
Read Only:
true
-
uniqueName(optional):
string
-
updateDate(optional):
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. -
value(optional):
number
Numeric value of a bucket curve. Curve bucket values determine the shape of curves.
Nested Schema : ApiEntityResourceAssignmentSpreadControlObject
Type:
Show Source
object
-
bucketCount(optional):
integer(int64)
Number of discrete values that make up a resource assignment spread.
-
controlId(optional):
integer(int64)
The unique identifier for the resource and role assignment spread data.
-
endDate(optional):
string(date-time)
End date of an activity assignment.
-
generationType(optional):
string
Allowed Values:
[ "AUTO", "AGGREGATE", "MANUAL" ]
Method used to generate the resource assignment spread. -
granularity(optional):
string
Allowed Values:
[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
Determines the level of detail in the cash flow curve. -
keyId(optional):
integer(int64)
The unique identifier of a scope management key.
-
link(optional):
string(url)
Read Only:
true
-
projWorkspaceId(optional):
integer(int64)
The unique identifier of a project or workspace.
-
spreadRows(optional):
array spreadRows
Unique Items Required:
true
Spread Rows of the assignment. -
spreadType(optional):
string
Allowed Values:
[ "BASE", "RESOURCE_PROJECT", "ROLE_PROJECT", "RESOURCE_WORKSPACE", "ROLE_WORKSPACE" ]
The type of the resource spread. -
startDate(optional):
string(date-time)
Start date of an activity assignment.
-
updateDate(optional):
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 : spreadRows
Type:
array
Unique Items Required:
true
Spread Rows of the assignment.
Show Source
Nested Schema : ApiEntityResourceAssignmentSpreadRow
Type:
Show Source
object
-
actualOverTimeUnits(optional):
object Unit
-
actualOverTimeUnitsHourlySpread(optional):
array actualOverTimeUnitsHourlySpread
The hourly actual overtime units worked by the resource on the activity.
-
actualRegularUnits(optional):
object Unit
-
actualRegularUnitsHourlySpread(optional):
array actualRegularUnitsHourlySpread
The hourly actual non-overtime units worked by the resource on the activity.
-
actualUnits(optional):
object Unit
-
actualUnitsHourlySpread(optional):
array actualUnitsHourlySpread
The hourly actual units worked by the resource on the activity.
-
atCompletionUnits(optional):
object Unit
-
atCompletionUnitsHourlySpread(optional):
array atCompletionUnitsHourlySpread
The hourly sum of actual units and remaining units for the activity resource assignment.
-
bucketId(optional):
integer(int64)
The unique identifier of a bucket.
-
controlObject(optional):
object ApiEntityResourceAssignmentSpreadControlObject
-
link(optional):
string(url)
Read Only:
true
-
plannedUnits(optional):
object Unit
-
plannedUnitsHourlySpread(optional):
array plannedUnitsHourlySpread
The hourly expected number of units required to complete the activity.
-
remainingLateUnits(optional):
object Unit
-
remainingLateUnitsHourlySpread(optional):
array remainingLateUnitsHourlySpread
The hourly number of units remaining to be worked on for the assignment distributed over the late start and finish dates.
-
remainingUnits(optional):
object Unit
-
remainingUnitsHourlySpread(optional):
array remainingUnitsHourlySpread
The number of units remaining to be worked on for the assignment distributed over the late start and finish dates.
-
sequence(optional):
integer(int64)
Determines the position of a bucket.
-
skipPeriods(optional):
integer(int32)
Indicates a skipped period.
-
staffedRemainingLateUnits(optional):
object Unit
-
staffedRemainingUnits(optional):
object Unit
-
staffedRemainingUnitsHourlySpread(optional):
array staffedRemainingUnitsHourlySpread
The hourly remaining units that have filled a role for the activity resource assignment.
-
unstaffedRemainingLateUnits(optional):
object Unit
-
unstaffedRemainingUnits(optional):
object Unit
-
unstaffedRemainingUnitsHourlySpread(optional):
array unstaffedRemainingUnitsHourlySpread
The hourly remaining units that have not filled a role for the activity resource assignment.
-
updateDate(optional):
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 : actualOverTimeUnitsHourlySpread
Type:
array
The hourly actual overtime units worked by the resource on the activity.
Show Source
Nested Schema : actualRegularUnitsHourlySpread
Type:
array
The hourly actual non-overtime units worked by the resource on the activity.
Show Source
Nested Schema : actualUnitsHourlySpread
Type:
array
The hourly actual units worked by the resource on the activity.
Show Source
Nested Schema : atCompletionUnitsHourlySpread
Type:
array
The hourly sum of actual units and remaining units for the activity resource assignment.
Show Source
Nested Schema : plannedUnitsHourlySpread
Type:
array
The hourly expected number of units required to complete the activity.
Show Source
Nested Schema : remainingLateUnitsHourlySpread
Type:
array
The hourly number of units remaining to be worked on for the assignment distributed over the late start and finish dates.
Show Source
Nested Schema : remainingUnitsHourlySpread
Type:
array
The number of units remaining to be worked on for the assignment distributed over the late start and finish dates.
Show Source
Nested Schema : staffedRemainingUnitsHourlySpread
Type:
array
The hourly remaining units that have filled a role for the activity resource assignment.
Show Source
Nested Schema : unstaffedRemainingUnitsHourlySpread
Type:
array
The hourly remaining units that have not filled a role for the activity resource assignment.
Show Source
Response
Supported Media Types
- application/json
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://:/primeapi/restapi/
400 Response
Invalid input for the Assignment service.