View Integrated Budget Items
get
/primeapi/restapi/budgetItem/externallySourced
This endpoint returns all integrated budget item objects.
Request
There are no request parameters for this operation.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityExternallySourcedBudgetItem
Type:
Show Source
object
-
abbreviation:
string
The abbreviated name of a cost category.
-
budgetChangeId:
integer(int64)
Indicates whether the budget item originated in a budget change.
-
budgetHours:
object Hour
-
budgetItemConfiguredFields:
object ApiEntityBudgetItemConfiguredFields
-
budgetItemCost:
object ApiEntityBudgetItemCost
-
budgetItemId:
integer(int64)
The system-generated identifier of a budget item.
-
cbsCode:
string
- The object has a code that matches the value of the {code} path parameter.
the CBS associated with this budget item. -
costCategoryId:
integer(int64)
The type of cost associated with the budget item.
-
costCategoryName:
string
- The object has a code that matches the value of the {code} path parameter.
the cost category assigned to this budget item. -
costSheetItemId:
integer(int64)
The name of the CBS Code.
-
itemCode:
string
The unique identifier of the project budget item.
-
itemName:
string
The name of the budget item.
-
itemSuffix:
integer(int64)
The suffix of a budget item code.
-
link:
string(uri)
Read Only:
true
-
productionRate:
object Hour
-
projectBudgetId:
integer(int64)
The system-generated identifier of a project budget.
-
projectCode:
string
- The object has a code that matches the value of the {code} path parameter.
the project associated with this budget item. -
quantity:
number(double)
The number of each budget item needed to complete the work.
-
sourceId:
string
The unique identifier of budget item data in an external source.Example:
coarse
-
unitsOfMeasureId:
integer(int64)
The Unit of Measure used for the budget item.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
workspaceCode:
string
The user-specified identifier of a workspace.
Nested Schema : ApiEntityBudgetItemConfiguredFields
Type:
Show Source
object
-
budgetItemId:
integer(int64)
The system-generated identifier of a budget item.
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost, non-text fields in the form of key-value pairs.
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : ApiEntityBudgetItemCost
Type:
Show Source
object
-
budgetItemId:
integer(int64)
The system-generated identifier of a budget item.
-
currentCost:
object Cost
-
currentCostProject:
object Cost
-
currentCostWorkspace1:
object Cost
-
currentCostWorkspace2:
object Cost
-
currentCostWorkspace3:
object Cost
-
laborRate:
object Cost
-
laborRateProject:
object Cost
-
laborRateWorkspace1:
object Cost
-
laborRateWorkspace2:
object Cost
-
laborRateWorkspace3:
object Cost
-
link:
string(uri)
Read Only:
true
-
originalCost:
object Cost
-
originalCostProject:
object Cost
-
originalCostWorkspace1:
object Cost
-
originalCostWorkspace2:
object Cost
-
originalCostWorkspace3:
object Cost
-
unitRate:
object Cost
-
unitRateProject:
object Cost
-
unitRateWorkspace1:
object Cost
-
unitRateWorkspace2:
object Cost
-
unitRateWorkspace3:
object Cost
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost, non-text fields in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
204 Response
Successful operation. No additional content included.