Create a PCI Header

Updated on 01 Oct 2025
7 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Post

/cm-rest-api/rest/1/cmmast

Overview

This endpoint allows for the viewing and creation of Potential Change Items header information, such as Company, Project, Scope of Work, PCI dates and more.

Potential Change Items can be used to enter change requests for ongoing projects. PCIs are items that are expected to result in additional work or cost, beyond what was stated in the original submittal. These items can be made internally or externally and can be linked to requests for quotation (RFQ) and other related objects.

To create PCI details, please refer to “Create a PCI Detail” documentation.

Enterprise > Change Management > Change Orders > Enter PCI
CMiC Field > Budget & Cost Management > Potential Change Items

Reference Article

Commonly Used Body Parameters

CMiC UI Fieldname	Name	Description	Type	Data Length	Example	Required
Company Code	CmmCompCode	Company Code associated with the PCI’s project	string	8	“ZZ”	Yes
Job Code	CmmJobCode	Job Code associated with the PCI’s Project	string	10	“23-410”	Yes
PCI Type	CmmTypeCode	Enter/select the PCI’s type code. Must be a valid CmiC PCI type.	string	4	“EXT”	Yes
PCI Code	CmmCode	PCI number identifying PCI	string	11	“EXT-23005”	Yes
PCI Description	CmmName	PCI name or description	string	200	“Excavation Scope Change”	Yes
PCI Date	CmmRefDate	This date is used as the reference date for the PCI in other screens, such as the Post Change Orders screen.	datetime		“2016-05-03”	Yes
Pre-post Status Code	CmmPrepostStatCode	Status code before posting. Must be a valid PCI status code in CMiC.	string	10	“APPROVED”	Yes
Projected Amount Calc Method	CmmCalcProjAmtMethod	Flag to indicate the calculation method for projected amount when a change order is posted, and Update Projected Amount is checked. (A)dd Change Budget Amount or (R )ecalculate Projected Amount	string	1	“A”	Yes
VUuid	CmmVUuid	Unique Row ID. When creating a new change item, this field should be included in the body of the request but left empty. Including this parameter allows you to preview the posting after submission.	string	64	“C6007D3BB3742CACE0530100007F8D31”	No

Other (Optional) Body Parameters

