ResourceAssignment Fields


 Field


 Type

Read 
Only

Filterable
Orderable


 Description

ActivityActualFinish

dateTime

 

 

The date on which the activity was completed.

ActivityId

string
restricted to
maxLength(40)

X

X

The short ID that uniquely identifies the activity within the project.

ActivityName

string
restricted to
maxLength(120)

X

X

The name of the activity. The activity name does not have to be unique.

ActivityObjectId

int

 

X

The unique ID of the activity to which the resource is assigned.

ActivityType

string
restricted to
'Task Dependent'
'Resource Dependent'
'Level of Effort'
'Start Milestone'
'Finish Milestone'
'WBS Summary'

X

X

Determines how duration and schedule dates are calculated for an activity.

ActualCost

double

 

X

The actual non-overtime plus overtime cost for the resource assignment on the activity. Computed as actual cost = actual regular cost + actual overtime cost.

ActualCurve

string

 

X

The curve applied to Actual Units for the resource assignment.

ActualDuration

double

X

 

The actual duration for the resource assignment on the activity.

ActualFinishDate

dateTime

 

X

The date the resource actually finished working on the activity.

ActualOvertimeCost

double

 

X

The actual overtime cost for the resource assignment on the activity. Computed as actual overtime cost = actual overtime units * cost per time * overtime factor.

ActualOvertimeUnits

double

 

X

The actual overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager.

ActualRegularCost

double

 

X

The actual non-overtime cost for the resource assignment on the activity. Computed as actual regular cost = actual regular units * cost per time.

ActualRegularUnits

double

 

X

The actual non-overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager.

ActualStartDate

dateTime

 

X

The date the resource actually started working on the activity.

ActualThisPeriodCost

double

 

X

The actual this period cost (will be labor or nonlabor).

ActualThisPeriodUnits

double

 

X

The actual this period units (hours) (will be labor or nonlabor).

ActualUnits

double

 

X

The actual non-overtime plus overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager. Computed as actual units = actual regular units + actual overtime units.

AssignmentPercentComplete

double

 

 

The percent complete of the resource assignment. Required for IPMDAR.

If the Activity or Assignment is not started, the Assignment Percent Complete is 0%.

If the Activity or Assignment is complete:

  • If the Actual Units is zero, Assignment Percent Complete is 0%.
  • If the Actual Units is greater than zero, Assignment Percent Complete is 100%

If the Activity or Assignment is in progress, the calculation depends on the activity percent complete type.

  • Units Percent Complete: Assignment Percent Complete = Assignment level Actual Units / (Actual Units + Remaining Units) = Assignment level Actual Units / (At Completion Units)
  • Duration Percent Complete: Assignment Percent Complete = (Assignment level Planned Duration – Remaining Duration) / Planned Duration
  • Physical Percent Complete: Assignment Percent Complete = Activity % Complete

AtCompletionCost

double

 

X

The sum of the actual plus remaining costs for the resource assignment on the activity.

AtCompletionDuration

double

X

 

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, 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 computed using the activity's calendar.

AtCompletionUnits

double

 

X

The sum of the actual plus remaining units for the resource assignment on the activity.

AutoComputeActuals

boolean

X

X

The option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete. If this option is selected, the actual/remaining units and actual dates are automatically updated when project actuals are applied. Use this option to assume that all work for the activity proceeds according to plan.

BudgetAtCompletionCosts

double

 

 

The planned total cost through to the completion of the assignment. Calculated as Planned Cost. Required for IPMDAR.

BudgetAtCompletionUnits

double

 

 

The planned total units through to the completion of the assignment. Calculated as Planned Units. Required for IPMDAR.

CBSCode

string

 

 

CBS Code.

CBSId

int

 

 

The unique Id of CBS.

CalendarName

string

X

 

The name of the calendar.

CalendarObjectId

int

X

X

The unique ID generated by the system for the calendar associated with the resource assignment.

CostAccountId

string
restricted to
maxLength(40)

