Update a Workspace CBS Code
put
/primeapi/restapi/cbs/workspace
Send a request to this endpoint to update a workpsace CBS code. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Request
Supported Media Types
- application/json
UNDEFINED
Root Schema : ApiEntityCBSTemplateCode
Type:
Show Source
object
-
cbsCode:
string
Allowed Values:
[ "Length[1-60]" ]
The code value of the CBS code. The code may have one or more segments according the ot the segment definition. -
cbsItemId(optional):
integer(int64)
The unique identifier of the original CBS. This value should not be provided in create operation request data, however, it is required for update requests.
-
cbsTemplateId(optional):
integer(int64)
The unique identifier for the CBS template.
-
copiedFromItemId(optional):
integer(int64)
The unique identifier for the CBS template that the CBS was copied from.
-
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.
-
isCodeCopied(optional):
boolean
Indicates a CBS that is copied from a workspace or project.
-
isTotalRow(optional):
boolean
The total cost of the project.
-
link(optional):
string(url)
Read Only:
true
-
parent(optional):
integer(int64)
The unique identifier of the parent CBS.
-
pushDownStatus(optional):
boolean
The push down status of a cbs template code. May be manual or automatic.
-
sequenceNumber(optional):
integer(int64)
Used to display the CBS codes in the increasing order of sequence numbers.
-
templateRow(optional):
object ApiEntityCBSTemplateRow
-
templateRowCost(optional):
object ApiEntityCBSTemplateRowCost
-
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 : ApiEntityCBSTemplateRow
Type:
Show Source
object
-
actualHoursToDate(optional):
object Hour
-
approvedChangedHours(optional):
object Hour
-
atCompletionHours(optional):
object Hour
-
bacHours(optional):
object Hour
-
baselineHours(optional):
object Hour
-
cbsItemId(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.
-
cbstemplateRowConfiguredFields(optional):
object ApiEntityCBSTemplateRowConfiguredFields
-
eacHours(optional):
object Hour
-
earnedHours(optional):
object Hour
-
etcAdjustedHours(optional):
object Hour
-
etcHours(optional):
object Hour
-
installedHours(optional):
object Hour
-
isActualsAssigned(optional):
boolean
Indicates whether actuals are assigned.
-
isBudgetAssigned(optional):
boolean
Indicates whether a budget is assigned.
-
isScopeItemAssigned(optional):
boolean
Indicates whether a scope item is assigned.
-
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
-
templateItemId(optional):
integer(int64)
The CBS code assigned to the line item.
-
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 : ApiEntityCBSTemplateRowCost
Type:
Show Source
object
-
actualCostToDate(optional):
object Cost
-
adjustedCost(optional):
object Cost
-
approvedChangedCost(optional):
object Cost
-
atCompletionCost(optional):
object Cost
-
bacCost(optional):
object Cost
-
baselineCost(optional):
object Cost
-
currentBudget(optional):
object Cost
-
currentBudgetWorkspace1(optional):
object Cost
-
currentBudgetWorkspace2(optional):
object Cost
-
currentBudgetWorkspace3(optional):
object Cost
-
eacCost(optional):
object Cost
-
earnedCost(optional):
object Cost
-
etcCost(optional):
object Cost
-
installedCost(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
pendingChangedCost(optional):
object Cost
-
plannedCost(optional):
object Cost
-
projectActualCost(optional):
object Cost
-
projectCPI(optional):
number
The measure of a project's cost efficiency.
A value of less than 1 indicates the project is over budget, while a value greater than 1 indicates the project is under budget. -
projectEarnedCost(optional):
object Cost
-
remainingCost(optional):
object Cost
-
revisedCost(optional):
object Cost
-
templateItemId:
integer(int64)
Template item ID.
-
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 : ApiEntityCBSTemplateRowConfiguredFields
Type:
Show Source
object
-
cbsItemId(optional):
integer(int64)
The system-generated identifier of a CBS item.
-
cbsTemplateRow(optional):
object ApiEntityCBSTemplateRow
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
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
Response
Supported Media Types
- application/json
204 Response
Successful operation with no content.
400 Response
Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request.