• [0]: object ApiEntityChangeEvent

{
    "title":"List<ApiEntityChangeEvent>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityChangeEvent"
    }
}

• 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.

{
    "type":"object",
    "required":[
        "itemCode",
        "name",
        "projectId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace."
        },
        "projectCode":{
            "type":"string",
            "description":"The user-specified identifier of a project."
        },
        "associatedContractCode":{
            "type":"string",
            "description":"The user-specified identifier of a contract."
        },
        "name":{
            "type":"string",
            "description":"Name field."
        },
        "description":{
            "type":"string",
            "description":"Description field."
        },
        "status":{
            "type":"string",
            "description":"Status field.",
            "enum":[
                "DRAFT",
                "IN_PROGRESS",
                "CLOSED",
                "VOID"
            ]
        },
        "itemCode":{
            "type":"string",
            "description":"ID field."
        },
        "changeEventId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change event."
        },
        "reasons":{
            "type":"array",
            "description":"Reasons associated with a change event.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityChangeEventReasons"
            }
        },
        "scope":{
            "type":"string",
            "description":"Scope field.",
            "enum":[
                "IN_SCOPE",
                "OUT_OF_SCOPE"
            ]
        },
        "changeEventConfiguredFields":{
            "description":"The configured fields of a change event.",
            "$ref":"#/definitions/ApiEntityChangeEventConfiguredFields"
        },
        "associatedContractId":{
            "type":"integer",
            "format":"int64",
            "description":"Associated Contract field."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the project associated with the change."
        },
        "statusTransitionData":{
            "description":"The system-generated identifier of a status transition.",
            "$ref":"#/definitions/ApiEntityCmStatusTransitionData"
        },
        "includesContractImpact":{
            "type":"boolean",
            "description":"Includes Contract Impact field."
        },
        "estimatedScheduleImpact":{
            "type":"integer",
            "format":"int32",
            "description":"Estimated Schedule Impact field."
        },
        "changeEventCost":{
            "description":"The cost of a change event.",
            "$ref":"#/definitions/ApiEntityChangeEventCost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• costFlexMap(optional): object costFlexMap
  Additional Properties Allowed: additionalProperties

  An 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: additionalProperties

  An object containing non-cost and non-text fields in the form of key-value pairs.
• textFlexMap(optional): object textFlexMap
  Additional Properties Allowed: additionalProperties

  An 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "costFlexMap":{
            "type":"object",
            "description":"An object containing cost fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"An object containing non-cost and non-text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"An object containing text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "changeEventId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change event."
        },
        "contractProposedCostProject":{
            "description":"The proposed cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractProposedCost":{
            "description":"Contract Proposed field.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentFinalCost":{
            "description":"Commitment Final field.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentProposedCostProject":{
            "description":"The proposed cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentNegotiatedCost":{
            "description":"Commitment Negotiated field.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractFinalCostProject":{
            "description":"The final cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentFinalCostWorkspace3":{
            "description":"The final cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractNegotiatedCost":{
            "description":"Contract Negotiated field.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentFinalCostWorkspace2":{
            "description":"The final cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractFinalCostWorkspace1":{
            "description":"The final cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractFinalCostWorkspace3":{
            "description":"The final cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractNegotiatedCostProject":{
            "description":"The negotiated cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractFinalCostWorkspace2":{
            "description":"The final cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentFinalCostWorkspace1":{
            "description":"The final cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractFinalCost":{
            "description":"Contract Final field.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentFinalCostProject":{
            "description":"The final cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentProposedCost":{
            "description":"Commitment Proposed field.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractEstimatedCostWorkspace2":{
            "description":"The estimated cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractEstimatedCostWorkspace1":{
            "description":"The estimated cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentEstimatedCostWorkspace2":{
            "description":"The estimated cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentEstimatedCostWorkspace3":{
            "description":"The estimated cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentEstimatedCostWorkspace1":{
            "description":"The estimated cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentEstimatedCostProject":{
            "description":"The estimated cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractEstimatedCostWorkspace3":{
            "description":"The estimated cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractEstimatedCostProject":{
            "description":"The estimated cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentEstimatedCost":{
            "description":"Commitment Estimated field.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractEstimatedCost":{
            "description":"Contract Estimated field.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentProposedCostWorkspace1":{
            "description":"The proposed cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractProposedCostWorkspace2":{
            "description":"The proposed cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractNegotiatedCostWorkspace2":{
            "description":"The negotiated cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentNegotiatedCostWorkspace1":{
            "description":"The negotiated cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractProposedCostWorkspace1":{
            "description":"The proposed cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractProposedCostWorkspace3":{
            "description":"The proposed cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentProposedCostWorkspace2":{
            "description":"The proposed cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractNegotiatedCostWorkspace1":{
            "description":"The negotiated cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentNegotiatedCostProject":{
            "description":"The negotiated cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentNegotiatedCostWorkspace2":{
            "description":"The negotiated cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentNegotiatedCostWorkspace3":{
            "description":"The negotiated cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "contractNegotiatedCostWorkspace3":{
            "description":"The negotiated cost of a contract.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "commitmentProposedCostWorkspace3":{
            "description":"The proposed cost of a commitment.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• [0]: object ApiEntityChangeEventReasons

{
    "type":"array",
    "description":"Reasons associated with a change event.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityChangeEventReasons"
    }
}

• 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "rejectDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the agreement, change, or payment application was rejected."
        },
        "approveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was approved."
        },
        "submitDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was submitted for approval."
        },
        "withdrawDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was withdrawn."
        },
        "rreopenByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who reopened the agreement."
        },
        "withdrawByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who withdrew the agreement, change, or payment application."
        },
        "cancelByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who cancelled the agreement, change, or payment application."
        },
        "lastStatusTransitionType":{
            "type":"string",
            "description":"The last status of the agreement, change, or payment application.",
            "enum":[
                "SUBMIT",
                "APPROVE",
                "WITHDRAW_APPROVAL",
                "CLOSE",
                "REOPEN",
                "REJECT",
                "VOID",
                "WITHDRAW",
                "ANSWERED",
                "NONE"
            ]
        },
        "statusTransitionId":{
            "type":"integer",
            "format":"int64",
            "description":"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."
        },
        "withdrawApprovalDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when approval for the agreement, change, or payment application was withdrawn."
        },
        "submitByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who submitted the agreement, change, or payment application for approval."
        },
        "withdrawApprovalByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who withdrew approval of the agreement, change, or payment application."
        },
        "approveByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who approved the agreement, change, or payment application."
        },
        "rejectByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who rejected the agreement, change, or payment application."
        },
        "voidByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who voided the agreement, change, or payment application."
        },
        "reopenDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the agreement, change, or payment application was reopened."
        },
        "closeDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was closed."
        },
        "voidDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was voided."
        },
        "cancelDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was cancelled."
        },
        "closeByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who closed the agreement, change order, or payment application."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing cost fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing non-cost and non-text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "changeEventId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a change event."
        },
        "changeEventReasonId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a reason."
        },
        "reasonName":{
            "type":"string",
            "description":"The name of a reason."
        },
        "reasonId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a reason."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}