X

X

The id of associated cost account.

CostAccountName

string
restricted to
maxLength(100)

X

X

The name of the associated cost account.

CostAccountObjectId

int

 

X

The unique ID of the cost account associated with this resource assignment.

CreateDate

dateTime

X

X

The date this assignment was created.

CreateUser

string

X

X

The name of the user that created this assignment.

DrivingActivityDatesFlag

boolean

 

X

The flag indicating whether new resource/role assignments drive activity dates, by default.

DurationPercentComplete

double

X

 

The duration percent complete for the assignment. Required for IPMDAR.

EstimateToCompletionCosts

double

X

 

The estimated cost to complete the assignment. Calculated according to the Technique for computing estimate to complete (ETC) for the WBS. The Project baseline is used for this calculation. Required for IPMDAR.

EstimateToCompletionUnits

double

X

X

The estimated units to complete the assignment. Calculated according to the Technique for computing estimate to complete (ETC) for the WBS. The Project baseline is used for this calculation. Required for IPMDAR.

FinancialPeriodTmplId

int

 

X

The unique identifier of the financial period calendar assigned to the project.

FinishDate

dateTime

 

 

The finish date of the resource assignment on the activity. Set to the remaining finish date until the activity is completed, then set to the actual finish date.

GUID

string
restricted to
pattern
'\{[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\}|'

 

X

The globally unique ID generated by the system.

HasFutureBucketData

boolean

X

X

The flag that indicates whether the assignment has future bucket data.

IsActive

boolean

X

X

The flag that indicates whether this resource assignment is active.

IsActivityFlagged

boolean

 

F

The flag that indicates whether the resource who is assigned to the activity assignment has flagged the activity as important to the resource.

IsBaseline

boolean

X

X

The boolean value indicating if this business object is related to a Project or Baseline

IsCostUnitsLinked

boolean

 

X

The flag that determines whether or not cost should be calculated based on units.

IsOvertimeAllowed

boolean

X

X

The flag that indicates whether the resource is allowed to log overtime hours.

IsPrimaryResource

boolean

 

 

The flag that indicates whether this resource is the activity's primary resource.

IsTemplate

boolean

X

X

The boolean value indicating if this business object is related to a template Project.

LastUpdateDate

dateTime

X

X

The date this assignment was last updated.

LastUpdateUser

string
restricted to
maxLength(255)

X

X

The name of the user that last updated this assignment.

ObjectId

int

 

X

The unique ID generated by the system.

OvertimeFactor

double
restricted to
minInclusive(0.0)
maxInclusive(10.0)

 

X

The overtime factor used to compute the overtime price for the resource assignment on this activity. Overtime price = standard price * overtime factor. When the resource is assigned to the activity, the resource's overtime factor is copied to the assignment. The assignment overtime factor is refreshed from the resource value when resource prices are synchronized for the project.

PendingActualOvertimeUnits

double

X

X

The actual overtime units worked by the resource on this activity. This value is computed from values entered by a user in the Progress Reporter application and is applied to the resource assignment when the Apply Actuals service is invoked.

PendingActualRegularUnits

double

X

X

The actual nonovertime units worked by the resource on this activity. This value is computed from values entered by a user in the Progress Reporter application and is applied to the resource assignment when the Apply Actuals service is invoked.

PendingPercentComplete

double

 

X

The estimate of the percentage of the resource's units of work completed on this activity. The pending percent complete is entered by each resource using Timesheets. This value is used to compute the resource's remaining units for the activity when project actuals are applied. The project manager specifies whether resources update their percent complete or remaining units for each project.

PendingRemainingUnits

double

 

X

The estimate of the resource's remaining units on this activity. The pending remaining units is entered by each resource using Timesheets. This value is copied to the resource's remaining units for the activity when project actuals are applied. The project manager specifies whether resources update their percent complete or remaining units for each project.

PercentComplete

double

X

 

The percentage complete for the assignment. Required for IPMDAR.

PercentCompeleType