CMiC UI Fieldname	Name	Description	Type	Data Length	Example
Action Code	CmmActionCode	This is the Action Code Created by the system. Action items are used to schedule and coordinate phone calls, delivery dates, meetings and other action types relevant to the Opportunity Management module. The Action Code is used to identify the action item type. Click here to learn more about Action Item Codes.	string	1
Allowance	CmmAllowance	Allowance Type (I)n Scope, (O)ut of Scope, (N)either. Default is N.	string	1	“T”
Approved Flag	CmmAprvFlag	Idicate weather this PCI is Approved or not. Related to PCI Status Code. Y or N	string	1	“Y” / “N”
Auto Calculate Markups	CmmAutoCalcMarkupFlag	Automatically generate markup lines once the PCI record has been saved. Y or N	string	1	“Y” / “N”
Batch Number	CmmBchNum	Batch number associated with PCI posting	integer	11	“755568”
Bid Item	CmmBiditemFlag	Flag to indicate that it is an automatic change order created by the bid item. (Y)es, (N)o, or null	string	1	“null” / “Y” / “N”
Bill Method Code	CmmBillMethCode	Valid values are (D)Details or (S)Summary. If left as null, it will default to D.	string	1	“D”
Change Issued Date	CmmChgSentToOwnerDate	Enter the dates the change order was issued.	datetime		“2019-02-28”
Change Signed Date	CmmChgSignedByOwnerDate	Enter the dates the change order was signed.	datetime		“2019-02-28”
PCI Class Code	CmmClassCode	PCI Class associated with the PCI type. (E )xternal, (I)nternal, (T)ransfer, (O)riginal Budget Change	string	1	“E”
Classifier 1	CmmClvValueCode1	Classifier Value 1	string	16
Classifier 2	CmmClvValueCode2	Classifier Value 2	string	16
Classifier 3	CmmClvValueCode3	Classifier Value 3	string	16
Classifier 4	CmmClvValueCode4	Classifier Value 4	string	16
Classifier 5	CmmClvValueCode5	Classifier Value 5	string	16
Classifier 6	CmmClvValueCode6	Classifier Value 6	string	16
Control Job Code	CmmCtrlJobCode	Controlling Job Code for PCIs linked to subjobs. If the Project is associated with a controlling Job, this field should be set as “ALL”	string	10	“ALL”
Cycle Number	CmmCycleNum	For reallocation PCIs only: Reallocation Cycle Number	integer	4	“1”
Due to owner Date	CmmDueToOwnerDate	For reference purposes only, to indicate when this change is due to the owner.	datetime		“2016-04-26”
End Date	CmmEffectiveEndDate	Change Order End Date	datetime		“2018-09-11”
Start Date	CmmEffectiveStartDate	Change Order Start Date	datetime		“2018-09-10”
Global Update Date	CmmGlobalUpdateDate	Timestamp of “global” PCI update, including e.g. PCI header/details, RFQ, Notes, Attachments.	datetime		“2024-05-29T06:15:09-04:00”
Impact Days	CmmImpactDays	Enter number of days of impacted by change. These will print on the Change Order and calculate new finish date.	integer	4	“10”
Create Date	CmmIuCreateDate	Date the record was created	datetime		“2018-09-10T13:44:36-04:00”
Update Date	CmmIuUpdateDate	Date the record was last updated	datetime		“2018-09-10T13:44:36-04:00”
Lump Sum Flag	CmmLumpsumFlag	Y = Lump Sum PCI, N= Regular PCI	string	1	“Y” / “N”
Original PCI Code	CmmOrigCmmCode	Reallocation PCI only: Original PCI code being adjusted (re-allocation)	string	11	“EXT-001”
Original Owner Allowance Amount	CmmOrigOwnerAllowanceAmt	Applicable only In Scope, Out of Scope Allowance Type PCI. Written only at posting time. For Out of Scope is normally 0	number	18	“0”
Owner Allowance Amount	CmmOwnerAllowanceAmt	Applicable only In Scope, Out of Scope Allowance Type PCI. For Out of Scope is normally 0	number	18	“100”
PCI Owner Change Order	CmmOwnerChgCode	Enter the Owner Change Order number associated with the Change Order. The Owner Change Order number is a reference field that will appear on Job Billing AIA style report.	string	20	“OCO-002”
Pending Flag	CmmPendFlag	Pending Type associated with the PCI status code. Available options are: (A)pproved, (C )ancelled, (N) Pre-Pending, (P)ending, (R )ejected. For more details on PCI Pending Types, please refence the following article: PCI Status Codes	string	1	“Y” / “N”
Post Vendor Contracts with PCI	CmmPostContrFlag	Insert (Y), if the Subcontract associated to this PCI should be posted at the same time as the PCI; otherwise, the related Subcontract is posted separately (N).	string	1	“Y” / “N”
Post Date	CmmPostDate	Date PCI was posted	datetime		“2016-02-02”
PCI Posted Status	CmmPostingFlag	System generated value to indicate the status of the PCI, if it its posted or unposted	string	12	“POSTED”
Proposal Issued	CmmPropIssuedToOwnerDate	Date when Proposal was issued to Owner	datetime		“2019-02-20
Proposal Signed	CmmPropSignedByOwnerDate	Date when the Proposal was signed by Owner	datetime		“2019-02-20”
Reason	CmmReasonText	Select Reason for PCI. Must be a valid reason in CMiC. For more details please see the following article: Maintain Reason LOV. This can be a required field based on Company Control settings.	string	200	“Reason A”
PCI Scope	CmmScopeDesc	Description of scope, in regard to the change.	string	4000	“Test”
Source Type	CmmSourceText	If the PCI was created from another object in CMiC Field, enter/select the type of the source. These codes can be created by checking the ‘Maintain Source Type LOV’ box in the Maintenance section of the Project Roles screen (standard Treeview path: CMiC Field > Security > Project Roles).	string	200	“Source1”
Source	CmmSrcId	This field displays the object from which the PCI is created, if crated from a PM object like RFIs for example. See more details on the following article: Linking/Creating a PCI to Objects	string	30	“DOCPKG-003”
System Status Code	CmmStatCode	determine the current status of the subcontract. (Pending, In-Progress etc.)	string	1	“Pending”
Status Code Last Update Date	CmmStatCodeUpdateDate	Date the PCI Status Code was last updated	datetime		“2016-07-08T09:50:06-04:00”
Update % Complete	CmmUpdPcComplFlag	Y/N. Defaults to Y if left null	string	1	“Y” / “N”
Update Projected Amount during Posting	CmmUpdProjAmtFlag	Select (Y) if the default for Change Orders is to update the job projected amount each time a Change Order is posted. If Change Orders are already included in the amounts for your projection forecasts, then this value should be (N).	string	1	“Y” / “N”
Entered By	CmmUser	Username that created the PCI record	string	30	“SMUSER6”
Workflow Status	CmmWorkflowStatus	A workflow status field is displayed on the Subcontract Screen. The possible values (set by workflow) are: Un-submitted, Pending, Rejected, Approved (Submitted) Note: If Workflow is being used for subcontracts and subcontract change orders, additional workflow columns are available to be used in the SC and SCCO logs but they must be incorporated during the workflow design process. If these columns have not been built into the workflow design, they will not be populated during workflow and can be removed from logs.			“Un-submitted” / “Pending” / “Approved” / “Rejected” / “null”

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceItem+json

