Oracle Prime Cloud Release 16

Returns the scope item assignment for the specified scope item assignment code.

get

/primeapi/restapi/v16.2/scopeItemAssignment/code/{code}

Request

Path Parameters

code: Type: string

Required: true

Code of the Scope Item Assignment to be found.

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityScopeItemAssignment

Type: object

Properties

actualHoursToDate: Type: object Hour

Required: true
actualUnitsToDate: Type: object Quantity

Required: true
approvedChangedHours: Type: object Hour

Required: true
approvedChangedUnits: Type: object Quantity

Required: true
atCompletionHours: Type: object Hour
atCompletionUnits: Type: object Quantity
availableHours: Type: object Hour

Required: true
availableUnits: Type: object Quantity

Required: true
bacHours: Type: object Hour
bacUnits: Type: object Quantity

Required: true
baselineFinishDate: Type: 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: Type: object Hour

Required: true
baselineStartDate: Type: 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: Type: object Quantity

Required: true
code: Type: string

The unique identifier for the scope assignment.
currentHoursPerUnit: Type: 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: Type: integer (int64)

The curve profile selected for the scope assignment.
description: Type: string

Required: true

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

Additional details for the scope assignment.
eacHours: Type: object Hour

Required: true
eacUnits: Type: object Quantity

Required: true
earnedHours: Type: object Hour

Required: true
earnedPercentComplete: Type: object Percent

Required: true
earnedUnits: Type: object Quantity

Required: true
effectiveDate: Type: 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.
etcAdjustedHours: Type: object Hour

Required: true
etcAdjustedUnits: Type: object Quantity

Required: true
etcHours: Type: object Hour

Required: true
etcUnits: Type: object Quantity

Required: true
hoursPerUnit: Type: 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: Type: 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: Type: object Hour
installedStartDate: Type: 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: Type: object Quantity
managerId: Type: integer (int64)

The manager or person responsible for providing status on the scope assignment.
manualWeight: Type: number (double)

Calculated as Scope Percent Complete multiplied by Manual Weight Factor.
manualWeightFactor: Type: number (double)

The amount by which the manual weight is calculated when progress needs to be weighed against a factor other than quantity, hours, or cost.
milestoneProgressPercent: Type: object Percent

Required: true
milestones: Type: array milestones

Unique Items Required: true

Lists all Scope Item Assignment Milestones for this assignment.
originalFinishDate: Type: 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: Type: 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: Type: object Hour

Required: true
pendingChangedUnits: Type: object Quantity

Required: true
percentComplete: Type: object Percent

Required: true
plannedFinishDate: Type: 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: Type: object Hour
plannedStartDate: Type: 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: Type: object Quantity
progressStatus: Type: 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: Type: integer (int64)

The ID for the project that the work package belongs to.
rateBy: Type: string

Required: true

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

The latest possible date work on the scope assignment must begin without delaying the finish date.
remainingUnits: Type: object Quantity
revisedFinishDate: Type: 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.
revisedHours: Type: object Hour

Required: true
revisedStartDate: Type: 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.
revisedUnits: Type: object Quantity

Required: true
scopeItemAssignmentCodeValue: Type: array scopeItemAssignmentCodeValue

Unique Items Required: true

Lists all Scope Item Assignment code types assigned to the Scope Item Assignment with its corresponding value.
scopeItemAssignmentCost: Type: object ApiEntityScopeItemAssignmentCost
scopeItemAssignmentFlexCost: Type: object ApiEntityScopeItemAssignmentFlexCost
scopeItemAssignmentFlexOther: Type: object ApiEntityScopeItemAssignmentFlexOther
scopeItemAssignmentFlexText: Type: object ApiEntityScopeItemAssignmentFlexText
scopeItemAssignmentId: Type: integer (int64)

The unique identifier for the scope item assigned to the work package.
scopeItemId: Type: integer (int64)

The unique identifier of the scope item assigned to the work package.
status: Type: string

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

ENUM
weightedCost: Type: object Cost

Required: true
weightedCostProject: Type: object Cost
weightedHours: Type: object Hour

Required: true
weightedUnits: Type: object Quantity

Required: true
workPackageId: Type: integer (int64)

The unique identifier for the work package.

Nested Schema : Hour

Type: object

Properties

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

Nested Schema : Quantity

Type: object

Nested Schema : Percent

Type: object

Properties

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

Nested Schema : milestones

Type: array

Unique Items Required: true

Lists all Scope Item Assignment Milestones for this assignment.

Items

Type: object ApiEntityScopeItemAssignmentMilestone

Nested Schema : scopeItemAssignmentCodeValue

Type: array

Unique Items Required: true

Lists all Scope Item Assignment code types assigned to the Scope Item Assignment with its corresponding value.

Items

Type: object ApiEntityCodeValueScopeItemAssignment