string
restricted to
''
'Physical'
'Duration'
'Units'
'Scope'

 

 

The percent complete type for the assignment. Required for IPMDAR.

PlannedCost

double

 

X

The planned cost for the resource assignment on the activity. Computed as planned cost = planned units * price per time. This field is named BudgetedCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

PlannedCurve

string

 

X

The curve applied to Planned Units for the resource assignment.

PlannedDuration

double

 

 

The planned working time for the resource assignment on the activity, from the resource's planned start date to the planned finish date. This field is named BudgetedDuration in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

PlannedFinishDate

dateTime

 

X

The date the resource is scheduled to finish working on the activity. This date is computed 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 been started. This is the finish date that Timesheets users follow and schedule variance is measured against.

PlannedLag

double
restricted to
minInclusive(0.0)

 

X

The planned time lag between the activity's planned start date and the resource's planned start date on the activity. If the resource is planned to start work when the activity is planned to start, the planned lag is zero. This field is named BudgetedLag in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

PlannedStartDate

dateTime

 

X

The date the resource is scheduled to begin working on the activity. This date is computed 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 been started. This is the start date that Timesheets users follow and schedule variance is measured against.

PlannedUnits

double

 

X

The planned units of work for the resource assignment on the activity. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

PlannedUnitsPerTime

double

 

X

The planned units per time at which the resource is to perform work on this activity. For example, a person assigned full time would perform 8 hours of work per day. A department of five people may perform at 5 days per day. This field is named BudgetedUnitsPerTime in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

PricePerUnit

double
restricted to
minInclusive(0.0)

 

 

The price per time for the resource on this activity. This price is used to compute the resource's cost for the activity. When the resource is assigned to the activity, the resource's price is copied to the assignment based on the effective date of the price and the activity start date. The assignment price is refreshed whenever resource prices are synchronized for the project.

PriorActualOvertimeUnits

double

X

X

The difference between the pending quantity value and the actual quantity value for overtime before applying the new actual value.

PriorActualRegularUnits

double

X

X

The difference between the pending quantity value and the actual quantity value before applying the new actual value.

Proficiency

string
restricted to
'1 - Master'
'2 - Expert'
'3 - Skilled'
'4 - Proficient'
'5 - Inexperienced'

 

 

The skill level that is associated with the role. The values are 'Master', 'Expert', 'Skilled', 'Proficient', and 'Inexperienced'. If the current user does not have the ViewResourceRoleProficiency global security privilege, this field may not be accessed.

ProjectFlag

string

X

X

Indicates if this WBS node is a Project/EPS node.

ProjectId

string
restricted to
maxLength(40)

X

X

The short code that uniquely identifies the project.

ProjectName

string

X

X

The name of the associated project.

ProjectObjectId

int

X

X

The unique ID of the associated project.

ProjectProjectFlag

string

X

X

Indicates if this Project/EPS nose is a Project or EPS.

RateSource

string
restricted to
'Resource'
'Role'
'Override'

 

X

The value that indicates which price/unit will be used to calculate costs for the assignment, such as 'Resource', 'Role', and 'Override'. When a resource and only a resource is assigned to an activity, the rate source will automatically equal 'Resource'. When a role and only a role is assigned to an activity, the rate source will automatically equal 'Role'. When both a resource and role are assigned to the activity, the rate source can be either 'Resource' or 'Role' determined by the RateSourcePreference. In any case, the 'Override' value allows you to specify any other price/unit.

RateType

string
restricted to
'Price / Unit'
'Price / Unit 2'
'Price / Unit 3'
'Price / Unit 4'
'Price / Unit 5'

 

X

The rate type that determines which of the five prices specified for the resource will be used to calculate the cost for the resource assignment. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', 'Price / Unit5', and 'None'.

RemainingCost

double

 

X

The remaining cost for the resource assignment on the activity. Computed as remaining cost = remaining units * cost per time.

RemainingCurve

string

 

X