Body parameters

object

Example{ "CmmCompCode": "001", "CmmJobCode": "14001", "CmmTypeCode": "EXT", "CmmCode": "EXT0123", "CmmName": "L's PCI", "CmmRefDate": "2023-11-11", "CmmPrepostStatCode": "PENDING", "CmmCalcProjAmtMethod": "A", "CmmVUuid": "E" }

Responses

201

Created

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceitem+json

{
  "CmmActionCode": null,
  "CmmAllowance": null,
  "CmmAprvFlag": null,
  "CmmAutoCalcMarkupFlag": null,
  "CmmBchNum": null,
  "CmmBiditemFlag": null,
  "CmmBillCatCode": null,
  "CmmBillCode": null,
  "CmmBillMethCode": null,
  "CmmBillName": null,
  "CmmBillPhsCode": null,
  "CmmBillRevisAmt": null,
  "CmmCalcProjAmtMethod": "A",
  "CmmChgSentToOwnerDate": null,
  "CmmChgSignedByOwnerDate": null,
  "CmmClassCode": null,
  "CmmClvValueCode1": null,
  "CmmClvValueCode2": null,
  "CmmClvValueCode3": null,
  "CmmClvValueCode4": null,
  "CmmClvValueCode5": null,
  "CmmClvValueCode6": null,
  "CmmCode": "EXT0123",
  "CmmCompCode": "001",
  "CmmCtrlJobCode": null,
  "CmmCycleNum": null,
  "CmmDueToOwnerDate": null,
  "CmmEffectiveEndDate": null,
  "CmmEffectiveStartDate": null,
  "CmmFundsourceCode": null,
  "CmmGlobalUpdateDate": null,
  "CmmImpactDays": null,
  "CmmInvCode": null,
  "CmmIuCreateDate": null,
  "CmmIuUpdateDate": null,
  "CmmJobCode": "14001",
  "CmmLumpsumFlag": null,
  "CmmName": "L's PCI",
  "CmmOrigCmmCode": null,
  "CmmOrigOwnerAllowanceAmt": null,
  "CmmOwnerAllowanceAmt": null,
  "CmmOwnerChgCode": null,
  "CmmPendFlag": null,
  "CmmPmFlag": null,
  "CmmPmObjectCode": null,
  "CmmPostContrFlag": null,
  "CmmPostDate": null,
  "CmmPostDateDummy": null,
  "CmmPostingFlag": null,
  "CmmPrepostStatCode": "PENDING",
  "CmmPropIssuedToOwnerDate": null,
  "CmmPropSignedByOwnerDate": null,
  "CmmReasonText": null,
  "CmmRefCmmCode": null,
  "CmmRefDate": "2023-11-11",
  "CmmRfqDueDate": null,
  "CmmRfqLimitAmt": null,
  "CmmRfqProceedFlag": null,
  "CmmScopeDesc": null,
  "CmmSourceText": null,
  "CmmSrcId": null,
  "CmmStatCode": null,
  "CmmStatCodeUpdateDate": null,
  "CmmTypeCode": "EXT",
  "CmmUpdPcComplFlag": null,
  "CmmUpdProjAmtFlag": null,
  "CmmUser": null,
  "CmmVUuid": "F396762021727DDEE05316821FACD0CF",
  "CmmWorkflowStatus": null,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/cm-rest-api/rest/1/cmmast/F396762021727DDEE05316821FACD0CF",
      "name": "cmmast",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/cm-rest-api/rest/1/cmmast/F396762021727DDEE05316821FACD0CF",
      "name": "cmmast",
      "kind": "item"
    }
  ]
}

object

What's Next

Retrieve PCI Masters By Code

Create a PCI Header

Overview

UI Navigation

Reference Article

Commonly Used Body Parameters

Other (Optional) Body Parameters

What's Next

Contact Us