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
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{
"JobCode": "000003",
"JobCompCode": "111",
"JobName": "Job 000003",
"JobCtrlCode": "ALL",
"JobDefaultDeptCode": "00",
"JobCustCode": "ICON",
"JobEstStartDate": "2023-01-01",
"JobCcDeptCode": "",
"JobCcAccCode": "",
"JobLtcDeptCode": "00",
"JobLtcAccCode": "",
"JobWipDeptCode": "00",
"JobBillDeptCode": "00",
"JobSecGroup": "MASTER",
"JobContractCode": "000003",
"JobVUuid": ""
}
Responses
201
Created
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
{
"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