View all Scope Items by PBS
get
/api/restapi/scopeItem/pbsId/{pbsId}
This endpoint returns scope items that meet the following requirements:
- The object is associated with a PBS with an ID value that matches the value of the {pbsId} path parameter.
Request
Path Parameters
-
pbsId(required): integer(int64)
The system-generated identifier of a PBS.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityScopeItem>
Type:
array
Title:
Show Source
List<ApiEntityScopeItem>
-
Array of:
object ApiEntityScopeItem
Title:
ApiEntityScopeItem
Nested Schema : ApiEntityScopeItem
Type:
object
Title:
Show Source
ApiEntityScopeItem
-
actualUnitsToDate: integer
(int64)
The total amount of the scope item installed.
Calculated as the sum of Installed Quantity for all scope assignments. -
approvedChangedHours: number
(double)
The total number of hours approved for scope item changes.
-
approvedChangedUnits: integer
(int64)
The total quantity approved for scope item changes.
-
assignedHours: number
(double)
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. -
assignedUnits: integer
(int64)
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. -
atCompletionUnits: integer
(int64)
The total amount of the scope item to be installed for the project.
Calculated as Revised Quantity plus Adjusted Quantity. -
baselineHours: number
(double)
Minimum Value:
0
The Revised Hours at the time the baseline was set. -
baselineUnits: integer
(int64)
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. -
cbsCode: string
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: arraycbsCodesDeprecated. 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. -
cbsSheetCodeId: integer
(int64)
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: array
configuredFields
The list of configured fields for a scope item.
-
costCategoryAbbr: string
Minimum Length:
1
Maximum Length:10
The abbreviation for the cost category name. -
costCategoryId: integer
(int64)
The system-generated identifier of a cost category.
-
costCategoryName: string
Minimum Length:
1
Maximum Length:255
The name of the cost category. -
costCategoryType: string
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. -
currentHoursPerUnit: 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: string
Minimum Length:
0
Maximum Length:4000
Details describing the scope item. -
effectiveFinish: string
(date-time)
The latest Effective Finish date for Actual to Date values of all scope item's scope assignments.
-
effectiveStart: string
(date-time)
The earliest Effective Start date for Actual to Date values of all the scope item's scope assignments.
-
etcAdjustedUnits: integer
(int64)
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. -
installedUnits: integer
(int64)
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. -
itemCodeUpper: string
Maximum Length:
60
The code of an upper scope item. -
itemName: string
Minimum Length:
1
Maximum Length:255
The name of the scope item. -
itemNameUpper: string
Maximum Length:
255
The name of an upper scope item. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
pbsCode: string
Minimum Length:
1
Maximum Length:60
A unique identifier for the PBS node. -
pbsCodeHierarchy: arraypbsCodeHierarchyDeprecated. As of 23.11.The list of PBS codes in hierarchical way. -
pbsId: integer
(int64)
The system-generated identifier of the parent PBS associated with the scope item.
-
pendingChangedHours: number
(double)
The total number of hours waiting for approval on a scope item.
-
pendingChangedUnits: integer
(int64)
The total quantity waiting for approval on a scope item.
-
percentComplete: number
(double)
Sum of Quantity Completed Weight for the scope items assigned to work packages divided by Revised Quantity for the scope item.
-
plannedHours: number
(double)
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. -
plannedHoursPerUnit: number
(double)
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. -
plannedUnits: integer
(int64)
Minimum Value:
0
The original expected amount of material or product required for a scope item. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
remainingUnits: integer
(int64)
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. -
revisedHours: number
(double)
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. -
revisedUnits: integer
(int64)
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. -
scopeItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
scopeItemCodeValue: array
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.
-
scopeItemId: integer
(int64)
The system-generated identifier of a scope item.
-
status: string
Allowed Values:
[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ]
The state of the scope item in the change request. -
unAssignedHours: number
(double)
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.
-
unAssignedUnits: integer
(int64)
Minimum Value:
0
The total number of hours waiting for approval on a scope item. -
unitOfMeasureId: integer
(int64)
The name of the measurement type used to describe the quantity of a scope item.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
weightedUnits: integer
(int64)
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. -
workspaceCode: string
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
-
Array of:
object ApiEntityScopeItemConfiguredFieldValue
Title:
ApiEntityScopeItemConfiguredFieldValue
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
-
Array of:
object ApiEntityCodeValueScopeItem
Title:
ApiEntityCodeValueScopeItem
Nested Schema : ApiEntityScopeItemConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityScopeItemConfiguredFieldValue
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: number
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: string
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
scopeItemConfiguredFieldValueId: integer
(int64)
The unique identifier for the Scope Item Configured Field.
-
scopeItemId: integer
(int64)
The system-generated identifier of a Scope Item.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityCodeValueScopeItem
Type:
object
Title:
Show Source
ApiEntityCodeValueScopeItem
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: string
Minimum Length:
0
Maximum Length:255
The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
codeValueScopeItemId: integer
(int64)
The unique identifier for the code value assigned to the scope item.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
scopeItemId: integer
(int64)
The unique identifier of a scope item.
-
sequenceNumber: integer
(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate: string
(date-time)
Date when the record was last updated.
204 Response
Successful operation with no content.
404 Response
The requested scope item does not exist, or you do not have access to it.