View Integrated CBSs
get
/primeapi/restapi/cbs/project/externallySourced
This endpoint returns all integrated CBS objects.
Request
There are no request parameters for this operation.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityExternallySourcedCBSSheetCode
Type:
Show Source
object
-
cbsCode:
string
Allowed Values:
[ "Length[1-60]" ]
The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition. -
copiedFromItem:
integer(int64)
The unique identifier for the original ID.
-
costItemId:
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.
-
costSheetId:
integer(int64)
The unique identifier of a cost sheet.
-
costSheetRow:
object ApiEntityCBSSheetRow
-
costSheetRowCost:
object ApiEntityCBSSheetRowCost
-
costType:
string
Allowed Values:
[ "CAPITAL", "EXPENSE", "NONE" ]
The category of the cost breakdown structure code.
Expense: Represents an expense.
Capital: Represents capital.
None: Type is not divided into expense or capital. None is selected by default if no other choice is made. -
description:
string
Allowed Values:
[ "Length[0-255]" ]
The name of the CBS code. -
isActive:
boolean
Default Value:
false
The active field indicates whether the CBS code is active for use. -
isTotalRow:
boolean
Default Value:
false
Indicates this item represents the total cost of the project. -
link:
string(uri)
Read Only:
true
-
parent:
integer(int64)
-
projectCode:
string
The user-specified identifier of a project.
-
sequenceNumber:
integer(int64)
Number that specifies the position of the cost sheet item.
-
sourceId:
string
The unique identifier of cost sheet item data in an external source.Example:
coarse
-
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.
-
workspaceId:
integer(int64)
The system-generated identifier of a workspace.
Nested Schema : ApiEntityCBSSheetRow
Type:
Show Source
object
-
actualHoursToDate:
object Hour
-
approvedChangedHours:
object Hour
-
atCompletionHours:
object Hour
-
bacHours:
object Hour
-
baselineHours:
object Hour
-
cbssheetRowConfiguredFields:
object ApiEntityCBSSheetRowConfiguredFields
-
costSheetItemId:
integer(int64)
-
eacHours:
object Hour
-
earnedHours:
object Hour
-
etcAdjustedHours:
object Hour
-
etcHours:
object Hour
-
installedHours:
object Hour
-
isActualsAssigned:
boolean
Default Value:
false
-
isBudgetAssigned:
boolean
Default Value:
false
-
isRiskAssigned:
boolean
Default Value:
false
-
isScopeItemAssigned:
boolean
Default Value:
false
-
link:
string(uri)
Read Only:
true
-
pendingChangedHours:
object Hour
-
plannedHours:
object Hour
-
projectActualHours:
object Hour
-
projectEarnedHours:
object Hour
-
projectHPI:
object Hour
-
remainingHours:
object Hour
-
revisedHours:
object Hour
-
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 : ApiEntityCBSSheetRowCost
Type:
Show Source
object
-
actualCostToDate:
object Cost
-
actualCostToDateProject:
object Cost
-
actualRiskResponse:
object Cost
-
actualRiskResponseProject:
object Cost
-
actualRiskResponseWorkspace1:
object Cost
-
actualRiskResponseWorkspace2:
object Cost
-
actualRiskResponseWorkspace3:
object Cost
-
adjustedCost:
object Cost
-
adjustedCostProject:
object Cost
-
approvedChangeCommitments:
object Cost
-
approvedChangeCommitmentsProject:
object Cost
-
approvedChangeCommitmentsWorkspace1:
object Cost
-
approvedChangeCommitmentsWorkspace2:
object Cost
-
approvedChangeCommitmentsWorkspace3:
object Cost
-
approvedChangeContracts:
object Cost
-
approvedChangeContractsProject:
object Cost
-
approvedChangeContractsWorkspace1:
object Cost
-
approvedChangeContractsWorkspace2:
object Cost
-
approvedChangeContractsWorkspace3:
object Cost
-
approvedChangedCost:
object Cost
-
approvedChangedCostProject:
object Cost
-
approvedCommitments:
object Cost
-
approvedCommitmentsProject:
object Cost
-
approvedCommitmentsWorkspace1:
object Cost
-
approvedCommitmentsWorkspace2:
object Cost
-
approvedCommitmentsWorkspace3:
object Cost
-
approvedContracts:
object Cost
-
approvedContractsProject:
object Cost
-
approvedContractsWorkspace1:
object Cost
-
approvedContractsWorkspace2:
object Cost
-
approvedContractsWorkspace3:
object Cost
-
approvedManualBudget:
object Cost
-
approvedManualBudgetChanges:
object Cost
-
approvedManualBudgetChangesProject:
object Cost
-
approvedManualBudgetChangesWorkspace1:
object Cost
-
approvedManualBudgetChangesWorkspace2:
object Cost
-
approvedManualBudgetChangesWorkspace3:
object Cost
-
approvedManualBudgetProject:
object Cost
-
approvedManualBudgetTransfers:
object Cost
-
approvedManualBudgetTransfersProject:
object Cost
-
approvedManualBudgetTransfersWorkspace1:
object Cost
-
approvedManualBudgetTransfersWorkspace2:
object Cost
-
approvedManualBudgetTransfersWorkspace3:
object Cost
-
approvedManualBudgetWorkspace1:
object Cost
-
approvedManualBudgetWorkspace2:
object Cost
-
approvedManualBudgetWorkspace3:
object Cost
-
approvedManualCurrentBudget:
object Cost
-
approvedManualCurrentBudgetProject:
object Cost
-
approvedManualCurrentBudgetWorkspace1:
object Cost
-
approvedManualCurrentBudgetWorkspace2:
object Cost
-
approvedManualCurrentBudgetWorkspace3:
object Cost
-
approvedProjectActuals:
object Cost
-
approvedProjectActualsProject:
object Cost
-
approvedProjectActualsWorkspace1:
object Cost
-
approvedProjectActualsWorkspace2:
object Cost
-
approvedProjectActualsWorkspace3:
object Cost
-
approvedRevenue:
object Cost
-
approvedRevenueProject:
object Cost
-
approvedRevenueWorkspace1:
object Cost
-
approvedRevenueWorkspace2:
object Cost
-
approvedRevenueWorkspace3:
object Cost
-
approvedSpends:
object Cost
-
approvedSpendsProject:
object Cost
-
approvedSpendsWorkspace1:
object Cost
-
approvedSpendsWorkspace2:
object Cost
-
approvedSpendsWorkspace3:
object Cost
-
atCompletionCost:
object Cost
-
atCompletionCostProject:
object Cost
-
bacCost:
object Cost
-
bacCostProject:
object Cost
-
baselineCost:
object Cost
-
baselineCostProject:
object Cost
-
closedPostExposure:
object Cost
-
closedPostExposureProject:
object Cost
-
closedPostExposureWorkspace1:
object Cost
-
closedPostExposureWorkspace2:
object Cost
-
closedPostExposureWorkspace3:
object Cost
-
closedPreExposure:
object Cost
-
closedPreExposureProject:
object Cost
-
closedPreExposureWorkspace1:
object Cost
-
closedPreExposureWorkspace2:
object Cost
-
closedPreExposureWorkspace3:
object Cost
-
costSheetItemId:
integer(int64)
The unique identifier of a cost row item.
-
currentBudget:
object Cost
-
currentBudgetProject:
object Cost
-
currentBudgetWorkspace1:
object Cost
-
currentBudgetWorkspace2:
object Cost
-
currentBudgetWorkspace3:
object Cost
-
currentCommitments:
object Cost
-
currentCommitmentsProject:
object Cost
-
currentCommitmentsWorkspace1:
object Cost
-
currentCommitmentsWorkspace2:
object Cost
-
currentCommitmentsWorkspace3:
object Cost
-
currentContracts:
object Cost
-
currentContractsProject:
object Cost
-
currentContractsWorkspace1:
object Cost
-
currentContractsWorkspace2:
object Cost
-
currentContractsWorkspace3:
object Cost
-
eacCost:
object Cost
-
eacCostProject:
object Cost
-
earnedCost:
object Cost
-
earnedCostProject:
object Cost
-
etcCost:
object Cost
-
etcCostProject:
object Cost
-
installedCost:
object Cost
-
installedCostProject:
object Cost
-
link:
string(uri)
Read Only:
true
-
openPostExposure:
object Cost
-
openPostExposureProject:
object Cost
-
openPostExposureWorkspace1:
object Cost
-
openPostExposureWorkspace2:
object Cost
-
openPostExposureWorkspace3:
object Cost
-
openPreExposure:
object Cost
-
openPreExposureProject:
object Cost
-
openPreExposureWorkspace1:
object Cost
-
openPreExposureWorkspace2:
object Cost
-
openPreExposureWorkspace3:
object Cost
-
pendingChangeCommitments:
object Cost
-
pendingChangeCommitmentsProject:
object Cost
-
pendingChangeCommitmentsWorkspace1:
object Cost
-
pendingChangeCommitmentsWorkspace2:
object Cost
-
pendingChangeCommitmentsWorkspace3:
object Cost
-
pendingChangeContracts:
object Cost
-
pendingChangeContractsProject:
object Cost
-
pendingChangeContractsWorkspace1:
object Cost
-
pendingChangeContractsWorkspace2:
object Cost
-
pendingChangeContractsWorkspace3:
object Cost
-
pendingChangedCost:
object Cost
-
pendingChangedCostProject:
object Cost
-
pendingCommitments:
object Cost
-
pendingCommitmentsProject:
object Cost
-
pendingCommitmentsWorkspace1:
object Cost
-
pendingCommitmentsWorkspace2:
object Cost
-
pendingCommitmentsWorkspace3:
object Cost
-
pendingContracts:
object Cost
-
pendingContractsProject:
object Cost
-
pendingContractsWorkspace1:
object Cost
-
pendingContractsWorkspace2:
object Cost
-
pendingContractsWorkspace3:
object Cost
-
pendingManualBudget:
object Cost
-
pendingManualBudgetChanges:
object Cost
-
pendingManualBudgetChangesProject:
object Cost
-
pendingManualBudgetChangesWorkspace1:
object Cost
-
pendingManualBudgetChangesWorkspace2:
object Cost
-
pendingManualBudgetChangesWorkspace3:
object Cost
-
pendingManualBudgetProject:
object Cost
-
pendingManualBudgetTransfers:
object Cost
-
pendingManualBudgetTransfersProject:
object Cost
-
pendingManualBudgetTransfersWorkspace1:
object Cost
-
pendingManualBudgetTransfersWorkspace2:
object Cost
-
pendingManualBudgetTransfersWorkspace3:
object Cost
-
pendingManualBudgetWorkspace1:
object Cost
-
pendingManualBudgetWorkspace2:
object Cost
-
pendingManualBudgetWorkspace3:
object Cost
-
pendingProjectActuals:
object Cost
-
pendingProjectActualsProject:
object Cost
-
pendingProjectActualsWorkspace1:
object Cost
-
pendingProjectActualsWorkspace2:
object Cost
-
pendingProjectActualsWorkspace3:
object Cost
-
pendingRevenue:
object Cost
-
pendingRevenueProject:
object Cost
-
pendingRevenueWorkspace1:
object Cost
-
pendingRevenueWorkspace2:
object Cost
-
pendingRevenueWorkspace3:
object Cost
-
pendingSpends:
object Cost
-
pendingSpendsProject:
object Cost
-
pendingSpendsWorkspace1:
object Cost
-
pendingSpendsWorkspace2:
object Cost
-
pendingSpendsWorkspace3:
object Cost
-
plannedCost:
object Cost
-
plannedCostProject:
object Cost
-
plannedRiskResponse:
object Cost
-
plannedRiskResponseProject:
object Cost
-
plannedRiskResponseWorkspace1:
object Cost
-
plannedRiskResponseWorkspace2:
object Cost
-
plannedRiskResponseWorkspace3:
object Cost
-
projectActualCost:
object Cost
-
projectActualCostProject:
object Cost
-
projectCPI:
number
The unique identifier of a cost row item.
-
projectCPIProject:
number
The CPI cost of a project.
-
projectEarnedCost:
object Cost
-
projectEarnedCostProject:
object Cost
-
remainingCost:
object Cost
-
remainingCostProject:
object Cost
-
revisedCost:
object Cost
-
revisedCostProject:
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 : ApiEntityCBSSheetRowConfiguredFields
Type:
Show Source
object
-
cbsSheetRow:
object ApiEntityCBSSheetRow
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost type configured fields in the form of key-value pairs.
-
costItemId:
integer(int64)
The unique identifier for the scope assignment for which the user defined field table is associated.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-text and non-cost configured fields in the form of key-value pairs.
-
primaryKey:
integer(int64)
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
uniqueName:
string
-
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 type configured fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-text and non-cost configured 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.