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(optional):
integer(int64)
The unique identifier for the original ID.
-
costItemId(optional):
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(optional):
integer(int64)
The unique identifier of a cost sheet.
-
costSheetRow(optional):
object ApiEntityCBSSheetRow
-
costSheetRowCost(optional):
object ApiEntityCBSSheetRowCost
-
costType(optional):
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(optional):
string
Allowed Values:
[ "Length[0-255]" ]
The name of the CBS code. -
isActive(optional):
boolean
The active field indicates whether the CBS code is active for use.
-
isTotalRow(optional):
boolean
Indicates this item represents the total cost of the project.
-
link(optional):
string(url)
Read Only:
true
-
parent(optional):
integer(int64)
The system-generated identifier of a parent cost item in a cost sheet.
-
projectCode(optional):
string
The user-specified identifier of a project.
-
sequenceNumber(optional):
integer(int64)
Number that specifies the position of the cost sheet item.
-
sourceId(optional):
string
The unique identifier of cost sheet item data in an external source.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceCode(optional):
string
The user-specified identifier of a workspace.
-
workspaceId(optional):
integer(int64)
The system-generated identifier of a workspace.
Nested Schema : ApiEntityCBSSheetRow
Type:
Show Source
object
-
actualHoursToDate(optional):
object Hour
-
approvedChangedHours(optional):
object Hour
-
atCompletionHours(optional):
object Hour
-
bacHours(optional):
object Hour
-
baselineHours(optional):
object Hour
-
cbssheetRowConfiguredFields(optional):
object ApiEntityCBSSheetRowConfiguredFields
-
costSheetItemId(optional):
integer(int64)
The CBS code assigned to the line item. This value should not be provided in create operation request data, however, it is required for update requests.
-
eacHours(optional):
object Hour
-
earnedHours(optional):
object Hour
-
etcAdjustedHours(optional):
object Hour
-
etcHours(optional):
object Hour
-
installedHours(optional):
object Hour
-
isActualsAssigned(optional):
boolean
Indicates if the cost sheet row is an actuals assignment.
-
isBudgetAssigned(optional):
boolean
Indicates whether the cost sheet row is a budget assignment.
-
isRiskAssigned(optional):
boolean
Indicates whether the cost sheet row is a risk assignment.
-
isScopeItemAssigned(optional):
boolean
Indicates whether the cost sheet row is a scope item assignment.
-
link(optional):
string(url)
Read Only:
true
-
pendingChangedHours(optional):
object Hour
-
plannedHours(optional):
object Hour
-
projectActualHours(optional):
object Hour
-
projectEarnedHours(optional):
object Hour
-
projectHPI(optional):
object Hour
-
remainingHours(optional):
object Hour
-
revisedHours(optional):
object Hour
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCBSSheetRowCost
Type:
Show Source
object
-
actualCostToDate(optional):
object Cost
-
actualCostToDateProject(optional):
object Cost
-
actualRiskResponse(optional):
object Cost
-
actualRiskResponseProject(optional):
object Cost
-
actualRiskResponseWorkspace1(optional):
object Cost
-
actualRiskResponseWorkspace2(optional):
object Cost
-
actualRiskResponseWorkspace3(optional):
object Cost
-
adjustedCost(optional):
object Cost
-
adjustedCostProject(optional):
object Cost
-
approvedChangeCommitments(optional):
object Cost
-
approvedChangeCommitmentsProject(optional):
object Cost
-
approvedChangeCommitmentsWorkspace1(optional):
object Cost
-
approvedChangeCommitmentsWorkspace2(optional):
object Cost
-
approvedChangeCommitmentsWorkspace3(optional):
object Cost
-
approvedChangeContracts(optional):
object Cost
-
approvedChangeContractsProject(optional):
object Cost
-
approvedChangeContractsWorkspace1(optional):
object Cost
-
approvedChangeContractsWorkspace2(optional):
object Cost
-
approvedChangeContractsWorkspace3(optional):
object Cost
-
approvedChangedCost(optional):
object Cost
-
approvedChangedCostProject(optional):
object Cost
-
approvedCommitments(optional):
object Cost
-
approvedCommitmentsProject(optional):
object Cost
-
approvedCommitmentsWorkspace1(optional):
object Cost
-
approvedCommitmentsWorkspace2(optional):
object Cost
-
approvedCommitmentsWorkspace3(optional):
object Cost
-
approvedContracts(optional):
object Cost
-
approvedContractsProject(optional):
object Cost
-
approvedContractsWorkspace1(optional):
object Cost
-
approvedContractsWorkspace2(optional):
object Cost
-
approvedContractsWorkspace3(optional):
object Cost
-
approvedManualBudget(optional):
object Cost
-
approvedManualBudgetChanges(optional):
object Cost
-
approvedManualBudgetChangesProject(optional):
object Cost
-
approvedManualBudgetChangesWorkspace1(optional):
object Cost
-
approvedManualBudgetChangesWorkspace2(optional):
object Cost
-
approvedManualBudgetChangesWorkspace3(optional):
object Cost
-
approvedManualBudgetProject(optional):
object Cost
-
approvedManualBudgetTransfers(optional):
object Cost
-
approvedManualBudgetTransfersProject(optional):
object Cost
-
approvedManualBudgetTransfersWorkspace1(optional):
object Cost
-
approvedManualBudgetTransfersWorkspace2(optional):
object Cost
-
approvedManualBudgetTransfersWorkspace3(optional):
object Cost
-
approvedManualBudgetWorkspace1(optional):
object Cost
-
approvedManualBudgetWorkspace2(optional):
object Cost
-
approvedManualBudgetWorkspace3(optional):
object Cost
-
approvedManualCurrentBudget(optional):
object Cost
-
approvedManualCurrentBudgetProject(optional):
object Cost
-
approvedManualCurrentBudgetWorkspace1(optional):
object Cost
-
approvedManualCurrentBudgetWorkspace2(optional):
object Cost
-
approvedManualCurrentBudgetWorkspace3(optional):
object Cost
-
approvedProjectActuals(optional):
object Cost
-
approvedProjectActualsProject(optional):
object Cost
-
approvedProjectActualsWorkspace1(optional):
object Cost
-
approvedProjectActualsWorkspace2(optional):
object Cost
-
approvedProjectActualsWorkspace3(optional):
object Cost
-
approvedRevenue(optional):
object Cost
-
approvedRevenueProject(optional):
object Cost
-
approvedRevenueWorkspace1(optional):
object Cost
-
approvedRevenueWorkspace2(optional):
object Cost
-
approvedRevenueWorkspace3(optional):
object Cost
-
approvedSpends(optional):
object Cost
-
approvedSpendsProject(optional):
object Cost
-
approvedSpendsWorkspace1(optional):
object Cost
-
approvedSpendsWorkspace2(optional):
object Cost
-
approvedSpendsWorkspace3(optional):
object Cost
-
atCompletionCost(optional):
object Cost
-
atCompletionCostProject(optional):
object Cost
-
bacCost(optional):
object Cost
-
bacCostProject(optional):
object Cost
-
baselineCost(optional):
object Cost
-
baselineCostProject(optional):
object Cost
-
closedPostExposure(optional):
object Cost
-
closedPostExposureProject(optional):
object Cost
-
closedPostExposureWorkspace1(optional):
object Cost
-
closedPostExposureWorkspace2(optional):
object Cost
-
closedPostExposureWorkspace3(optional):
object Cost
-
closedPreExposure(optional):
object Cost
-
closedPreExposureProject(optional):
object Cost
-
closedPreExposureWorkspace1(optional):
object Cost
-
closedPreExposureWorkspace2(optional):
object Cost
-
closedPreExposureWorkspace3(optional):
object Cost
-
costSheetItemId(optional):
integer(int64)
The unique identifier of a cost row item. This value should not be provided in create operation request data, however, it is required for update requests.
-
currentBudget(optional):
object Cost
-
currentBudgetProject(optional):
object Cost
-
currentBudgetWorkspace1(optional):
object Cost
-
currentBudgetWorkspace2(optional):
object Cost
-
currentBudgetWorkspace3(optional):
object Cost
-
currentCommitments(optional):
object Cost
-
currentCommitmentsProject(optional):
object Cost
-
currentCommitmentsWorkspace1(optional):
object Cost
-
currentCommitmentsWorkspace2(optional):
object Cost
-
currentCommitmentsWorkspace3(optional):
object Cost
-
currentContracts(optional):
object Cost
-
currentContractsProject(optional):
object Cost
-
currentContractsWorkspace1(optional):
object Cost
-
currentContractsWorkspace2(optional):
object Cost
-
currentContractsWorkspace3(optional):
object Cost
-
eacCost(optional):
object Cost
-
eacCostProject(optional):
object Cost
-
earnedCost(optional):
object Cost
-
earnedCostProject(optional):
object Cost
-
etcCost(optional):
object Cost
-
etcCostProject(optional):
object Cost
-
installedCost(optional):
object Cost
-
installedCostProject(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
openPostExposure(optional):
object Cost
-
openPostExposureProject(optional):
object Cost
-
openPostExposureWorkspace1(optional):
object Cost
-
openPostExposureWorkspace2(optional):
object Cost
-
openPostExposureWorkspace3(optional):
object Cost
-
openPreExposure(optional):
object Cost
-
openPreExposureProject(optional):
object Cost
-
openPreExposureWorkspace1(optional):
object Cost
-
openPreExposureWorkspace2(optional):
object Cost
-
openPreExposureWorkspace3(optional):
object Cost
-
pendingChangeCommitments(optional):
object Cost
-
pendingChangeCommitmentsProject(optional):
object Cost
-
pendingChangeCommitmentsWorkspace1(optional):
object Cost
-
pendingChangeCommitmentsWorkspace2(optional):
object Cost
-
pendingChangeCommitmentsWorkspace3(optional):
object Cost
-
pendingChangeContracts(optional):
object Cost
-
pendingChangeContractsProject(optional):
object Cost
-
pendingChangeContractsWorkspace1(optional):
object Cost
-
pendingChangeContractsWorkspace2(optional):
object Cost
-
pendingChangeContractsWorkspace3(optional):
object Cost
-
pendingChangedCost(optional):
object Cost
-
pendingChangedCostProject(optional):
object Cost
-
pendingCommitments(optional):
object Cost
-
pendingCommitmentsProject(optional):
object Cost
-
pendingCommitmentsWorkspace1(optional):
object Cost
-
pendingCommitmentsWorkspace2(optional):
object Cost
-
pendingCommitmentsWorkspace3(optional):
object Cost
-
pendingContracts(optional):
object Cost
-
pendingContractsProject(optional):
object Cost
-
pendingContractsWorkspace1(optional):
object Cost
-
pendingContractsWorkspace2(optional):
object Cost
-
pendingContractsWorkspace3(optional):
object Cost
-
pendingManualBudget(optional):
object Cost
-
pendingManualBudgetChanges(optional):
object Cost
-
pendingManualBudgetChangesProject(optional):
object Cost
-
pendingManualBudgetChangesWorkspace1(optional):
object Cost
-
pendingManualBudgetChangesWorkspace2(optional):
object Cost
-
pendingManualBudgetChangesWorkspace3(optional):
object Cost
-
pendingManualBudgetProject(optional):
object Cost
-
pendingManualBudgetTransfers(optional):
object Cost
-
pendingManualBudgetTransfersProject(optional):
object Cost
-
pendingManualBudgetTransfersWorkspace1(optional):
object Cost
-
pendingManualBudgetTransfersWorkspace2(optional):
object Cost
-
pendingManualBudgetTransfersWorkspace3(optional):
object Cost
-
pendingManualBudgetWorkspace1(optional):
object Cost
-
pendingManualBudgetWorkspace2(optional):
object Cost
-
pendingManualBudgetWorkspace3(optional):
object Cost
-
pendingProjectActuals(optional):
object Cost
-
pendingProjectActualsProject(optional):
object Cost
-
pendingProjectActualsWorkspace1(optional):
object Cost
-
pendingProjectActualsWorkspace2(optional):
object Cost
-
pendingProjectActualsWorkspace3(optional):
object Cost
-
pendingRevenue(optional):
object Cost
-
pendingRevenueProject(optional):
object Cost
-
pendingRevenueWorkspace1(optional):
object Cost
-
pendingRevenueWorkspace2(optional):
object Cost
-
pendingRevenueWorkspace3(optional):
object Cost
-
pendingSpends(optional):
object Cost
-
pendingSpendsProject(optional):
object Cost
-
pendingSpendsWorkspace1(optional):
object Cost
-
pendingSpendsWorkspace2(optional):
object Cost
-
pendingSpendsWorkspace3(optional):
object Cost
-
plannedCost(optional):
object Cost
-
plannedCostProject(optional):
object Cost
-
plannedRiskResponse(optional):
object Cost
-
plannedRiskResponseProject(optional):
object Cost
-
plannedRiskResponseWorkspace1(optional):
object Cost
-
plannedRiskResponseWorkspace2(optional):
object Cost
-
plannedRiskResponseWorkspace3(optional):
object Cost
-
projectActualCost(optional):
object Cost
-
projectActualCostProject(optional):
object Cost
-
projectCPI(optional):
number
The unique identifier of a cost row item.
-
projectCPIProject(optional):
number
The CPI cost of a project.
-
projectEarnedCost(optional):
object Cost
-
projectEarnedCostProject(optional):
object Cost
-
remainingCost(optional):
object Cost
-
remainingCostProject(optional):
object Cost
-
revisedCost(optional):
object Cost
-
revisedCostProject(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCBSSheetRowConfiguredFields
Type:
Show Source
object
-
cbsSheetRow(optional):
object ApiEntityCBSSheetRow
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
costItemId(optional):
integer(int64)
The unique identifier for the scope assignment for which the user defined field table is associated.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost and non-text fields in the form of key-value pairs.
-
primaryKey(optional):
integer(int64)
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
uniqueName(optional):
string
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
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 and 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 with no content.