Run PM Owner JS Query with Code

Prev Next
Get
/pm-rest-api/rest/1/pmownerjsquery

Overview

The Owner Job Status Query endpoint is a query-only API endpoint that retrieves expected revenue values derived from the Job Cost Budget-revenue values. This endpoint also includes PCI (Potential Change Item), but it only reflects billed amounts rather than budgeted amounts.

UI Navigation

CMiC Field > Budget & Cost Management > Budget Status Query

Reference Article

https://docs.cmicglobal.com/portal/Content/E_Reference_Material/CMiC_Field/Reference/Budget___Cost_Management/Budget_Status_Query_Revenue.htm?Highlight=%20Budget%20Status%20Query

Query Standards

Key Recommended Description
finder Yes Filters data based on attributes. See finder details below. Finders can be combined using a comma delimiter between parameters that implies an "and" statement. For more information on using the finder functionality please see Best Practice | Data Filtering requirements
limit Yes A limit restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count, then the framework will return all available resources. For additional information on using the limit functionality please visit Best Practice | Data Filtering requirements
offset Yes The offset skips a specified number of items in a data list before it starts showing results. For example, if you set an offset of 10, it skips the first 10 items and begins showing from the 11th item. For additional information on using Offset functionality please visit Best Practice | Data Filtering requirements
orderBy Yes The orderBy attribute retrieves rows using an order ensuring the response payload displays data in the order supplied in the URL parameter using the GET method. For more information on using orderBy functionality please visit Best Practice | Data Filtering requirements

pmownerjsquery Finders

Finder Parameter Data Type Description Example
prepareQuery CompCode string Filters records by Company Code pm-rest-api/rest/1/pmownerjsquery?finder=prepareQuery;CompCode=ZZ,JobCode=ROVER12C
prepareQuery JobCode string Filters records by Job Code pm-rest-api/rest/1/pmownerjsquery?finder=prepareQuery;CompCode=ZZ,JobCode=ROVER12C

pmownerjsquery Attributes

