.png){kind=logo}
Create a JC Job
- 22 Oct 2025
- 8 Minutes to read
- Print
- DarkLight
Create a JC Job
- Updated on 22 Oct 2025
- 8 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Post
/jc-rest-api/rest/1/jcjob
Overview
Jobs are used to manage cost and revenue budgets, billing contracts and forecasts in CMiC. The JC Job endpoint is used to create, update and query jobs in CMiC.
Notes
UI Navigation
Project Controls > Job > Enter Job
Reference Article
Path Parameters
| Parameter | Description | Example |
|---|---|---|
| /VUUID | The VUuid attribute is the Unique row ID | 3F2F3ADAAE383085E06327261DAC5E5B |
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 |
jcjob Finders
| Finder | Parameter | Data Type | Data Length | Description | Example |
|---|---|---|---|---|---|
| PrimaryKey | JobVUuid | string | 64 | ||
| findByKeys | compCode | string | 10 | ||
| findByKeys | ctrlJobCode | string | 8 | ||
| findByKeys | jobCodeVar | string | 8 | ||
| selectByJob | compCode | string | 10 | ||
| selectByJob | costFlag | string | 2 | ||
| selectByJob | jobCodeVar | string | |||
| selectByJob | jobDate | datetime | |||
| selectByjobDate | jobDate | datetime | |||
| selectJob | compCode | string | |||
| selectJob | costFlag | string | |||
| selectJob | jobCodeVar | string | |||
| selectJob | jobDate | datetime |
jcjob Attributes (Required)
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example |
|---|---|---|---|---|---|---|
| Job Billing Department Code | jcjob | JobBillDeptCode | Department code for accumulated billings on this job. | string | 6 | 00 |
| Job Code | jcjob | JobCode | Job Code. Must be a unique code per job created. | string | 10 | 000003 |
| Job Company Code | jcjob | JobCompCode | The CMiC company the Job belongs to. Must be pre-existing company code in CMiC. | string | 8 | 111 |
| Job Contract Code | jcjob | JobContractCode | This is the contract code created in Job Billing based on the job code. Unless there is a unique billing contract code this field should be set to the same as the JobCode. | string | 10 | 000003 |
| Job Control Code | jcjob | JobCtrlCode | Defaulted to ‘All’ if the JobCode is the highest job in the hierarchy. If the JobCode is a subjob, then this code would be set to the JobCode the subjob rolls up into. | string | 10 | ALL |
| Job Customer Code | jcjob | JobCustCode | The customer for this job. If a value is entered, it must be a valid record from BPCustomers table for the company assigned to this job. If the job is used for Job Billing Contracts, this is a mandatory field. | string | 8 | ICON |
| Job Default Department Code | jcjob | JobDefaultDeptCode | string | 6 | 00 | |
| Job Estimate Start Date | jcjob | JobEstStartDate | Estimated Start Date for this job. | datetime | YYYY-MM-DD | 2025-01-01 |
| Job Long Term Contract Account Code | jcjob | JobLtcAccCode | GL Account code for credit adjustments on this job. | string | 16 | 4000.500 |
| Job Long Term Contract Department Code | jcjob | JobLtcDeptCode | Department code for credit adjustments on this job. | string | 6 | 00 |
| Job Name | jcjob | JobName | Job Name. It is not a unique ID. | string | 60 | York Region Subway Extension |
| Job Security Group | jcjob | JobSecGroup | Job/project security groups are used to grant users access to jobs and projects. Once a job/project security group is created, it is assigned the users that are to have access to the group’s associated jobs and projects. The API Service Account must have security to Jobs in order to create, query and update Jobs. | string | 500 | MASTER |
| Job WIP (Work in Progress) Department Code | jcjob | JobWipDeptCode | Department code used for WIP) Work in Progress) on this job. | string | 6 | 00 |
| Job VUuid | jcjob | JobVUuid | string | 64 | 3F2F3ADAAE383085E06327261DAC5E5B |
Security
HTTP
Type basic
Basic authentication
Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
Body parameters
object
Example{ "JobCompCode": "001", "JobCode": "0568", "JobName": "New York General Hospital", "JobCtrlCode": "ALL", "JobSecGroup": "00", "JobContractCode": "0568", "JobCustCode": "IRV", "JobDefaultDeptCode": "00", "JobWipDeptCode": "00", "JobCcDeptCode": "00", "JobBillDeptCode": "00", "JobLtcDeptCode": "00", "JobVUuid": "" }
Responses
201
Created
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
example-0
Successful Response
{
"JobAccmethCode": null,
"JobAcctContactCode": null,
"JobAcctPartnCode": null,
"JobAcctPartnTypeCode": null,
"JobActComplDate": null,
"JobActStartDate": null,
"JobActionCode": null,
"JobAddTypeCode": null,
"JobAdjBudgEqualsRevFlg": null,
"JobAllocApdiscJobFlag": null,
"JobAllowEtmshtEntriesFlag": null,
"JobAllowOverheadFlag": null,
"JobApTax1Code": null,
"JobApTax2Code": null,
"JobApTax3Code": null,
"JobApplyDbRules": null,
"JobArTax1Code": null,
"JobArTax2Code": null,
"JobArTax3Code": null,
"JobArchiveFlag": null,
"JobAreaDistrict": null,
"JobAsstContactCode": null,
"JobAsstPartnCode": null,
"JobAsstPartnTypeCode": null,
"JobAttachOraseq": null,
"JobAuthRqSeqNum": null,
"JobBidCode": null,
"JobBidFlag": null,
"JobBidStatusCode": null,
"JobBidSubmitDate": null,
"JobBillAccCode": null,
"JobBillAmt": null,
"JobBillDeptCode": "00",
"JobBillFlag": null,
"JobBillMethCode": null,
"JobBillTblRevFcastFlg": null,
"JobBillingRateTableCode": null,
"JobBillingTypeCode": null,
"JobBudgOvrdProjFlag": null,
"JobBudgUnit": null,
"JobBudgcstSameLevelFlag": null,
"JobBudgrSeqNum": null,
"JobCalSalChargeRate": null,
"JobCcAccCode": null,
"JobCcDeptCode": "00",
"JobCertifyCode": null,
"JobCertrepContractNumber": null,
"JobCertrepEndDate": null,
"JobCertrepFringeBenPaid": null,
"JobCertrepSignatoryName": null,
"JobCertrepSignatoryTitle": null,
"JobCertrepStartDate": null,
"JobChgSeqNum": null,
"JobCilocCode": null,
"JobCode": "0568",
"JobCompCode": "001",
"JobComplUnit": null,
"JobCompletedForWipFlag": null,
"JobConstructionValue": null,
"JobConstructionValuePct": null,
"JobContTypeCode": null,
"JobContactCode": null,
"JobContractAmt": null,
"JobContractCode": "0568",
"JobCostFlag": null,
"JobCostMethCode": null,
"JobCostToComplOvrdFlg": null,
"JobCreateDate": null,
"JobCtrlCode": "ALL",
"JobCustCode": "IRV",
"JobCustContactName": null,
"JobDaysOutstInvPaidTtl": null,
"JobDefaultDeptCode": "00",
"JobDefaultPyovhdGrp": null,
"JobDisbAmt": null,
"JobEqpChgNoRestartFlag": null,
"JobEstComplDate": null,
"JobEstStartDate": null,
"JobExclBillingWip": null,
"JobExclContAmtWipFlag": null,
"JobExclRevBudgWip": null,
"JobExcludeFromWipFlag": null,
"JobFcastInclSubjobsFlg": null,
"JobFinalizeProjectionsFlag": null,
"JobFullyPaidInvs": null,
"JobHbAmt": null,
"JobHbRecAmt": null,
"JobHier": null,
"JobIbAllowFlag": null,
"JobIbExpenseCatCode": null,
"JobIbFullTariffFlag": null,
"JobIgnoreCostsPriorToDate": null,
"JobInvFormatCode": null,
"JobInvoiceFormatCode": null,
"JobInvoiceGroupCode": null,
"JobIuCreateDate": null,
"JobIuUpdateDate": null,
"JobJbMapCode": null,
"JobJbRetainageCode": null,
"JobJtrExpFlag": null,
"JobLbcAccCode": null,
"JobLbcDeptCode": null,
"JobLocCode": null,
"JobLongCode": null,
"JobLstAddonDate": null,
"JobLstRecDate": null,
"JobLstRecPc": null,
"JobLtcAccCode": null,
"JobLtcDeptCode": "00",
"JobMakeupFlag": null,
"JobMaxBillingAmt": null,
"JobMaxBillingBudgetAmt": null,
"JobMaxChargePc": null,
"JobMaxHourlyRate": null,
"JobMaxHours": null,
"JobMsCode": null,
"JobMutliOvhdPcFlag": null,
"JobName": "New York General Hospital",
"JobOrigBudgetEffectiveDate": null,
"JobOriginalContractAmt": null,
"JobOriginalFeeAmt": null,
"JobPartnCode": null,
"JobPartnTypeCode": null,
"JobPayFromJobCompFlag": null,
"JobPayrateScheduleCode": null,
"JobPhsBudgUnitsFlag": null,
"JobPhsTypeRequiredFlg": null,
"JobPlPolicyNo": null,
"JobPmFlag": null,
"JobPolicyNo": null,
"JobPrevailingWage": null,
"JobProfrecAmt": null,
"JobProjThresholdPct": null,
"JobPropertyId": null,
"JobProvinceCode": null,
"JobPublicSectorFlag": null,
"JobPwOvRate": null,
"JobPwRateCode": null,
"JobPyOvtruleCode": null,
"JobRateByJobFlag": null,
"JobRecAmt": null,
"JobReserveRevAccCode": null,
"JobReserveRevDeptCode": null,
"JobRevenueGenState": null,
"JobRevrecAmt": null,
"JobRevrecCurrDate": null,
"JobRevrecLstAmt": null,
"JobRevrecLstPc": null,
"JobRevrecPc": null,
"JobRuleCode": null,
"JobSecGroup": "MASTER",
"JobSectorCode": null,
"JobShowCprAsCostAmtFlag": null,
"JobSiSeqNum": null,
"JobSickPolicyCode": null,
"JobSizeCode": null,
"JobStatusCode": null,
"JobSubFlag": null,
"JobSuptContactCode": null,
"JobSuptPartnCode": null,
"JobSuptPartnTypeCode": null,
"JobTax1Code": null,
"JobTax2Code": null,
"JobTax3Code": null,
"JobTermCode": null,
"JobTrackRepBurden": null,
"JobUeValidFlag": null,
"JobUnbilledRevAccCode": null,
"JobUnbilledRevDeptCode": null,
"JobUnitPricedContractFlag": null,
"JobUseEqpBillRateFlag": null,
"JobUsePayBillRateFlag": null,
"JobWbsvCode1": null,
"JobWbsvCode10": null,
"JobWbsvCode11": null,
"JobWbsvCode12": null,
"JobWbsvCode2": null,
"JobWbsvCode3": null,
"JobWbsvCode4": null,
"JobWbsvCode5": null,
"JobWbsvCode6": null,
"JobWbsvCode7": null,
"JobWbsvCode8": null,
"JobWbsvCode9": null,
"JobWbsvEditableFlag1": null,
"JobWbsvEditableFlag10": null,
"JobWbsvEditableFlag11": null,
"JobWbsvEditableFlag12": null,
"JobWbsvEditableFlag2": null,
"JobWbsvEditableFlag3": null,
"JobWbsvEditableFlag4": null,
"JobWbsvEditableFlag5": null,
"JobWbsvEditableFlag6": null,
"JobWbsvEditableFlag7": null,
"JobWbsvEditableFlag8": null,
"JobWbsvEditableFlag9": null,
"JobWbsvRequiredFlag1": null,
"JobWbsvRequiredFlag10": null,
"JobWbsvRequiredFlag11": null,
"JobWbsvRequiredFlag12": null,
"JobWbsvRequiredFlag2": null,
"JobWbsvRequiredFlag3": null,
"JobWbsvRequiredFlag4": null,
"JobWbsvRequiredFlag5": null,
"JobWbsvRequiredFlag6": null,
"JobWbsvRequiredFlag7": null,
"JobWbsvRequiredFlag8": null,
"JobWbsvRequiredFlag9": null,
"JobWipAccCode": null,
"JobWipAdjAccCode": null,
"JobWipAdjDeptCode": null,
"JobWipDeptCode": "00",
"JobWipLmrgOvrFlag": null,
"JobWipMrgLossbsAcc": null,
"JobWipMrgLossbsDep": null,
"JobWipMrgLossplAcc": null,
"JobWipMrgLossplDep": null,
"JobWipOhLossbsAcc": null,
"JobWipOhLossbsDep": null,
"JobWipOhLossplAcc": null,
"JobWipOhLossplDep": null,
"JobWipOverrideContAmt": null,
"JobWipRollInSubjobFlag": null,
"JobWipUnpostedCostAcc": null,
"JobWipUnpostedCostCat": null,
"JobWipUnpostedCostDep": null,
"JobWipUnpostedCostPhase": null,
"JobWipUnpostedRevAcc": null,
"JobWipUnpostedRevCat": null,
"JobWipUnpostedRevDep": null,
"JobWipUnpostedRevPhase": null,
"JobWmCode": null,
"JobWoFlag": null,
"JobWorkLoc": null,
"WorkLoc": null,
"JobVUuid": "F5D75D5B52A1632EE05316821FACC89E",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjob/F5D75D5B52A1632EE05316821FACC89E",
"name": "jcjob",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjob/F5D75D5B52A1632EE05316821FACC89E",
"name": "jcjob",
"kind": "item"
}
]
}example-1
Successful Response
{
"JobAccmethCode": null,
"JobAcctContactCode": null,
"JobAcctPartnCode": null,
"JobAcctPartnTypeCode": null,
"JobActComplDate": null,
"JobActStartDate": null,
"JobActionCode": null,
"JobAddTypeCode": null,
"JobAdjBudgEqualsRevFlg": null,
"JobAllocApdiscJobFlag": null,
"JobAllowEtmshtEntriesFlag": null,
"JobAllowOverheadFlag": null,
"JobApTax1Code": null,
"JobApTax2Code": null,
"JobApTax3Code": null,
"JobApplyDbRules": null,
"JobArTax1Code": null,
"JobArTax2Code": null,
"JobArTax3Code": null,
"JobArchiveFlag": null,
"JobAreaDistrict": null,
"JobAsstContactCode": null,
"JobAsstPartnCode": null,
"JobAsstPartnTypeCode": null,
"JobAttachOraseq": null,
"JobAuthRqSeqNum": null,
"JobBidCode": null,
"JobBidFlag": null,
"JobBidStatusCode": null,
"JobBidSubmitDate": null,
"JobBillAccCode": null,
"JobBillAmt": null,
"JobBillDeptCode": "00",
"JobBillFlag": null,
"JobBillMethCode": null,
"JobBillTblRevFcastFlg": null,
"JobBillingRateTableCode": null,
"JobBillingTypeCode": null,
"JobBudgOvrdProjFlag": null,
"JobBudgUnit": null,
"JobBudgcstSameLevelFlag": null,
"JobBudgrSeqNum": null,
"JobCalSalChargeRate": null,
"JobCcAccCode": null,
"JobCcDeptCode": "00",
"JobCertifyCode": null,
"JobCertrepContractNumber": null,
"JobCertrepEndDate": null,
"JobCertrepFringeBenPaid": null,
"JobCertrepSignatoryName": null,
"JobCertrepSignatoryTitle": null,
"JobCertrepStartDate": null,
"JobChgSeqNum": null,
"JobCilocCode": null,
"JobCode": "0568",
"JobCompCode": "001",
"JobComplUnit": null,
"JobCompletedForWipFlag": null,
"JobConstructionValue": null,
"JobConstructionValuePct": null,
"JobContTypeCode": null,
"JobContactCode": null,
"JobContractAmt": null,
"JobContractCode": "0568",
"JobCostFlag": null,
"JobCostMethCode": null,
"JobCostToComplOvrdFlg": null,
"JobCreateDate": null,
"JobCtrlCode": "ALL",
"JobCustCode": "IRV",
"JobCustContactName": null,
"JobDaysOutstInvPaidTtl": null,
"JobDefaultDeptCode": "00",
"JobDefaultPyovhdGrp": null,
"JobDisbAmt": null,
"JobEqpChgNoRestartFlag": null,
"JobEstComplDate": null,
"JobEstStartDate": null,
"JobExclBillingWip": null,
"JobExclContAmtWipFlag": null,
"JobExclRevBudgWip": null,
"JobExcludeFromWipFlag": null,
"JobFcastInclSubjobsFlg": null,
"JobFinalizeProjectionsFlag": null,
"JobFullyPaidInvs": null,
"JobHbAmt": null,
"JobHbRecAmt": null,
"JobHier": null,
"JobIbAllowFlag": null,
"JobIbExpenseCatCode": null,
"JobIbFullTariffFlag": null,
"JobIgnoreCostsPriorToDate": null,
"JobInvFormatCode": null,
"JobInvoiceFormatCode": null,
"JobInvoiceGroupCode": null,
"JobIuCreateDate": null,
"JobIuUpdateDate": null,
"JobJbMapCode": null,
"JobJbRetainageCode": null,
"JobJtrExpFlag": null,
"JobLbcAccCode": null,
"JobLbcDeptCode": null,
"JobLocCode": null,
"JobLongCode": null,
"JobLstAddonDate": null,
"JobLstRecDate": null,
"JobLstRecPc": null,
"JobLtcAccCode": null,
"JobLtcDeptCode": "00",
"JobMakeupFlag": null,
"JobMaxBillingAmt": null,
"JobMaxBillingBudgetAmt": null,
"JobMaxChargePc": null,
"JobMaxHourlyRate": null,
"JobMaxHours": null,
"JobMsCode": null,
"JobMutliOvhdPcFlag": null,
"JobName": "New York General Hospital",
"JobOrigBudgetEffectiveDate": null,
"JobOriginalContractAmt": null,
"JobOriginalFeeAmt": null,
"JobPartnCode": null,
"JobPartnTypeCode": null,
"JobPayFromJobCompFlag": null,
"JobPayrateScheduleCode": null,
"JobPhsBudgUnitsFlag": null,
"JobPhsTypeRequiredFlg": null,
"JobPlPolicyNo": null,
"JobPmFlag": null,
"JobPolicyNo": null,
"JobPrevailingWage": null,
"JobProfrecAmt": null,
"JobProjThresholdPct": null,
"JobPropertyId": null,
"JobProvinceCode": null,
"JobPublicSectorFlag": null,
"JobPwOvRate": null,
"JobPwRateCode": null,
"JobPyOvtruleCode": null,
"JobRateByJobFlag": null,
"JobRecAmt": null,
"JobReserveRevAccCode": null,
"JobReserveRevDeptCode": null,
"JobRevenueGenState": null,
"JobRevrecAmt": null,
"JobRevrecCurrDate": null,
"JobRevrecLstAmt": null,
"JobRevrecLstPc": null,
"JobRevrecPc": null,
"JobRuleCode": null,
"JobSecGroup": "MASTER",
"JobSectorCode": null,
"JobShowCprAsCostAmtFlag": null,
"JobSiSeqNum": null,
"JobSickPolicyCode": null,
"JobSizeCode": null,
"JobStatusCode": null,
"JobSubFlag": null,
"JobSuptContactCode": null,
"JobSuptPartnCode": null,
"JobSuptPartnTypeCode": null,
"JobTax1Code": null,
"JobTax2Code": null,
"JobTax3Code": null,
"JobTermCode": null,
"JobTrackRepBurden": null,
"JobUeValidFlag": null,
"JobUnbilledRevAccCode": null,
"JobUnbilledRevDeptCode": null,
"JobUnitPricedContractFlag": null,
"JobUseEqpBillRateFlag": null,
"JobUsePayBillRateFlag": null,
"JobWbsvCode1": null,
"JobWbsvCode10": null,
"JobWbsvCode11": null,
"JobWbsvCode12": null,
"JobWbsvCode2": null,
"JobWbsvCode3": null,
"JobWbsvCode4": null,
"JobWbsvCode5": null,
"JobWbsvCode6": null,
"JobWbsvCode7": null,
"JobWbsvCode8": null,
"JobWbsvCode9": null,
"JobWbsvEditableFlag1": null,
"JobWbsvEditableFlag10": null,
"JobWbsvEditableFlag11": null,
"JobWbsvEditableFlag12": null,
"JobWbsvEditableFlag2": null,
"JobWbsvEditableFlag3": null,
"JobWbsvEditableFlag4": null,
"JobWbsvEditableFlag5": null,
"JobWbsvEditableFlag6": null,
"JobWbsvEditableFlag7": null,
"JobWbsvEditableFlag8": null,
"JobWbsvEditableFlag9": null,
"JobWbsvRequiredFlag1": null,
"JobWbsvRequiredFlag10": null,
"JobWbsvRequiredFlag11": null,
"JobWbsvRequiredFlag12": null,
"JobWbsvRequiredFlag2": null,
"JobWbsvRequiredFlag3": null,
"JobWbsvRequiredFlag4": null,
"JobWbsvRequiredFlag5": null,
"JobWbsvRequiredFlag6": null,
"JobWbsvRequiredFlag7": null,
"JobWbsvRequiredFlag8": null,
"JobWbsvRequiredFlag9": null,
"JobWipAccCode": null,
"JobWipAdjAccCode": null,
"JobWipAdjDeptCode": null,
"JobWipDeptCode": "00",
"JobWipLmrgOvrFlag": null,
"JobWipMrgLossbsAcc": null,
"JobWipMrgLossbsDep": null,
"JobWipMrgLossplAcc": null,
"JobWipMrgLossplDep": null,
"JobWipOhLossbsAcc": null,
"JobWipOhLossbsDep": null,
"JobWipOhLossplAcc": null,
"JobWipOhLossplDep": null,
"JobWipOverrideContAmt": null,
"JobWipRollInSubjobFlag": null,
"JobWipUnpostedCostAcc": null,
"JobWipUnpostedCostCat": null,
"JobWipUnpostedCostDep": null,
"JobWipUnpostedCostPhase": null,
"JobWipUnpostedRevAcc": null,
"JobWipUnpostedRevCat": null,
"JobWipUnpostedRevDep": null,
"JobWipUnpostedRevPhase": null,
"JobWmCode": null,
"JobWoFlag": null,
"JobWorkLoc": null,
"WorkLoc": null,
"JobVUuid": "F5D75D5B52A1632EE05316821FACC89E",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjob/F5D75D5B52A1632EE05316821FACC89E",
"name": "jcjob",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjob/F5D75D5B52A1632EE05316821FACC89E",
"name": "jcjob",
"kind": "item"
}
]
}object