The curve applied to Remaining Units for the resource assignment.

RemainingDuration

double
restricted to
minInclusive(0.0)

 

 

The remaining duration of the resource assignment. The remaining duration is the remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date. The remaining working time is computed using the calendar determined by the activity Type. Resource Dependent activities use the resource's calendar, other activity types use the activity's calendar. Before the activity is started, the remaining duration is the same as the Original duration. After the activity is completed, the remaining duration is zero.

RemainingFinishDate

dateTime

 

X

The date the resource is scheduled to finish the remaining work for the activity. This date is computed by the project scheduler but can be updated manually by the project manager. Before the activity is started, the remaining finish date is the same as the planned finish date.

RemainingLag

double
restricted to
minInclusive(0.0)

 

 

The time lag between the activity's remaining start date and the resource's remaining start date on the activity. If the resource's remaining work starts on the activity's remaining start date, the lag is zero. Before the activity is started, the remaining lag is the same as the planned lag.

RemainingLateFinishDate

dateTime

X

X

The remaining late finish date calculated by the scheduler.

RemainingLateStartDate

dateTime

X

X

The remaining late start date calculated by the scheduler.

RemainingStartDate

dateTime

 

X

The date the resource is scheduled to begin the remaining work for the activity. This date is computed by the project scheduler but can be updated manually by the project manager. Before the activity is started, the remaining start date is the same as the planned start date.

RemainingUnits

double

 

X

The remaining units of work to be performed by this resource on this 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.

RemainingUnitsPerTime

double

 

X

The units per time at which the resource will be performing work on the remaining portion of this activity. For example, a person assigned full time would perform 8 hours of work per day. A department of five people may perform at 5 days per day.

ResourceCalendarName

string

X

X

The name of the calendar for the resource.

ResourceCurveName

string
restricted to
maxLength(60)

X

X

The name of the resource curve that determines how resources and costs are distributed over time for this activity.

ResourceCurveObjectId

int

 

X

The unique ID of the resource curve.

ResourceId

string
restricted to
maxLength(255)

X

X

The short code that uniquely identifies the resource.

ResourceName

string
restricted to
maxLength(255)

X

X

The name of the resource.

ResourceObjectId

int

 

X

The unique ID of the associated resource.

ResourceType

string
restricted to
'Labor'
'Nonlabor'
'Material'

 

X

The resource type: "Labor", "Nonlabor", or "Material".

ReviewRequired

boolean

 

 

Determines if all new activities added to the project require approval.

RoleId

string
restricted to
maxLength(40)

X

X

The short code that uniquely identifies the role.

RoleName

string
restricted to
maxLength(100)

X

X

The name of the role. The role name uniquely identifies the role.

RoleObjectId

int

 

X

The unique ID of the role the resource is performing on this activity. A resource may be assigned to the same activity more than once, performing different roles. The project manager controls whether the same resource can be assigned to an activity more than once.

RoleShortName

string
restricted to
maxLength(40)

 

X

The short code that uniquely identifies a role.

StaffedRemainingCost

double

X

 

The time distribution of the resource's remaining cost for resource assignments that have filled a role.

StaffedRemainingUnits

double

X

 

The time distribution of the resource's remaining units for resource assignments that have filled a role.

StartDate

dateTime

 

 

The start date of the resource assignment on the activity. Set to the remaining start date until the activity is started, then set to the actual start date.

StatusCode

string
restricted to
'Planned'
'Active'
'Inactive'
'What-If'
'Requested'
'Template'

X

X

The project status, either 'Planned', 'Active', 'Inactive', 'What-If', 'Requested', or 'Template'.

TotalPastPeriodCost

double

 

 

The total stored period cost for each assignment.

TotalPastPeriodUnits

double

 

 

The total stored period units for each assignment.

UnitsPercentComplete

double

 

 

The percent complete of units for the resource assignment on the activity. Computed as actual units / at completion units * 100. Always in the range 0 to 100.

UnreadCommentCount

int

X

 

