View a Change Estimate by Parent and Code
get
/primeapi/restapi/changeEstimate/byItemCode?worksaceCode={worksaceCode}&projectCode={projectCode}&changeEventCode={changeEventCode}&changeEstimateCode={changeEstimateCode}
This endpoint returns change estimates that meet the following requirements:
- The object has a code that matches the value of the {code} path parameter.
Request
Query Parameters
-
changeEstimateCode: string
The user-specified identifier of a change estimate.
-
changeEventCode: string
The user-specified identifier of a change event.
-
projectCode: string
The user-specified identifier of a project.
-
worksaceCode: string
The user-specified identifier of a workspace.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityChangeEstimate
Type:
Show Source
object
-
abbreviation(optional):
string
A cost category abbreviation.
-
associatedCommitmentCode(optional):
string
The user-specified identifier of a commitment.
-
associatedCommitmentId:
integer(int64)
Associated Commitment field.
-
cbsCode(optional):
string
The user-specified identifier of a CBS.
-
cbssheetCodeId(optional):
integer(int64)
CBS Code field.
-
changeEstimateConfiguredFields(optional):
object ApiEntityChangeEstimateConfiguredFields
-
changeEstimateCost(optional):
object ApiEntityChangeEstimateCost
-
changeEstimateId(optional):
integer(int64)
The system-generated identifier of a change estimate.
-
changeEventCode(optional):
string
The user-specified identifier of a change event.
-
changeEventId:
integer(int64)
The system-generated identifier of a change event.
-
costCategoryId(optional):
integer(int64)
Cost Category field.
-
costCategoryName(optional):
string
The name of a cost category.
-
itemCode(optional):
string
ID field.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
Name field.
-
projectCode(optional):
string
The user-specified identifier of a project.
-
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.
Nested Schema : ApiEntityChangeEstimateConfiguredFields
Type:
Show Source
object
-
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.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
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 : ApiEntityChangeEstimateCost
Type:
Show Source
object
-
changeEstimateId(optional):
integer(int64)
The system-generated identifier of a change estimate.
-
commitmentEstimatedCost(optional):
object Cost
-
commitmentEstimatedCostProject(optional):
object Cost
-
commitmentEstimatedCostWorkspace1(optional):
object Cost
-
commitmentEstimatedCostWorkspace2(optional):
object Cost
-
commitmentEstimatedCostWorkspace3(optional):
object Cost
-
contractEstimatedCost(optional):
object Cost
-
contractEstimatedCostProject(optional):
object Cost
-
contractEstimatedCostWorkspace1(optional):
object Cost
-
contractEstimatedCostWorkspace2(optional):
object Cost
-
contractEstimatedCostWorkspace3(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
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
404 Response
The requested change estimate does not exist, or you do not have access to it.