Update a Change Event
put
/primeapi/restapi/changeEvent
Send a request to this endpoint to update a change event. 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
A change event object. The object must conform to the ApiEntityChangeEvent schema.
Root Schema : ApiEntityChangeEvent
Type:
Show Source
object
-
associatedContractCode(optional):
string
The user-specified identifier of a contract.
-
associatedContractId(optional):
integer(int64)
Associated Contract field.
-
changeEventConfiguredFields(optional):
object ApiEntityChangeEventConfiguredFields
-
changeEventCost(optional):
object ApiEntityChangeEventCost
-
changeEventId(optional):
integer(int64)
The system-generated identifier of a change event.
-
description(optional):
string
Description field.
-
estimatedScheduleImpact(optional):
integer(int32)
Estimated Schedule Impact field.
-
includesContractImpact(optional):
boolean
Includes Contract Impact field.
-
itemCode:
string
ID field.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
Name field.
-
projectCode(optional):
string
The user-specified identifier of a project.
-
projectId:
integer(int64)
The unique identifier for the project associated with the change.
-
reasons(optional):
array reasons
Unique Items Required:
true
Reasons associated with a change event. -
scope(optional):
string
Allowed Values:
[ "IN_SCOPE", "OUT_OF_SCOPE" ]
Scope field. -
status(optional):
string
Allowed Values:
[ "DRAFT", "IN_PROGRESS", "CLOSED", "VOID" ]
Status field. -
statusTransitionData(optional):
object ApiEntityCmStatusTransitionData
-
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 : ApiEntityChangeEventConfiguredFields
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 : ApiEntityChangeEventCost
Type:
Show Source
object
-
changeEventId(optional):
integer(int64)
The system-generated identifier of a change event.
-
commitmentEstimatedCost(optional):
object Cost
-
commitmentEstimatedCostProject(optional):
object Cost
-
commitmentEstimatedCostWorkspace1(optional):
object Cost
-
commitmentEstimatedCostWorkspace2(optional):
object Cost
-
commitmentEstimatedCostWorkspace3(optional):
object Cost
-
commitmentFinalCost(optional):
object Cost
-
commitmentFinalCostProject(optional):
object Cost
-
commitmentFinalCostWorkspace1(optional):
object Cost
-
commitmentFinalCostWorkspace2(optional):
object Cost
-
commitmentFinalCostWorkspace3(optional):
object Cost
-
commitmentNegotiatedCost(optional):
object Cost
-
commitmentNegotiatedCostProject(optional):
object Cost
-
commitmentNegotiatedCostWorkspace1(optional):
object Cost
-
commitmentNegotiatedCostWorkspace2(optional):
object Cost
-
commitmentNegotiatedCostWorkspace3(optional):
object Cost
-
commitmentProposedCost(optional):
object Cost
-
commitmentProposedCostProject(optional):
object Cost
-
commitmentProposedCostWorkspace1(optional):
object Cost
-
commitmentProposedCostWorkspace2(optional):
object Cost
-
commitmentProposedCostWorkspace3(optional):
object Cost
-
contractEstimatedCost(optional):
object Cost
-
contractEstimatedCostProject(optional):
object Cost
-
contractEstimatedCostWorkspace1(optional):
object Cost
-
contractEstimatedCostWorkspace2(optional):
object Cost
-
contractEstimatedCostWorkspace3(optional):
object Cost
-
contractFinalCost(optional):
object Cost
-
contractFinalCostProject(optional):
object Cost
-
contractFinalCostWorkspace1(optional):
object Cost
-
contractFinalCostWorkspace2(optional):
object Cost
-
contractFinalCostWorkspace3(optional):
object Cost
-
contractNegotiatedCost(optional):
object Cost
-
contractNegotiatedCostProject(optional):
object Cost
-
contractNegotiatedCostWorkspace1(optional):
object Cost
-
contractNegotiatedCostWorkspace2(optional):
object Cost
-
contractNegotiatedCostWorkspace3(optional):
object Cost
-
contractProposedCost(optional):
object Cost
-
contractProposedCostProject(optional):
object Cost
-
contractProposedCostWorkspace1(optional):
object Cost
-
contractProposedCostWorkspace2(optional):
object Cost
-
contractProposedCostWorkspace3(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 : reasons
Type:
array
Unique Items Required:
true
Reasons associated with a change event.
Show Source
Nested Schema : ApiEntityCmStatusTransitionData
Type:
Show Source
object
-
approveByUserId(optional):
integer(int64)
The user who approved the agreement, change, or payment application.
-
approveDate(optional):
string(date-time)
The date the agreement, change, or payment application was approved.
-
cancelByUserId(optional):
integer(int64)
The user who cancelled the agreement, change, or payment application.
-
cancelDate(optional):
string(date-time)
The date the agreement, change, or payment application was cancelled.
-
closeByUserId(optional):
integer(int64)
The user who closed the agreement, change order, or payment application.
-
closeDate(optional):
string(date-time)
The date the agreement, change, or payment application was closed.
-
lastStatusTransitionType(optional):
string
Allowed Values:
[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "CLOSE", "REOPEN", "REJECT", "VOID", "WITHDRAW", "ANSWERED", "NONE" ]
The last status of the agreement, change, or payment application. -
link(optional):
string(url)
Read Only:
true
-
rejectByUserId(optional):
integer(int64)
The user who rejected the agreement, change, or payment application.
-
rejectDate(optional):
string(date-time)
The date when the agreement, change, or payment application was rejected.
-
reopenDate(optional):
string(date-time)
The date when the agreement, change, or payment application was reopened.
-
rreopenByUserId(optional):
integer(int64)
The user who reopened the agreement.
-
statusTransitionId(optional):
integer(int64)
The system-generated identifier of a status transition. This value should not be provided in create operation request data, however, it is required for update requests.
-
submitByUserId(optional):
integer(int64)
The user who submitted the agreement, change, or payment application for approval.
-
submitDate(optional):
string(date-time)
The date the agreement, change, or payment application was submitted for approval.
-
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. -
voidByUserId(optional):
integer(int64)
The user who voided the agreement, change, or payment application.
-
voidDate(optional):
string(date-time)
The date the agreement, change, or payment application was voided.
-
withdrawApprovalByUserId(optional):
integer(int64)
The user who withdrew approval of the agreement, change, or payment application.
-
withdrawApprovalDate(optional):
string(date-time)
The date when approval for the agreement, change, or payment application was withdrawn.
-
withdrawByUserId(optional):
integer(int64)
The user who withdrew the agreement, change, or payment application.
-
withdrawDate(optional):
string(date-time)
The date the agreement, change, or payment application was withdrawn.
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
Nested Schema : ApiEntityChangeEventReasons
Type:
Show Source
object
-
changeEventId(optional):
integer(int64)
The system-generated identifier of a change event.
-
changeEventReasonId(optional):
integer(int64)
The system-generated identifier of a reason.
-
link(optional):
string(url)
Read Only:
true
-
reasonId(optional):
integer(int64)
The system-generated identifier of a reason.
-
reasonName(optional):
string
The name of a reason.
-
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.
Response
Supported Media Types
- application/json
204 Response
Successful operation with no content.
400 Response
Invalid Input.