Oracle Prime Cloud Release 16

Returns the scope item for the specified scope item code.

get

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

Request

Path Parameters

code: Type: string

Required: true

Code of the Scope Item.

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityScopeItem

Type: object

Properties

approvedChangedHours: Type: object Hour

Required: true
approvedChangedUnits: Type: object Quantity

Required: true
assignedHours: Type: object Hour

Required: true
assignedUnits: Type: object Quantity

Required: true
atCompletionUnits: Type: object Quantity

Required: true
baselineHours: Type: object Hour

Required: true
baselineUnits: Type: object Quantity

Required: true
costSheetItemId: Type: integer (int64)

The cost breakdown structure code assigned to the scope item.
currentHoursPerUnit: Type: number (double)

The number of hours required to install a single quantity of the scope item material or product based on current values. For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable. This field is recalculated if Current Hours are changed.
description: Type: string

Required: true

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

Details describing the scope item.
etcAdjustedUnits: Type: object Quantity

Required: true
itemCode: Type: string

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

The unique identifier for the scope item.
itemName: Type: string

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

The name of the scope item.
pbsId: Type: integer (int64)

The parent PBS for the scope item.
pendingChangedHours: Type: object Hour

Required: true
pendingChangedUnits: Type: object Quantity

Required: true
percentComplete: Type: object Percent

Required: true
plannedHours: Type: object Hour
plannedHoursPerUnit: Type: number (double)

The number of hours required to install or assemble a single quantity of the scope item material or product. For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable. Calculated as Original Hours divided by Original Quantity.
plannedUnits: Type: object Quantity
projectId: Type: integer (int64)

The ID for the project where the scope item exists.
remainingUnits: Type: object Quantity

Required: true
revisedHours: Type: object Hour

Required: true
revisedUnits: Type: object Quantity

Required: true
scopeItemCodeValue: Type: array scopeItemCodeValue

Unique Items Required: true

Lists all Scope Item code types assigned to the Scope Item with its corresponding value.
scopeItemFlexCost: Type: object ApiEntityScopeItemFlexCost
scopeItemFlexOther: Type: object ApiEntityScopeItemFlexOther
scopeItemFlexText: Type: object ApiEntityScopeItemFlexText
scopeItemId: Type: integer (int64)
status: Type: string

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

The state of the scope item in the change request.
unAssignedHours: Type: object Hour

Required: true
unAssignedUnits: Type: object Quantity

Required: true
unitOfMeasureId: Type: integer (int64)

Required: true

The name of the measurement type used to describe the quantity of a scope item.

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 : scopeItemCodeValue

Type: array

Unique Items Required: true

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

Items

Type: object ApiEntityCodeValueScopeItem

Nested Schema : ApiEntityScopeItemFlexCost

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured cost fields assigned to the Scope Item with its corresponding value as a (key,value) pair.
scopeItem: Type: object ApiEntityScopeItem
scopeItemId: Type: integer (int64)

Nested Schema : ApiEntityScopeItemFlexOther

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

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

Nested Schema : ApiEntityScopeItemFlexText

Type: object

Properties

flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured text fields assigned to the Scope Item with its corresponding value as a (key,value) pair.
scopeItem: Type: object ApiEntityScopeItem
scopeItemId: Type: integer (int64)

Nested Schema : ApiEntityCodeValueScopeItem

Type: object

Properties

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

The unique identifier for the code value assigned to the scope item.

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)