Nested Schema : ApiEntityScopeItemAssignmentCost

Type: object

Properties

actualCostToDate: Type: object Cost

Required: true
actualCostToDateProject: Type: object Cost

Required: true
adjustedCost: Type: object Cost

Required: true
adjustedCostProject: Type: object Cost

Required: true
approvedChangedCost: Type: object Cost

Required: true
approvedChangedCostProject: Type: object Cost

Required: true
atCompletionCost: Type: object Cost

Required: true
atCompletionCostProject: Type: object Cost

Required: true
bacCost: Type: object Cost

Required: true
bacCostProject: Type: object Cost

Required: true
baselineCost: Type: object Cost

Required: true
baselineCostProject: Type: object Cost

Required: true
currentRate: Type: object Cost

Required: true
currentRateProject: Type: object Cost

Required: true
eacCost: Type: object Cost

Required: true
eacCostProject: Type: object Cost

Required: true
earnedCost: Type: object Cost

Required: true
earnedCostProject: Type: object Cost

Required: true
etcCost: Type: object Cost

Required: true
etcCostProject: Type: object Cost

Required: true
installedCost: Type: object Cost

Required: true
installedCostProject: Type: object Cost

Required: true
pendingChangedCost: Type: object Cost

Required: true
pendingChangedCostProject: Type: object Cost

Required: true
plannedCost: Type: object Cost

Required: true
plannedCostProject: Type: object Cost

Required: true
rate: Type: object Cost

Required: true
rateProject: Type: object Cost

Required: true
remainingCost: Type: object Cost

Required: true
remainingCostProject: Type: object Cost

Required: true
revisedCost: Type: object Cost

Required: true
revisedCostProject: Type: object Cost

Required: true
scopeItemAssignmentId: Type: integer (int64)

Required: true

Nested Schema : ApiEntityScopeItemAssignmentFlexCost

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured cost fields assigned to the Scope Item Assignment with its corresponding value as a (key,value) pair.
scopeItemAssignment: Type: object ApiEntityScopeItemAssignment
scopeItemAssignmentId: Type: integer (int64)

Nested Schema : ApiEntityScopeItemAssignmentFlexOther

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured date, number, integer fields assigned to the Scope Item Assignment with its corresponding value as a (key,value) pair.
scopeItemAssignment: Type: object ApiEntityScopeItemAssignment
scopeItemAssignmentId: Type: integer (int64)

Nested Schema : ApiEntityScopeItemAssignmentFlexText

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured text fields assigned to the Scope Item Assignment with its corresponding value as a (key,value) pair.
scopeItemAssignment: Type: object ApiEntityScopeItemAssignment
scopeItemAssignmentId: Type: integer (int64)

Nested Schema : Cost

Type: object

Nested Schema : ApiEntityScopeItemAssignmentMilestone

Type: object

Properties

milestone: Type: object ApiEntityRuleOfCreditMilestone
milestoneProgressPercent: Type: object Percent

Required: true
percentComplete: Type: object Percent

Required: true
scopeItemAssignmentMilestoneId: Type: integer (int64)

Nested Schema : ApiEntityRuleOfCreditMilestone

Type: object

Properties

milestoneId: Type: integer (int64)
milestoneName: Type: string

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

The name of the milestone for the rule of credit.
percentComplete: Type: object Percent

Nested Schema : ApiEntityCodeValueScopeItemAssignment

Type: object

Properties

codeType: Type: object ApiEntityCodeType
codeValue: Type: object ApiEntityCodeValue
codeValueScopeItemId: Type: integer (int64)

KEY

Nested Schema : ApiEntityCodeType

Type: object

Properties

assignments: Type: array assignments

Unique Items Required: true
codeTypeCode: Type: string

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

This field displays the name of a code or value.
codeTypeId: Type: integer (int64)
codeTypeName: Type: string

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

STRING
workspace: Type: integer (int64)

The ID of the owning workspace.

Nested Schema : ApiEntityCodeValue

Type: object

Properties

codeTypeId: Type: integer (int64)

The ID for the code type.
codeValueCode: Type: string

Allowed Values: [ "LENGTH[1-32]" ]

The unique identifier for the code value.
codeValueId: Type: integer (int64)

The unique identifier for the code value.
codeValueName: Type: string

Allowed Values: [ "LENGTH[1-100]" ]

The name of the code value.
parentCodeValue: Type: integer (int64)

The parent code value.
sequenceNumber: Type: integer (int32)

The number that specifies the position of the code value item within the code type list.

Nested Schema : assignments

Type: array

Unique Items Required: true

Items

Type: object ApiEntityCodeEntityType

Nested Schema : ApiEntityCodeEntityType

Type: object

Properties

codeType: Type: object ApiEntityCodeType
entityType: Type: string

Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "PROJECT_FUND", "WORKSPACE_FUND" ]
primaryKey: Type: integer (int64)