Batch Update Change Estimates
put
/primeapi/restapi/changeEstimate/batch
Send a request to this endpoint to update one or more change estimates. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.
Request
Supported Media Types
- application/json
One or more change estimate objects. Each object must conform to the ApiChangeEstimate schema.
Root Schema : List<ApiEntityChangeEstimate>
Type:
array
Title:
Show Source
List<ApiEntityChangeEstimate>
Nested 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
Response
Supported Media Types
- application/json
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://:/primeapi/restapi/
400 Response
Invalid Input.