1. Oracle Primavera Cloud REST API
  2. Tasks
  3. Scope Item

View a Scope Item

get

/api/restapi/scopeItem/{scopeItemId}

This endpoint returns scope items that meet the following requirements:
  • The object is associated with a scope item with an ID value that matches the value of the {scopeItemId} path parameter.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : ApiEntityScopeItem
Type: object
Title: ApiEntityScopeItem
Show Source
  • The total amount of the scope item installed.
    Calculated as the sum of Installed Quantity for all scope assignments.
  • The total number of hours approved for scope item changes.
  • The total quantity approved for scope item changes.
  • Minimum Value: 0
    The total number of hours that have been distributed to work packages by way of scope assignments. After the original baseline is set, this number includes all approved hour changes.
  • Minimum Value: 0
    The total quantity distributed to work packages by way of scope assignments. After the original baseline is set, this number is updated to also reflect scope assignments that are created from approved quantity changes of the scope item.
  • The total amount of the scope item to be installed for the project.
    Calculated as Revised Quantity plus Adjusted Quantity.
  • Minimum Value: 0
    The Revised Hours at the time the baseline was set.
  • Minimum Value: 0
    The total quantity that has not been distributed to work packages. This is the amount that is available for distribution to scope assignments. After the original baseline is set, this includes all approved quantity changes for scope items.
  • Minimum Length: 1
    Maximum Length: 60
    The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.
  • cbsCodes
    Deprecated. As of 23.11.
    List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
  • The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
  • configuredFields
    The list of configured fields for a scope item.
  • Minimum Length: 1
    Maximum Length: 10
    The abbreviation for the cost category name.
  • The system-generated identifier of a cost category.
  • Minimum Length: 1
    Maximum Length: 255
    The name of the cost category.
  • Allowed Values: [ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ]
    The classification of the cost category.
    Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate.
    Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
    Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
    Other: Cost is manually entered as a lump sum.
  • 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.
  • Minimum Length: 0
    Maximum Length: 4000
    Details describing the scope item.
  • The latest Effective Finish date for Actual to Date values of all scope item's scope assignments.
  • The earliest Effective Start date for Actual to Date values of all the scope item's scope assignments.
  • The scope item quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
    This is a manual entry field.
  • The amount of material or product that has been installed to date.
    This is the cumulative value for all scope assignments created for the scope item.
  • Maximum Length: 60
    The code of an upper scope item.
  • Minimum Length: 1
    Maximum Length: 255
    The name of the scope item.
  • Maximum Length: 255
    The name of an upper scope item.
  • Minimum Length: 1
    Maximum Length: 60
    A unique identifier for the PBS node.
  • pbsCodeHierarchy
    Deprecated. As of 23.11.
    The list of PBS codes in hierarchical way.
  • The system-generated identifier of the parent PBS associated with the scope item.
  • The total number of hours waiting for approval on a scope item.
  • The total quantity waiting for approval on a scope item.
  • Sum of Quantity Completed Weight for the scope items assigned to work packages divided by Revised Quantity for the scope item.
  • Minimum Value: 0
    The original expected hours needed to complete all the work on a scope item.
    Calculated as Original Quantity multiplied by Original Productivity Rate.
  • Minimum Value: 0
    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.
  • Minimum Value: 0
    The original expected amount of material or product required for a scope item.
  • Minimum Length: 1
    Maximum Length: 60
    The unique identifier for a project set by the user who created the project.
  • The unique identifier for the project.The project object can also be identified by its unique criteria.
  • The quantity remaining for the scope item.
    Calculated as Revised Quantity for the scope item minus the sum of Installed Quantity for the scope item's assignments.
  • Minimum Value: 0
    The total number of hours needed to complete all the work on a scope item, including any approved changes. This value equals the Original Hours before the original baseline is set.
    Calculated as the sum of Original Hours plus Approved Changed Hours, if any.
  • Minimum Value: 0
    The total quantity that has been revised to account for approved changes for a scope item.
    Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.
  • Minimum Length: 1
    Maximum Length: 60
    The user-specified unique identifier for the scope item.
  • scopeItemCodeValue
    The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.
  • The system-generated identifier of a scope item.
  • Allowed Values: [ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ]
    The state of the scope item in the change request.
  • The total number of hours that have not been distributed to work packages for a scope item. This is the amount that is available for distribution to scope assignments. After the original baselines is set, this includes all Approved Change Hours.
  • Minimum Value: 0
    The total number of hours waiting for approval on a scope item.
  • The name of the measurement type used to describe the quantity of a scope item.
  • Date when the record was last updated.
  • The amount of material or product that has been weighted to date.
    This is the cumulative value for all scope assignments created for the scope item.
  • Minimum Length: 0
    Maximum Length: 60
    The user-specified identifier of a workspace.
Nested Schema : cbsCodes
Type: array
Deprecated. As of 23.11.
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for a scope item.
Show Source
Nested Schema : pbsCodeHierarchy
Type: array
Deprecated. As of 23.11.
The list of PBS codes in hierarchical way.
Show Source
Nested Schema : scopeItemCodeValue
Type: array
The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
Nested Schema : ApiEntityScopeItemConfiguredFieldValue
Type: object
Title: ApiEntityScopeItemConfiguredFieldValue
Show Source
Nested Schema : ApiEntityCodeValueScopeItem
Type: object
Title: ApiEntityCodeValueScopeItem
Show Source

404 Response

The requested scope item does not exist, or you do not have access to it.
Back to Top