API Catalog

Retrieve Job Categories By Code

25 Sep 2024
5 Minutes to read

Print
Dark
Light

Retrieve Job Categories By Code

Updated on 25 Sep 2024
5 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/jc-rest-api/rest/1/jcjobcategory

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

Select Job Category
Select By Audit Date
Select By Category Date
By UUID

Select Job Category

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
jobCode	Job Code	00-0001
compCode	Company Code	001
categoryCode	Category Code	L

Select By Audit Date

This is an optional finder for querying Job Categories by Audit Date.

Parameter	Description	Sample
auditDate	Create or Update Date Time Filter	2016-01-01

Select By Category Date

This is an optional finder for querying Job Categories by Category Date.

Parameter	Description	Sample
catDate	Category Date	2016-01-01

By UUID

This is an optional finder for querying a specific Job Category by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/jc-rest-api/rest/1/jcjobcategory/BD8E1507E3FE2691E05316821FAC4947

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectJobCategory;jobCode=00-0001, compCode=001, categoryCode=L

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleJcatVUuid:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - selectJobCategory

{
  "items": [
    {
      "JcatActLbAmt": null,
      "JcatAddedFromApp": null,
      "JcatAddonAmt": null,
      "JcatAnticipatedCostAmt": null,
      "JcatBidItemRemainingAmt": null,
      "JcatBillAmt": null,
      "JcatBillCode": null,
      "JcatBillName": null,
      "JcatBillingTypeCode": null,
      "JcatBudgAdjustmentAmt": null,
      "JcatBudgAmt": 15000,
      "JcatBudgRevAmt": null,
      "JcatBudgRevQty": null,
      "JcatBudgRevRevAmt": null,
      "JcatBudgRevenueAmt": 15000,
      "JcatBudgUnit": null,
      "JcatBudgUnitRate": 150,
      "JcatBudmethCode": "A",
      "JcatCalculateColumnName": null,
      "JcatCatActiveFlag": "Y",
      "JcatCatHier": "001     00-0001   L               ",
      "JcatChgOrdAmt": null,
      "JcatChgOrdQty": null,
      "JcatChgOrdRevAmt": null,
      "JcatCode": "L",
      "JcatName": "Labor",
      "JcatCommUnit": null,
      "JcatCompCode": "001",
      "JcatComplPc": 0,
      "JcatComplPcDate": null,
      "JcatComplUnit": 0,
      "JcatCostAmt": null,
      "JcatCostRateOverrideAmt": null,
      "JcatCostToComplOvrdFlg": "N",
      "JcatCstEntry": "B",
      "JcatCtrlCode": "ALL",
      "JcatCatCtrlName": null,
      "JcatDisbAmt": null,
      "JcatDlbAmt": null,
      "JcatExclCostBudgWip": "N",
      "JcatExclCostWip": "N",
      "JcatFreezeProjAmtFlag": "N",
      "JcatFwdLossOvrhPct": null,
      "JcatHbPayAmt": null,
      "JcatIdealRevenueAmt": null,
      "JcatInvCommAmt": null,
      "JcatInvCommUnit": null,
      "JcatInvUnit": null,
      "JcatInvoiceFormatCode": null,
      "JcatJobCode": "00-0001",
      "JcatJobName": "Canary - no subjob",
      "JcatJobCtrlCode": "ALL",
      "JcatJobCtrlName": null,
      "JcatLabourForecastFlag": "N",
      "JcatMaxBillingAmt": null,
      "JcatMaxBillingBudgetAmt": null,
      "JcatNcommCostAmt": null,
      "JcatNinvCommAmt": null,
      "JcatObudgAmt": null,
      "JcatObudgChgOrdAmt": null,
      "JcatObudgChgOrdRevAmt": null,
      "JcatObudgChgOrdUnit": null,
      "JcatObudgRevenueAmt": null,
      "JcatObudgUnit": null,
      "JcatPbBillCode": null,
      "JcatPhaseActiveFlag": "Y",
      "JcatPhsCode": "0005-01-01T12:00:00Z",
      "JcatPhaseName": "Project Executive",
      "JcatPhsCtrlCode": "01",
      "JcatPhaseCtrlName": "GENERAL REQUIREMENTS",
      "JcatPhsHier": "001     00-0001   01              01-01-005       ",
      "JcatPriorCostAmt": null,
      "JcatPriorCostQty": null,
      "JcatProductivityOverride": null,
      "JcatProjAmt": 15000,
      "JcatProjUnit": null,
      "JcatRevAdjustmentAmt": null,
      "JcatRuleCode": null,
      "JcatTimePhasedFlag": "N",
      "JcatUserEnteredProjAmt": null,
      "JcatUserEnteredProjUnit": null,
      "JcatVarCode": "L",
      "JcatWbsBudgetFlag": "N",
      "JcatWbsvCode1": null,
      "JcatWbsvCode10": null,
      "JcatWbsvCode11": null,
      "JcatWbsvCode12": null,
      "JcatWbsvCode2": null,
      "JcatWbsvCode3": null,
      "JcatWbsvCode4": null,
      "JcatWbsvCode5": null,
      "JcatWbsvCode6": null,
      "JcatWbsvCode7": null,
      "JcatWbsvCode8": null,
      "JcatWbsvCode9": null,
      "JcatWbsvEditableFlag1": "Y",
      "JcatWbsvEditableFlag10": null,
      "JcatWbsvEditableFlag11": null,
      "JcatWbsvEditableFlag12": null,
      "JcatWbsvEditableFlag2": "Y",
      "JcatWbsvEditableFlag3": "Y",
      "JcatWbsvEditableFlag4": "N",
      "JcatWbsvEditableFlag5": null,
      "JcatWbsvEditableFlag6": null,
      "JcatWbsvEditableFlag7": null,
      "JcatWbsvEditableFlag8": null,
      "JcatWbsvEditableFlag9": null,
      "JcatWbsvRequiredFlag1": "N",
      "JcatWbsvRequiredFlag10": null,
      "JcatWbsvRequiredFlag11": null,
      "JcatWbsvRequiredFlag12": null,
      "JcatWbsvRequiredFlag2": "N",
      "JcatWbsvRequiredFlag3": "N",
      "JcatWbsvRequiredFlag4": "N",
      "JcatWbsvRequiredFlag5": null,
      "JcatWbsvRequiredFlag6": null,
      "JcatWbsvRequiredFlag7": null,
      "JcatWbsvRequiredFlag8": null,
      "JcatWbsvRequiredFlag9": null,
      "JcatWcbCode": null,
      "JcatWmCode": "HR",
      "JcatVUuid": "01466EEBF4C263CFE06316821FAC243D",
      "JcatIuCreateDate": "2023-07-25T01:20:49Z",
      "JcatIuUpdateDate": "2023-07-25T01:20:49Z",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory/01466EEBF4C263CFE06316821FAC243D",
          "name": "jcjobcategory",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory/01466EEBF4C263CFE06316821FAC243D",
          "name": "jcjobcategory",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 50,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory",
      "name": "jcjobcategory",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - selectByCatDate

{
  "items": [
    {
      "JcatActLbAmt": null,
      "JcatAddedFromApp": null,
      "JcatAddonAmt": null,
      "JcatAnticipatedCostAmt": null,
      "JcatBidItemRemainingAmt": null,
      "JcatBillAmt": 0,
      "JcatBillCode": null,
      "JcatBillName": null,
      "JcatBillingTypeCode": null,
      "JcatBudgAdjustmentAmt": null,
      "JcatBudgAmt": null,
      "JcatBudgRevAmt": null,
      "JcatBudgRevQty": null,
      "JcatBudgRevRevAmt": null,
      "JcatBudgRevenueAmt": null,
      "JcatBudgUnit": null,
      "JcatBudgUnitRate": null,
      "JcatBudmethCode": "A",
      "JcatCalculateColumnName": null,
      "JcatCatActiveFlag": "Y",
      "JcatCatHier": "001     00100     A               ",
      "JcatChgOrdAmt": null,
      "JcatChgOrdQty": null,
      "JcatChgOrdRevAmt": null,
      "JcatCode": "A",
      "JcatName": "Allowance",
      "JcatCommUnit": null,
      "JcatCompCode": "001",
      "JcatComplPc": null,
      "JcatComplPcDate": null,
      "JcatComplUnit": null,
      "JcatCostAmt": null,
      "JcatCostRateOverrideAmt": null,
      "JcatCostToComplOvrdFlg": "N",
      "JcatCstEntry": "B",
      "JcatCtrlCode": "ALL",
      "JcatCatCtrlName": null,
      "JcatDisbAmt": null,
      "JcatDlbAmt": null,
      "JcatExclCostBudgWip": "N",
      "JcatExclCostWip": "N",
      "JcatFreezeProjAmtFlag": null,
      "JcatFwdLossOvrhPct": null,
      "JcatHbPayAmt": null,
      "JcatIdealRevenueAmt": 0,
      "JcatInvCommAmt": null,
      "JcatInvCommUnit": null,
      "JcatInvUnit": null,
      "JcatInvoiceFormatCode": null,
      "JcatJobCode": "00100",
      "JcatJobName": "Electrical Reno",
      "JcatJobCtrlCode": "ALL",
      "JcatJobCtrlName": null,
      "JcatLabourForecastFlag": "N",
      "JcatMaxBillingAmt": null,
      "JcatMaxBillingBudgetAmt": null,
      "JcatNcommCostAmt": null,
      "JcatNinvCommAmt": null,
      "JcatObudgAmt": 0,
      "JcatObudgChgOrdAmt": null,
      "JcatObudgChgOrdRevAmt": null,
      "JcatObudgChgOrdUnit": null,
      "JcatObudgRevenueAmt": 0,
      "JcatObudgUnit": 0,
      "JcatPbBillCode": "15090.A",
      "JcatPhaseActiveFlag": "Y",
      "JcatPhsCode": "15090",
      "JcatPhaseName": "Mechanical Restoration and Retrofit",
      "JcatPhsCtrlCode": "15",
      "JcatPhaseCtrlName": "MECHANICAL",
      "JcatPhsHier": "001     00100     15              15090           ",
      "JcatPriorCostAmt": null,
      "JcatPriorCostQty": null,
      "JcatProductivityOverride": null,
      "JcatProjAmt": null,
      "JcatProjUnit": null,
      "JcatRevAdjustmentAmt": null,
      "JcatRuleCode": null,
      "JcatTimePhasedFlag": null,
      "JcatUserEnteredProjAmt": null,
      "JcatUserEnteredProjUnit": null,
      "JcatVarCode": "L",
      "JcatWbsBudgetFlag": "N",
      "JcatWbsvCode1": null,
      "JcatWbsvCode10": null,
      "JcatWbsvCode11": null,
      "JcatWbsvCode12": null,
      "JcatWbsvCode2": null,
      "JcatWbsvCode3": null,
      "JcatWbsvCode4": null,
      "JcatWbsvCode5": null,
      "JcatWbsvCode6": null,
      "JcatWbsvCode7": null,
      "JcatWbsvCode8": null,
      "JcatWbsvCode9": null,
      "JcatWbsvEditableFlag1": "Y",
      "JcatWbsvEditableFlag10": null,
      "JcatWbsvEditableFlag11": null,
      "JcatWbsvEditableFlag12": null,
      "JcatWbsvEditableFlag2": "Y",
      "JcatWbsvEditableFlag3": "Y",
      "JcatWbsvEditableFlag4": "N",
      "JcatWbsvEditableFlag5": null,
      "JcatWbsvEditableFlag6": null,
      "JcatWbsvEditableFlag7": null,
      "JcatWbsvEditableFlag8": null,
      "JcatWbsvEditableFlag9": null,
      "JcatWbsvRequiredFlag1": "N",
      "JcatWbsvRequiredFlag10": null,
      "JcatWbsvRequiredFlag11": null,
      "JcatWbsvRequiredFlag12": null,
      "JcatWbsvRequiredFlag2": "N",
      "JcatWbsvRequiredFlag3": "N",
      "JcatWbsvRequiredFlag4": "N",
      "JcatWbsvRequiredFlag5": null,
      "JcatWbsvRequiredFlag6": null,
      "JcatWbsvRequiredFlag7": null,
      "JcatWbsvRequiredFlag8": null,
      "JcatWbsvRequiredFlag9": null,
      "JcatWcbCode": null,
      "JcatWmCode": "$",
      "JcatVUuid": "BD8E1507E3FE2691E05316821FAC4947",
      "JcatIuCreateDate": "2016-09-21T08:10:46Z",
      "JcatIuUpdateDate": "2023-01-25T04:35:30Z",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory/BD8E1507E3FE2691E05316821FAC4947",
          "name": "jcjobcategory",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory/BD8E1507E3FE2691E05316821FAC4947",
          "name": "jcjobcategory",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": true,
  "limit": 1,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory",
      "name": "jcjobcategory",
      "kind": "collection"
    }
  ]
}

example-2

Successful Response - Finder - selectByAuditDate

{
  "items": [
    {
      "JcatActLbAmt": null,
      "JcatAddedFromApp": null,
      "JcatAddonAmt": null,
      "JcatAnticipatedCostAmt": null,
      "JcatBidItemRemainingAmt": null,
      "JcatBillAmt": 0,
      "JcatBillCode": null,
      "JcatBillName": null,
      "JcatBillingTypeCode": null,
      "JcatBudgAdjustmentAmt": null,
      "JcatBudgAmt": null,
      "JcatBudgRevAmt": null,
      "JcatBudgRevQty": null,
      "JcatBudgRevRevAmt": null,
      "JcatBudgRevenueAmt": null,
      "JcatBudgUnit": null,
      "JcatBudgUnitRate": null,
      "JcatBudmethCode": "A",
      "JcatCalculateColumnName": null,
      "JcatCatActiveFlag": "Y",
      "JcatCatHier": "001     00100     A               ",
      "JcatChgOrdAmt": null,
      "JcatChgOrdQty": null,
      "JcatChgOrdRevAmt": null,
      "JcatCode": "A",
      "JcatName": "Allowance",
      "JcatCommUnit": null,
      "JcatCompCode": "001",
      "JcatComplPc": null,
      "JcatComplPcDate": null,
      "JcatComplUnit": null,
      "JcatCostAmt": null,
      "JcatCostRateOverrideAmt": null,
      "JcatCostToComplOvrdFlg": "N",
      "JcatCstEntry": "B",
      "JcatCtrlCode": "ALL",
      "JcatCatCtrlName": null,
      "JcatDisbAmt": null,
      "JcatDlbAmt": null,
      "JcatExclCostBudgWip": "N",
      "JcatExclCostWip": "N",
      "JcatFreezeProjAmtFlag": null,
      "JcatFwdLossOvrhPct": null,
      "JcatHbPayAmt": null,
      "JcatIdealRevenueAmt": 0,
      "JcatInvCommAmt": null,
      "JcatInvCommUnit": null,
      "JcatInvUnit": null,
      "JcatInvoiceFormatCode": null,
      "JcatJobCode": "00100",
      "JcatJobName": "Electrical Reno",
      "JcatJobCtrlCode": "ALL",
      "JcatJobCtrlName": null,
      "JcatLabourForecastFlag": "N",
      "JcatMaxBillingAmt": null,
      "JcatMaxBillingBudgetAmt": null,
      "JcatNcommCostAmt": null,
      "JcatNinvCommAmt": null,
      "JcatObudgAmt": 0,
      "JcatObudgChgOrdAmt": null,
      "JcatObudgChgOrdRevAmt": null,
      "JcatObudgChgOrdUnit": null,
      "JcatObudgRevenueAmt": 0,
      "JcatObudgUnit": 0,
      "JcatPbBillCode": "15090.A",
      "JcatPhaseActiveFlag": "Y",
      "JcatPhsCode": "15090",
      "JcatPhaseName": "Mechanical Restoration and Retrofit",
      "JcatPhsCtrlCode": "15",
      "JcatPhaseCtrlName": "MECHANICAL",
      "JcatPhsHier": "001     00100     15              15090           ",
      "JcatPriorCostAmt": null,
      "JcatPriorCostQty": null,
      "JcatProductivityOverride": null,
      "JcatProjAmt": null,
      "JcatProjUnit": null,
      "JcatRevAdjustmentAmt": null,
      "JcatRuleCode": null,
      "JcatTimePhasedFlag": null,
      "JcatUserEnteredProjAmt": null,
      "JcatUserEnteredProjUnit": null,
      "JcatVarCode": "L",
      "JcatWbsBudgetFlag": "N",
      "JcatWbsvCode1": null,
      "JcatWbsvCode10": null,
      "JcatWbsvCode11": null,
      "JcatWbsvCode12": null,
      "JcatWbsvCode2": null,
      "JcatWbsvCode3": null,
      "JcatWbsvCode4": null,
      "JcatWbsvCode5": null,
      "JcatWbsvCode6": null,
      "JcatWbsvCode7": null,
      "JcatWbsvCode8": null,
      "JcatWbsvCode9": null,
      "JcatWbsvEditableFlag1": "Y",
      "JcatWbsvEditableFlag10": null,
      "JcatWbsvEditableFlag11": null,
      "JcatWbsvEditableFlag12": null,
      "JcatWbsvEditableFlag2": "Y",
      "JcatWbsvEditableFlag3": "Y",
      "JcatWbsvEditableFlag4": "N",
      "JcatWbsvEditableFlag5": null,
      "JcatWbsvEditableFlag6": null,
      "JcatWbsvEditableFlag7": null,
      "JcatWbsvEditableFlag8": null,
      "JcatWbsvEditableFlag9": null,
      "JcatWbsvRequiredFlag1": "N",
      "JcatWbsvRequiredFlag10": null,
      "JcatWbsvRequiredFlag11": null,
      "JcatWbsvRequiredFlag12": null,
      "JcatWbsvRequiredFlag2": "N",
      "JcatWbsvRequiredFlag3": "N",
      "JcatWbsvRequiredFlag4": "N",
      "JcatWbsvRequiredFlag5": null,
      "JcatWbsvRequiredFlag6": null,
      "JcatWbsvRequiredFlag7": null,
      "JcatWbsvRequiredFlag8": null,
      "JcatWbsvRequiredFlag9": null,
      "JcatWcbCode": null,
      "JcatWmCode": "$",
      "JcatVUuid": "BD8E1507E3FE2691E05316821FAC4947",
      "JcatIuCreateDate": "2016-09-21T08:10:46Z",
      "JcatIuUpdateDate": "2023-01-25T04:35:30Z",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory/BD8E1507E3FE2691E05316821FAC4947",
          "name": "jcjobcategory",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory/BD8E1507E3FE2691E05316821FAC4947",
          "name": "jcjobcategory",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": true,
  "limit": 50,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcategory",
      "name": "jcjobcategory",
      "kind": "collection"
    }
  ]
}

object

What's Next

Create a JC Job Cost Code (Job Phases)

Retrieve Job Categories By Code

Query Standards

Finder

Select Job Category

Select By Audit Date

Select By Category Date

By UUID

What's Next

Contact Us