Oracle Prime Cloud Release 16

Returns the work package for the specified project ID and work package code.

get

/primeapi/restapi/v16.2/workPackage/project/{id}/code/{code}

Request

Path Parameters

code: Type: string

Required: true

Code of the Work Package to be found.
id: Type: integer (int64)

Required: true

Project ID of the Work Package.

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityWorkPackage

Type: object

Properties

activityPercentComplete: Type: object Percent

Required: true
activityWeightMethod: Type: string

Required: true

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: Type: string (date-time)

Required: true

The date work on the work package is complete.
actualStartDate: Type: string (date-time)

Required: true

The date work on the work package began.
baselineFinishDate: Type: string (date-time)

Required: true

The planned finish date for the work package as is set in the current baseline.
baselineStartDate: Type: string (date-time)

Required: true

The planned start date for the work package as is set in the current baseline.
budgetCompleteMethod: Type: string

Required: true

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.
curveId: Type: integer (int64)

Required: true

The curve profile used for time phase distribution of scope assignments.
description: Type: string

Required: true

Allowed Values: [ "Length[0-4000]" ]

Provides additional details about the work package.
eacWithSpendsHours: Type: object Hour

Required: true
earnedPercentComplete: Type: object Percent

Required: true
effectiveDate: Type: string (date-time)

Required: true

The latest Effective Finish date of all scope assignments in the work package.
effectiveStartDate: Type: string (date-time)

Required: true

The earliest Effective Start date of all scope assignments in the work package.
installedFinishDate: Type: string (date-time)

Required: true

The date work on the work package is complete.
installedStartDate: Type: string (date-time)

Required: true

The date work on the work package began.
manager: Type: integer (int64)

The manager or person responsible for the work package.
milestoneProgressType: Type: string

Required: true

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: Type: string (date-time)

Required: true

The date the work on the work package is scheduled to finish.
originalStartDate: Type: string (date-time)

Required: true

The date the work on the work package is scheduled to begin.
percentComplete: Type: object Percent

Required: true
percentCompleteMethod: Type: string

Required: true

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: Type: string

Required: true

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. Weight for the Manual option is calculated as Manual Weight Factor multiplied by Scope Percent Complete. Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Weight divided by the sum of Manual Weight Factors for all scope assignments in the work package.
plannedFinishDate: Type: string (date-time)

Required: true

The date the work on the work package is scheduled to finish.
plannedStartDate: Type: string (date-time)

Required: true

The date the work on the work package is scheduled to begin.
projectId: Type: integer (int64)

The ID for the project where the work package exists.
remainingEarlyFinishDate: Type: string (date-time)

Required: true

The earliest date the work on the work package is scheduled to finish.
remainingEarlyStartDate: Type: string (date-time)

Required: true

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: Type: string (date-time)

Required: true

The latest possible date work on the work package must finish to not delay the finish date.
remainingLateStartDate: Type: string (date-time)

Required: true

The latest possible date work on the work package must begin without delaying the finish date.
revisedFinishDate: Type: string (date-time)

Required: true

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: Type: string (date-time)

Required: true

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: Type: object ApiEntityRuleOfCredit
spendsHours: Type: object Hour

Required: true
status: Type: string

Required: true

Allowed Values: [ "PENDING", "APPROVED", "REJECTED" ]

The status of the work package.
wbsId: Type: integer (int64)

The WBS that the work package is associated with.
workPackageCode: Type: string

Allowed Values: [ "Length[1-60]" ]

The unique identifier for the work package.
workPackageCost: Type: object ApiEntityWorkPackageCost
workPackageFlexCost: Type: object ApiEntityWorkPackageFlexCost
workPackageFlexOther: Type: object ApiEntityWorkPackageFlexOther
workPackageFlexText: Type: object ApiEntityWorkPackageFlexText
workPackageId: Type: integer (int64)

The ID for the work package.
workPackageName: Type: string

Allowed Values: [ "Length[1-255]" ]

The name of the work package.

Nested Schema : Percent

Type: object

Properties

bigDecimal: Type: number
double: Type: number (double)

Nested Schema : Hour

Type: object

Properties

bigDecimal: Type: number
double: Type: number (double)

Nested Schema : ApiEntityRuleOfCredit

Type: object

Properties

rocId: Type: integer (int64)
rocName: Type: string

Allowed Values: [ "Length[1-255]" ]

The name of the rule of credit.
type: Type: 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.

Nested Schema : ApiEntityWorkPackageCost

Type: object

Properties

eacWithSpendsCost: Type: object Cost

Required: true
spendsCost: Type: object Cost

Required: true
workPackageId: Type: integer (int64)

Required: true

The ID for the work package.

Nested Schema : ApiEntityWorkPackageFlexCost

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured cost fields assigned to the Work Package with its corresponding value as a (key,value) pair.
workPackage: Type: object ApiEntityWorkPackage
workPackageId: Type: integer (int64)

Nested Schema : ApiEntityWorkPackageFlexOther

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured date, number, integer fields assigned to the Work Package with its corresponding value as a (key,value) pair.
workPackage: Type: object ApiEntityWorkPackage
workPackageId: Type: integer (int64)

Nested Schema : ApiEntityWorkPackageFlexText

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured text fields assigned to the Work Package with its corresponding value as a (key,value) pair.
workPackage: Type: object ApiEntityWorkPackage
workPackageId: Type: integer (int64)