View Scope Item Assignment Configured Fields
get
/primeapi/restapi/scopeItemAssignment/{id}/configuredFields
Request
Path Parameters
-
id: integer(int64)
The system-generated identifier of a scope item assignment.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityScopeItemAssignmentConfiguredFields
Type:
Show Source
object
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost and non-text fields in the form of key-value pairs.
-
primaryKey(optional):
integer(int64)
-
scopeItemAssignment(optional):
object ApiEntityScopeItemAssignment
-
scopeItemAssignmentId(optional):
integer(int64)
The unique identifier for the scope item assigned to the work package.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
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.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost and non-text fields in the form of key-value pairs.
Nested Schema : ApiEntityScopeItemAssignment
Type:
Show Source
object
-
actualHoursToDate:
object Hour
-
actualUnitsToDate:
object Quantity
-
approvedChangedHours:
object Hour
-
approvedChangedUnits:
object Quantity
-
atCompletionHours(optional):
object Hour
-
atCompletionUnits(optional):
object Quantity
-
availableHours:
object Hour
-
availableUnits:
object Quantity
-
bacHours(optional):
object Hour
-
bacUnits:
object Quantity
-
baselineFinishDate(optional):
string(date-time)
The planned finish date for the work package as is set in the current baseline.
This field is used to spread baseline data fields.
This field is populated with the Revised Finish date at the time that the current baseline is set.
If there is an activity link, this field is populated with the activity's Current BL Finish date. -
baselineHours:
object Hour
-
baselineStartDate(optional):
string(date-time)
The planned start date for the work package as is set in the current baseline.
This field is used to spread baseline data fields.
This field is populated with the Revised Start date at the time that the current baseline is set.
If there is an activity link, this field is populated with the activity's Current BL Start date. -
baselineUnits:
object Quantity
-
code(optional):
string
The unique identifier for the scope assignment.
-
costSheetItemId(optional):
integer(int64)
The cost breakdown structure code assigned to the scope item of the scope assignment.
-
currentHoursPerUnit(optional):
number(double)
The number of hours it will take to install or assemble the product or material per unit based on current values.
Calculated as Revised Hours divided by Revised Quantity.
This value is recalculated if Revised Quantity or Revised Hours are changed. -
curve(optional):
integer(int64)
The curve profile selected for the scope assignment.
-
description:
string
Allowed Values:
[ "Length[0-4000]" ]
Additional details for the scope assignment. -
eacHours:
object Hour
-
eacUnits:
object Quantity
-
earnedHours:
object Hour
-
earnedPercentComplete:
object Percent
-
earnedUnits:
object Quantity
-
effectiveDate(optional):
string(date-time)
The latest date of all Actual to Date and Actual Cost to Date values for the scope assignment.
This is a read-only field. -
effectiveStartDate(optional):
string(date-time)
The earliest date of all Actual Hours to Date and Actual Cost to Date values for the scope assignment.
This is a read-only field. -
etcAdjustedHours:
object Hour
-
etcAdjustedUnits:
object Quantity
-
etcHours:
object Hour
-
etcUnits:
object Quantity
-
hoursPerUnit(optional):
number(double)
The number of hours it takes to install or assemble the product or material per unit. Defaults to the scope item's Original Productivity Rate, but can be updated for each scope item assignment.
Calculated as Original Hours divided by Original Quantity.
If this field is updated, Original Hours is recalculated to equal Original Quantity multiplied by Original Productivity Rate. -
installedFinishDate(optional):
string(date-time)
The date work on the scope assignment completed.
The latest date of all Installed Quantity values for the scope assignment when Scope Percent Complete equals 100%. -
installedHours(optional):
object Hour
-
installedStartDate(optional):
string(date-time)
The date work on the scope assignment began.
This is the earliest date of all Installed Quantity values for the scope assignment. -
installedUnits(optional):
object Quantity
-
lastInstalledDate(optional):
string(date-time)
The date on which the work package was last installed.
-
link(optional):
string(url)
Read Only:
true
-
managerId(optional):
integer(int64)
The manager or person responsible for providing status on the scope assignment.
-
manualWeight(optional):
number(double)
Calculated as Scope Percent Complete multiplied by Manual Weight.
-
manualWeightFactor(optional):
number(double)
The value used to calculate manual completed weight when progress needs to be weighed against a factor other than quantity, hours, or cost.
This is a manual entry field when Scope Percent Complete Weight Method is set to Manual. -
milestoneProgressPercent:
object Percent
-
milestones(optional):
array milestones
Unique Items Required:
true
The milestones of a scope assignment. -
originalFinishDate(optional):
string(date-time)
The date the work on the scope assignment is scheduled to finish.
This field is populated with the work package's Original Finish date, but it can be manually modified until the original baseline is set.
If there is no activity link, the field is locked when the original baseline is set.
If there is an activity link, the field is populated with the activity's Original BL Finish.
If the Data Date is specified after the Original Finish date is set and the Original Start date is before the Data Date, the application sets the Original Finish date to be the same date relative to Original Start before the Data Date was modified when the Modify Dates feature is run. -
originalStartDate(optional):
string(date-time)
The date the work on the scope assignment is scheduled to begin.
This field is populated with its work package's Original Start, but can be manually modified until the original baseline is set.
If there is no activity link, the field is locked when the original baseline is set.
If there is an activity link, the field is populated with the activity's Original BL Start.
If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
If the Data Date is specified after the Original Start date is set and the Original Start date is before the Data Date, the Original Start date inherits the Data Date when the Modify Dates feature is run. -
pendingChangedHours:
object Hour
-
pendingChangedUnits:
object Quantity
-
percentComplete:
object Percent
-
plannedFinishDate(optional):
string(date-time)
The date the work on the work package is scheduled to finish.
This field is used to spread original data fields.
If there is no activity link, this field is populated with the Original Finish date until the original baseline is set. It can be manually modified after the original baseline is set.
If Data Date is specified after the Planned Finish date is set and the Planned Start date is before the Data Date, the application sets the Planned Finish date to be the same date relative to Planned Start before the Data Date was modified when the Modify Dates feature is run.
If there is an activity link, this field is populated with the activity's Planned Finish date. -
plannedHours(optional):
object Hour
-
plannedStartDate(optional):
string(date-time)
The date the work on the work package is scheduled to begin.
This field is used to spread original data fields.
If there is no activity link, this field is populated with the Original Start date until the original baseline is set. It can be manually updated after the original baseline is set.
If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
If the Data Date is specified after the Planned Start date is set, the Planned Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, that is Installed Quantity is zero, then the date inherits the Data Date when the Modify Dates feature is run.
If there is an activity link, this field is populated with the activity's Planned Start date. -
plannedUnits(optional):
object Quantity
-
progressStatus(optional):
string
Allowed Values:
[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ]
The current status of a scope assignment.
Not Started: Work using the scope assignment has not begun.
In Progress: The work is in progress.
Completed: The work has been completed. -
projectId(optional):
integer(int64)
The ID for the project that the work package belongs to.
-
rateBy:
string
Allowed Values:
[ "HOURS", "QUANTITY" ]
Determines whether the cost is calculated using the Quantity or Hours.
Quantity: Quantity is used to calculate cost. For example, Original Cost is calculated as Original Quantity times Original Cost Rate.
Hours: Hours are used to calculate cost. For example, Original Cost is calculated as Original Hours times Original Cost Rate. -
remainingEarlyFinishDate(optional):
string(date-time)
The earliest date the work on the scope assignment is scheduled to finish.
If there is no activity link, before the original baseline is set, this field is populated with the Original Finish date. After the original baseline is set, this field is populated with the Revised Finish date.
This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
If there is any activity linked, this field is populated with the activity's Remaining Early Finish date.
This field is used to spread Remaining data fields. -
remainingEarlyStartDate(optional):
string(date-time)
The earliest date the work on the work package is scheduled to begin.
If there is no activity link, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, this field is populated with the Data Date when the Modify Dates feature is run if the scope assignment's Scope Percent Complete is not equal to 100%.
This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
If there is any activity linked, this field is populated with the activity's Remaining Early Start date.
This field is used to spread Remaining data fields. -
remainingHours(optional):
object Hour
-
remainingLateFinishDate(optional):
string(date-time)
The latest possible date work on the scope assignment must finish to not delay the finish date.
If there is no activity link, this field is always equal to the Remaining Early Finish date.
If there is any activity linked, this field is populated with the activity's Remaining Late Finish date.
This field is used to spread Remaining data fields. -
remainingLateStartDate(optional):
string(date-time)
The latest possible date work on the scope assignment must begin without delaying the finish date.
If there is no activity link, this field is always equal to the Remaining Early Start date.
If there is any activity link, this field is populated with the activity's Remaining Late Start date.
This field is used to spread Remaining data fields. -
remainingUnits(optional):
object Quantity
-
revisedFinishDate(optional):
string(date-time)
The revised finish date for the scope assignment.
It is always the latest finish of the scope assignment's Planned Start date and all approved Change Finish dates.
This field is used to spread Revised data fields. -
revisedHours:
object Hour
-
revisedStartDate(optional):
string(date-time)
The revised start date for the scope assignment.
It is always the earliest start of the scope assignments' Planned Start date and all approved Change Start dates.
This field is used to spread Revised data fields. -
revisedUnits:
object Quantity
-
scopeItemAssignmentCodeValue(optional):
array scopeItemAssignmentCodeValue
Unique Items Required:
true
A code value object. -
scopeItemAssignmentConfiguredFields(optional):
object ApiEntityScopeItemAssignmentConfiguredFields
-
scopeItemAssignmentCost(optional):
object ApiEntityScopeItemAssignmentCost
-
scopeItemAssignmentId(optional):
integer(int64)
The unique identifier for the scope item assigned to the work package.
-
scopeItemId(optional):
integer(int64)
The unique identifier of the scope item assigned to the work package.
-
status(optional):
string
Allowed Values:
[ "PENDING", "APPROVED", "REJECTED" ]
The status of a work package. -
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. -
weightedCost:
object Cost
-
weightedCostProject(optional):
object Cost
-
weightedHours:
object Hour
-
weightedUnits:
object Quantity
-
workPackageId(optional):
integer(int64)
The unique identifier for the work package.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Quantity
Type:
object
Nested Schema : milestones
Type:
array
Unique Items Required:
true
The milestones of a scope assignment.
Show Source
Nested Schema : scopeItemAssignmentCodeValue
Type:
array
Unique Items Required:
true
A code value object.
Show Source
Nested Schema : ApiEntityScopeItemAssignmentCost
Type:
Show Source
object
-
actualCostToDate:
object Cost
-
actualCostToDateProject:
object Cost
-
adjustedCost:
object Cost
-
adjustedCostProject:
object Cost
-
approvedChangedCost:
object Cost
-
approvedChangedCostProject:
object Cost
-
atCompletionCost:
object Cost
-
atCompletionCostProject:
object Cost
-
bacCost:
object Cost
-
bacCostProject:
object Cost
-
baselineCost:
object Cost
-
baselineCostProject:
object Cost
-
currentRate:
object Cost
-
currentRateProject:
object Cost
-
eacCost:
object Cost
-
eacCostProject:
object Cost
-
earnedCost:
object Cost
-
earnedCostProject:
object Cost
-
etcCost:
object Cost
-
etcCostProject:
object Cost
-
installedCost:
object Cost
-
installedCostProject:
object Cost
-
link(optional):
string(url)
Read Only:
true
-
pendingChangedCost:
object Cost
-
pendingChangedCostProject:
object Cost
-
plannedCost:
object Cost
-
plannedCostProject:
object Cost
-
rate:
object Cost
-
rateProject:
object Cost
-
remainingCost:
object Cost
-
remainingCostProject:
object Cost
-
revisedCost:
object Cost
-
revisedCostProject:
object Cost
-
scopeItemAssignmentId:
integer(int64)
-
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 : Cost
Type:
object
Nested Schema : ApiEntityScopeItemAssignmentMilestone
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
milestone(optional):
object ApiEntityRuleOfCreditMilestone
-
milestoneProgressPercent:
object Percent
-
percentComplete:
object Percent
-
scopeItemAssignmentId:
integer(int64)
The unique identifier of a work package.
-
scopeItemAssignmentMilestoneId(optional):
integer(int64)
-
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 : ApiEntityRuleOfCreditMilestone
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
milestoneId(optional):
integer(int64)
-
milestoneName(optional):
string
Allowed Values:
[ "Length[1-255]" ]
The name of the milestone for the rule of credit. -
percentComplete(optional):
object Percent
-
ruleOfCreditId(optional):
integer(int64)
The unique identifier of a rule of credit.
-
sequenceNumber(optional):
integer(int32)
The number that specifies the position of a milestone in a milestone list.
-
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 : ApiEntityCodeValueScopeItemAssignment
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue(optional):
object ApiEntityCodeValue
-
codeValueScopeItemId(optional):
integer(int64)
The unique identifier of a work package code value.
-
link(optional):
string(url)
Read Only:
true
-
scopeItemAssignmentId(optional):
integer(int64)
The unique identifier of a work package.
-
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 : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
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(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
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. -
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(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
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(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 : 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(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
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 : additionalProperties
Type:
object
204 Response
Successful operation with no content.
404 Response
The requested scope item assignment does not exist, or you do not have access to it.