The total number of unread comments on this activity for a user.

UnstaffedRemainingCost

double

X

 

The time distribution of the resource's remaining cost for resource assignments that have not filled a role.

UnstaffedRemainingUnits

double

X

 

The time distribution of the resource's remaining units for resource assignments that have not filled a role.

WBSNamePath

string

X

 

The hierarchy of the parent WBS Names. WBS Names are listed in order from parent to child and hierarchical levels are separated by dots. For example: WBS_Name_1A.WBS_Name_2A.WBS_Name_3A

WBSObjectId

int

X

X

The unique ID of the WBS for the activity.

UDF

UDFAssignmentType

See UDFAssignment Table below.

 

 

 

Spread

ResourceAssignmentSpreadType

See ResourceAssignmentSpreadType Table below.

 

 

 

ResourceRequest

 

ResourceRequestType

See the ResourceRequest table below

 

 

 

The resource request used as a search template to search for a qualified resource.

UDFAssignment Table

TypeObjectId

int

CodeObjectId

int

CostValue

double

IntegerValue

int

IndicatorValue

string restricted to
'None'
'Red'
'Yellow'
'Green'
'Blue'

DoubleValue

double

TextValue

string

StartDateValue

dateTime

FinishDateValue

dateTime

ResourceAssignmentSpreadType Table

StartDate

dateTime

EndDate

dateTime

PeriodType

string restricted to
Hour
Day
Week
Month
Quarter
Year
Financial Period

Period Table

StartDate

dateTime

EndDate

dateTime

ActualOvertimeUnits

double

CumulativeActualOvertimeUnits

double

ActualRegularUnits

double

CumulativeActualRegularUnits

double

AcutalUnits

double

CumulativeActualUnits

double

AtCompletionUnits

double

CumulativeAtCompletionUnits

double

PlannedUnits

double

CumulativePlannedUnits

double

RemainingLateUnits

double

CumulativeRemainingLateUnits

double

RemainingUnits

double

CumulativeRemainingUnits

double

StaffedRemainingLateUnits

double

CumulativeStaffedRemainingLateUnits

double

StaffedRemainingUnits

double

CumulativeStaffedRemainingUnits

double

UnstaffedRemainingLateUnits

double

CumulativeUnstaffedRemainingLateUnits

double

UnstaffedRemainingUnits

double

CumulativeUnstaffedRemainingUnits

double

ActualCost

double

CumulativeActualCost

double

ActualOvertimeCost

double

CumulativeActualOvertimeCost

double

ActualRegularCost

double

CumulativeActualRegularCost

double

AtCompletionCost

double

CumulativeAtCompletionCost

double

PlannedCost

double

CumulativePlannedCost

double

RemainingCost

double

CumulativeRemainingCost

double

RemainingLateCost

double

CumulativeRemainingLateCost

double

StaffedRemainingCost

double

CumulativeStaffedRemainingCost

double

StaffedRemainingLateCost

double

CumulativeStaffedRemainingLateCost

double

UnstaffedRemainingCost

double

CumulativeUnstaffedRemainingCost

double

UnstaffedRemainingLateCost

double

CumulativeUnstaffedRemainingLateCost

double

ResourceRequest Table

FinishDate

dateTime

MatchAllCriteria

boolean

Name

string

RequestedUnits

double

SequenceNumber

int

ShowOnlyLaborResources

boolean

ShowOverallocatedResources

boolean

SortResultsByAvailability

boolean

StartDate

dateTime

UseActivityDates

boolean

ResourceRequestCriterion

  • CriterionType
    string
    restricted to
    'Primary Role'
    'Role'
    'Resource'
    'Resource Code'
  • Proficiency
    string restricted to
    '1 - Master'
    '2 - Expert'
    '3 - Skilled'
    '4 - Proficient'
    '5 - Inexperienced'
  • ValueObjectId int



Legal Notices | Your Privacy Rights
Copyright © 2008, 2023

Last Published Wednesday, February 1, 2023