View a Work Package by Assigned Code Value
get
/primeapi/restapi/workPackage/project/{id}/codeType/{typeId}/codeValue/{code}
This endpoint returns work packages that meet the following requirements:
- The object is assigned a code type that matches the value of the {typeId} path parameter with a value that matches the value of the {code} path parameter.
Request
Path Parameters
-
code: string
The user-specified identifier of a code value.
-
id: integer(int64)
The system-generated identifier of a code value.
-
typeId: integer(int64)
The system-generated identifier of a code value type.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityWorkPackage
Type:
Show Source
object
-
activityPercentComplete:
object Percent
-
activityWeightMethod:
string
Allowed Values:
[ "DURATION", "LABOR_UNITS", "NON_LABOR_UNITS", "MANUAL" ]
The method used to calculate Activity Percent Complete. Methods are Duration, Labor Units, Non Labor Units, and Manual.
Duration: Planned Duration, also known as Original Duration, is used for Weight.
Labor Units: At Completion Labor Units is used for Weight.
Non Labor Units: At Completion NonLabor Units is used for Weight.
Manual: Weight is added manually. -
actualFinishDate:
string(date-time)
The date work on the work package is complete.
-
actualStartDate:
string(date-time)
The date work on the work package began.
-
baselineFinishDate:
string(date-time)
The planned finish date for the work package as is set in the current baseline.
-
baselineStartDate:
string(date-time)
The planned start date for the work package as is set in the current baseline.
-
budgetCompleteMethod:
string
Allowed Values:
[ "REVISED", "AT_COMPLETION" ]
The setting allows users to select which value to use for populating BAC fields when a baseline is set. Choose At Completion to include adjusted values. -
codeValues:
array codeValues
Unique Items Required:
true
A code value object. -
curveId:
integer(int64)
The curve profile used for time phase distribution of scope assignments.
-
description:
string
Allowed Values:
[ "Length[0-4000]" ]
Provides additional details about the work package. -
eacWithSpendsHours:
object Hour
-
earnedPercentComplete:
object Percent
-
effectiveDate:
string(date-time)
The latest Effective Finish date of all scope assignments in the work package.
-
effectiveStartDate:
string(date-time)
The earliest Effective Start date of all scope assignments in the work package.
-
installedFinishDate:
string(date-time)
The date work on the work package is complete.
-
installedStartDate:
string(date-time)
The date work on the work package began.
-
link(optional):
string(url)
Read Only:
true
-
manager(optional):
integer(int64)
The manager or person responsible for the work package.
-
milestoneProgressType:
string
Allowed Values:
[ "SEQUENTIAL", "NON_SEQUENTIAL" ]
Determines how the milestones are progressed if the Progress Measure is set to Milestone Percent Complete.
Sequential: Milestones must be progressed in order.
Non Sequential: Milestones can be progressed in whatever order necessary. -
originalFinishDate:
string(date-time)
The date the work on the work package is scheduled to finish.
-
originalStartDate:
string(date-time)
The date the work on the work package is scheduled to begin.
-
percentComplete:
object Percent
-
percentCompleteMethod:
string
Allowed Values:
[ "MILESTONE_PERCENT_COMPLETE", "PHYSICAL_PERCENT_COMPLETE" ]
The method used to measure progress.
Milestone Percent Complete: This option uses a selected Rule of Credit to measure progress.
Physical Percent Complete: This option allows users to manually enter Installed Quantity for scope assignments. -
percentCompleteWeightedBy:
string
Allowed Values:
[ "COST", "QUANTITY", "HOURS" ]
The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow.
The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete.
Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity.
The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n.
Completed Weight for the Manual option is calculated as Manual Weight multiplied by Scope Percent Complete.
Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Completed Weight divided by the sum of Manual Weight for all scope assignments in the work package. -
plannedFinishDate:
string(date-time)
The date the work on the work package is scheduled to finish.
-
plannedStartDate:
string(date-time)
The date the work on the work package is scheduled to begin.
-
projectId(optional):
integer(int64)
The ID for the project where the work package exists.
-
remainingEarlyFinishDate:
string(date-time)
The earliest date the work on the work package is scheduled to finish.
-
remainingEarlyStartDate:
string(date-time)
The earliest date the work on the work package is scheduled to begin.
If the work package does not have scope assignments, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, it inherits the Data Date when the Modify Dates feature is run if the work package's Scope Percent Complete is not equal to 100%. -
remainingLateFinishDate:
string(date-time)
The latest possible date work on the work package must finish to not delay the finish date.
-
remainingLateStartDate:
string(date-time)
The latest possible date work on the work package must begin without delaying the finish date.
-
revisedFinishDate:
string(date-time)
The revised finish date for the work package.
If the work package does not have scope assignments, this field is populated with the Original Finish date until the original baseline is set.
When the Modify Dates feature is run after the original baseline is set, the Revised Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, the Revised Finish date is updated to be the same date relative to the Revised Start date as it was before the Data Date was modified.
If the work package has scope assignments, the date is always the latest finish of its scope assignments' Planned Finish dates and all approved Change Finish dates. -
revisedStartDate:
string(date-time)
The revised start date for the work package.
If the work package does not have scope assignments, this field is populated with the Original Start date until the original baseline is set.
This field is populated with the Data Date when the Modify Dates feature is run after the original baseline is set if the Revised Start date is before the Data Date and the work package's Scope Percent Complete is equal to 0%.
If the work package has scope assignments, is always the earliest start of its scope assignments' Planned Start dates and all approved Change Start dates. -
ruleOfCredit(optional):
object ApiEntityRuleOfCredit
-
spendsHours:
object Hour
-
status:
string
Allowed Values:
[ "PENDING", "APPROVED", "REJECTED" ]
The status of the 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. -
wbsId(optional):
integer(int64)
The WBS that the work package is associated with.
-
workPackageCode(optional):
string
Allowed Values:
[ "Length[1-60]" ]
The unique identifier for the work package. -
workPackageConfiguredFields(optional):
object ApiEntityWorkPackageConfiguredFields
-
workPackageCost(optional):
object ApiEntityWorkPackageCost
-
workPackageId(optional):
integer(int64)
The ID for the work package.
-
workPackageName(optional):
string
Allowed Values:
[ "Length[1-255]" ]
The name of the work package.
Nested Schema : ApiEntityRuleOfCredit
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
milestones(optional):
array milestones
Unique Items Required:
true
The milestones associated with the rule of credit. -
rocId(optional):
integer(int64)
-
rocName(optional):
string
Allowed Values:
[ "Length[1-255]" ]
The name of the rule of credit. -
type(optional):
string
Allowed Values:
[ "MANUAL", "ZERO_TO_ONE_HUNDRED" ]
Determines how each milestone in a rule of credit can be progressed.
Manual: Allows partial completion of a milestone, entered as a percentage.
0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete. -
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 workspace where the Rules of Credit apply.
Nested Schema : ApiEntityWorkPackageConfiguredFields
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)
-
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. -
workPackage(optional):
object ApiEntityWorkPackage
-
workPackageId(optional):
integer(int64)
The ID for the work package.
Nested Schema : ApiEntityWorkPackageCost
Type:
Show Source
object
-
eacWithSpendsCost:
object Cost
-
eacWithSpendsCostProject:
object Cost
-
link(optional):
string(url)
Read Only:
true
-
spendsCost:
object Cost
-
spendsCostProject:
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. -
workPackageId:
integer(int64)
The ID for the work package.
Nested Schema : ApiEntityCodeValueWorkPackage
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue(optional):
object ApiEntityCodeValue
-
codeValueWorkPackageId(optional):
integer(int64)
The unique identifier of a work package code value.
-
link(optional):
string(url)
Read Only:
true
-
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. -
workPackageId(optional):
integer(int64)
The unique identifier of a work package.
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 : milestones
Type:
array
Unique Items Required:
true
The milestones associated with the rule of credit.
Show Source
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 : 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 : 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 : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
204 Response
Successful operation with no content.
404 Response
The requested work package does not exist, or you do not have access to it.