CMiC UI Fieldname Object Name Description Type Data Length Example
Company pmownerjsquery PmojsqCompCode Company Code string 8 COMP12
Job Code pmownerjsquery PmojsqJobCode Job Code string 10 JOB34
Phase pmownerjsquery PmojsqPhsCode Phase Code string 16 1000
Phase Name pmownerjsquery PmojsqPhsName Phase Name string 50 Test Phs
Category pmownerjsquery PmojsqCatCode Category Code string 16 00
Original Budget pmownerjsquery PmojsqOrigBudgAmt Original Budget Amount number 18 50000
Original Revenue Budget pmownerjsquery PmojsqOrigBudgRevAmt Original Budget Revenue Amount number 18 1000
Internal and Transfer CO pmownerjsquery PmojsqIntAndTrnCoAmt Internal Change Orders and Transfers number 18 1000
Internal and Transfer CO Revenue pmownerjsquery PmojsqIntAndTrnCoRevAmt Internal Change Orders and Transfers Revenue Amount number 18 1000
External Change Order Amount pmownerjsquery PmojsqExtCoAmt External Change Order Amount number 18 200
External CO pmownerjsquery PmojsqExtCoRevAmt External Change Order Revenue Amount number 18 100
Current Budget pmownerjsquery PmojsqCurrBudgAmt Current Budget Amount number 18 500
Current Revenue Budget pmownerjsquery PmojsqCurrBudgRevAmt Current Budget Revenue Amount number 18 200
Pending Change Order Amount pmownerjsquery PmojsqPendingCoAmt Pending Change Order Amount number 18 200
Pending CO pmownerjsquery PmojsqPendingCoRevAmt Pending Change Order Revenue Amount number 18 200
Pre-Pending Change Order Amount pmownerjsquery PmojsqPrependingCoAmt Pre-Pending Change Order Amount number 18 500
PrePending CO pmownerjsquery PmojsqPrependingCoRevAmt Pre-Pending Change Order Revenue Amount number 18 500
Projected Budget pmownerjsquery PmojsqProjAmt Projected Budget number 18 1000
Projected Revenue Budget pmownerjsquery PmojsqProjRevAmt Projected Revenue Amount number 18 500
Spent to Date pmownerjsquery PmojsqSpentAmt Spent to Date number 18 200
Committed to Date pmownerjsquery PmojsqCommittedAmt Committed to Date number 18 300
Committed Remaining Amount pmownerjsquery PmojsqCommittedRemainAmt Committed Remaining Amount number 18 500
Spent/Committed Amount pmownerjsquery PmojsqSpentCommittedAmt Spent/Committed Amount number 18 500
Amount to Complete pmownerjsquery PmojsqToCompleteAmt Amount to Complete number 18 500
Calculated Projection pmownerjsquery PmojsqCalcProjAmt Calculated Projection Amount number 18 300
Proceeding Projected pmownerjsquery PmojsqProceedCoAmt Proceeding Projected Amount number 18 500
Proceeding Projected Revenue pmownerjsquery PmojsqProceedCoRevAmt Proceeding Projected Revenue Amount number 18 1000
Non-Proceeding Change Order pmownerjsquery PmojsqNonProceedCoAmt Non-Proceeding Change Order Amount number 18 10000
Non-Proceeding Change Order Revenue pmownerjsquery PmojsqNonProceedCoRevAmt Non-Proceeding Change Order Revenue Amount number 18 500
Pending Projection pmownerjsquery PmojsqPendingProjAmt Pending Projection Amount number 18 700
Forecast pmownerjsquery PmojsqForecastAmt Forecast Amount number 18 1000
Project Over/Under Amount pmownerjsquery PmojsqProjVarianceAmt Project Over/Under Amount number 18 500
Create Date pmownerjsquery PmojsqIuCreateDate System-generated timestamp when the record was created datetime 2023-10-19T13:20:58-04:00
Update Date pmownerjsquery PmojsqIuUpdateDate System-generated timestamp when the record was updated datetime 2023-10-19T13:20:58-04:00
Original budget change order cost amount pmownerjsquery PmojsqOrigbCoAmt Original budget change order cost amount number 18 1000
Original budget change order revenue amount pmownerjsquery PmojsqOrigbCoRevAmt Original budget change order revenue amount number 18 500
Cat Budget Flag pmownerjsquery PmojsqCatBudgetFlag Cat Budget Flag string 1 Y/ N
Cost Flag pmownerjsquery PmojsqCatCostFlag Cost Flag string 1 Y/ N
Cat Billing Flag pmownerjsquery PmojsqCatBillingFlag Cat Billing Flag string 1 Y/ N
Actual cost for the current period pmownerjsquery PmojsqCurrPerCostAmt Actual cost for the current period number 18 500
Actual cost for the previous period pmownerjsquery PmojsqPrevPerCostAmt Actual cost for the previous period number 18 600
Work Days pmownerjsquery PmojsqWorkDays This goes along with comments: how many days the estimators think the task will take. number 6 5
Comments pmownerjsquery PmojsqComments Comments on Phase/Category to explain what was behind there rational on how the estimators got to the budget number. string 4000 Test Comment
Calculated Revenue Amount pmownerjsquery PmojsqCalculatedRevAmt Calculated Revenue Amount number 18 5000
Billed / Committed Amount pmownerjsquery PmojsqBilledCommittedAmt Billed / Committed Amount number 18 300
Internal Change Order Amount pmownerjsquery PmojsqIntCoAmt Internal Change Order Amount number 38 600
Transferred Change Order Amount pmownerjsquery PmojsqTrnCoAmt Transferred Change Order Amount number 38 300
Posted Billed to Date pmownerjsquery PmojsqBillAmt Bill Amount number 18 5000
Job to Date pmownerjsquery PmojsqIdealRevAmt Ideal Revenue Amount. Job to Date number 38 1000
Etc Projected Revenue Amount pmownerjsquery PmojsqEtcProjRevAmt Etc Projected Revenue Amount number 18 500
Unbilled Work pmownerjsquery PmojsqUnbilledJobAmt Unbilled Job Amount number 18 500
Projected Total Cost pmownerjsquery PmojsqProjectedTotCostsAmt Projected Total Costs Amount number 18 1000
Variance pmownerjsquery PmojsqVarianceAmt Variance Amount number 18 100
Security
HTTP
Type basic

Basic authentication

Query parameters
finder
string
ExampleprepareQuery;CompCode=001, JobCode=14002
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExamplePmojsqJobCode:desc
Responses
200

Successful response

Copyright © 2024 CMiC All Rights Reserved