> ## Documentation Index > Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Inventory Classes By Code > ## Query Standards ### Finder Following row finders are available for data filtering and optimizing request performance. - Select by Date - By UUID #### Select by Date Recommended finder parameters. Refer to Query Parameters for example. | Parameter | Description | Sample | | --- | --- | --- | | AuditDate | Create or update date time filter | 2022-12-20 | #### By UUID This is an optional finder for querying a specific Inventory Classe by row ID. | Parameter | Description | Sample | | --- | --- | --- | | /VUUID | The VUuid attribute is the Unique row ID | /ci-rest-api/rest/1/ciclass/D2B734260E2A3E82E05316821FAC9629 | ## OpenAPI ````json GET /ci-rest-api/rest/1/ciclass { "openapi": "3.0.0", "info": { "title": "API Catalog", "description": "", "version": "1.0.0" }, "servers": [ { "url": "https://mobtest.cmiccloudr12.com/cmictestrti", "description": "CMIC API Server" } ], "security": [ { "cmicBasicAuth": [] } ], "tags": [ { "name": "Highlights" }, { "name": "Asset Management | Equipment" }, { "name": "Asset Management | Fixed Assets" }, { "name": "Asset Management | Purchase Order" }, { "name": "Asset Management | Inventory" }, { "name": "Asset Management | Requisition" }, { "name": "Asset Management | Purchase Change Order" }, { "name": "Bim Model" }, { "name": "Bim Model Revision" }, { "name": "Bim Tag Model" }, { "name": "Bim Tags" }, { "name": "Bim FileUpload Jersey" }, { "name": "Core System | Business Partners" }, { "name": "Core System | Business Partner Addresses" }, { "name": "Core System | Bank" }, { "name": "Core System | Currency" }, { "name": "Core System | Exchange Rates" }, { "name": "Core System | Global Table Text Codes" }, { "name": "Core System | Global Table Regions" }, { "name": "Core System | Terms" }, { "name": "Core System | System Contact" }, { "name": "Core System | Weight Measures" }, { "name": "Core System | Field User Defined Classifiers" }, { "name": "Core System | User Defined Classifiers by Object" }, { "name": "Core System | User Extension Definitions by Object" }, { "name": "Core System | User Extention Field Data Value" }, { "name": "Core System | User Extension Values by Object" }, { "name": "Core System | User System Role" }, { "name": "Core System | User Project Role" }, { "name": "Core System | Documents by Object" }, { "name": "Core System | Audit Status Log by Object" }, { "name": "Core System | Licensed Users" }, { "name": "Core System | Company Access" }, { "name": "Core System | Copy User Settings" }, { "name": "Core System | User Maintenance" }, { "name": "Core System | User Roles" }, { "name": "Core System | Security Groups" }, { "name": "Core System | Job/Project Security" }, { "name": "Core System | Weight Measure with Conversions Code" }, { "name": "Core System | Weight Measure Conversions Code" }, { "name": "Core System | User-defined-fields" }, { "name": "Core System | User-extension" }, { "name": "ECM and Workflow | Image Manager" }, { "name": "Financials | General Ledger" }, { "name": "Financials | Accounts Payable" }, { "name": "Financials | Accounts Receivable" }, { "name": "Preventative Maintenance | Issue Work Orders" }, { "name": "Preventative Maintenance | Issue Work Items" }, { "name": "Preventative Maintenance | Issue Work Budgets" }, { "name": "Preventative Maintenance | Issue Priorities" }, { "name": "Preventative Maintenance | Issue Status" }, { "name": "Preventative Maintenance | Issue Types" }, { "name": "Preventative Maintenance | Accumulative Equipment" }, { "name": "Preventative Maintenance | Work Orders" }, { "name": "Preventative Maintenance | Work Items" }, { "name": "Preventative Maintenance | Work Budgets" }, { "name": "Preventative Maintenance | Priorities" }, { "name": "Preventative Maintenance | Tasks" }, { "name": "HCM | UKG Pay Deductions" }, { "name": "HCM | UKG Pay Earnings" }, { "name": "HCM | UKG Pay Headers" }, { "name": "HCM | UKG Pay Taxes" }, { "name": "HCM | Payroll Geographical States" }, { "name": "HCM | Payroll Trades" }, { "name": "HCM | Payroll Union" }, { "name": "HCM | Payroll Pay Runs" }, { "name": "HCM | Payroll Pay Groups" }, { "name": "HCM | Payroll Tax" }, { "name": "HCM | Payroll Worker Compensation" }, { "name": "HCM | Payroll Work Locations" }, { "name": "HCM | Payroll Trade Pay Rates" }, { "name": "HCM | Payroll Union Pay Rates" }, { "name": "HCM | Payroll Job Pay Rates" }, { "name": "HCM | Payroll Master Benefits" }, { "name": "HCM | Payroll Master Deductions" }, { "name": "HCM | Payroll Ben/Ded/Leave Base Codes" }, { "name": "HCM | Payroll Ben/Ded Plans" }, { "name": "HCM | Payroll Ben/Ded Plan Options" }, { "name": "HCM | Payroll Company Benefits" }, { "name": "HCM | Payroll Company Deductions" }, { "name": "HCM | Payroll Vertex Geographic Locations" }, { "name": "HCM | Payroll Checks" }, { "name": "HCM | Payroll Timesheets" }, { "name": "HCM | Employee" }, { "name": "HCM | Employee (Minimum payload)" }, { "name": "HCM | Employee History" }, { "name": "HCM | Tax Exemptions" }, { "name": "HCM | Employee Tax Overrides" }, { "name": "HCM | Employee Pay Splits" }, { "name": "HCM | Employee Benefits" }, { "name": "HCM | Employee Clock In and Out" }, { "name": "HCM | Employee Deductions" }, { "name": "HCM | Employee Leaves" }, { "name": "HCM | Employee Leave History" }, { "name": "HCM | Employee Hour Types" }, { "name": "HCM | Employee Pay History" }, { "name": "HCM | Employee Work Statuses" }, { "name": "HCM | Employee Security Group" }, { "name": "HCM | Crewtime Crew" }, { "name": "HCM | Crewtime Employee Timesheet" }, { "name": "HCM | Crewtime Equipment Timesheet" }, { "name": "HCM | Crew Maintenance Activity Assignment" }, { "name": "HCM | Crew Maintenance Member Assignment" }, { "name": "HCM | Crew Maintenance Member Trade and Union Assignment" }, { "name": "HCM | Crew Maintenance Equipment Assignment" }, { "name": "HCM | Crew Maintenance Equipment Detail Assignment" }, { "name": "HCM | HR Requisitions" }, { "name": "HCM | HR Relations" }, { "name": "HCM | HR Employee Skills" }, { "name": "HCM | HR Incident" }, { "name": "HCM | HR Employee Relatives / Dependents" }, { "name": "HCM | HR Employee Positions" }, { "name": "HCM | HR Applicants" }, { "name": "HCM | HR Applications" }, { "name": "HCM | Vertex Location City" }, { "name": "HCM | HR Application History" }, { "name": "HCM | HR Dependent Benefits" }, { "name": "HCM | HR Dependent Deductions" }, { "name": "HCM | HR Employee Elected Plans" }, { "name": "HCM | HR Employee Training Certifications" }, { "name": "HCM | HR Trainings" }, { "name": "HCM | E-Timesheets" }, { "name": "HCM | System Contacts" }, { "name": "HCM | System User Payroll Security Group" }, { "name": "HCM | Payroll Timesheet Posting" }, { "name": "HCM | CrewTimesheet Posting" }, { "name": "HCM | HR Positions Master" }, { "name": "HCM | Payroll Pay Periods" }, { "name": "HCM | Payroll Rate Codes" }, { "name": "HCM | Payroll Overhead Codes and Rates" }, { "name": "HCM | Payroll Assigned Overhead to Jobs" }, { "name": "Materials Management | Material Sale Orders" }, { "name": "Materials Management | Material Sale Orders Details" }, { "name": "Materials Management | Truck Rate Detail" }, { "name": "Opportunity Management | Competitors" }, { "name": "Opportunity Management | Opportunities" }, { "name": "Opportunity Management | Revenue Details" }, { "name": "Opportunity Management | Opportunity History" }, { "name": "Opportunity Management | Organization" }, { "name": "Project Controls | Job Billing" }, { "name": "Project Controls | Job Cost" }, { "name": "Project Controls | PCI Details" }, { "name": "Project Controls | Unposted PCI Details" }, { "name": "Project Controls | PCI Headers" }, { "name": "Project Controls | Owner Change Orders" }, { "name": "Project Controls | CM Statuses" }, { "name": "Project Controls | CM Types" }, { "name": "Project Controls | CM Vendor Details" }, { "name": "Project Controls | Post PCI" }, { "name": "Project Management | Uploading Documents" }, { "name": "Project Management | Downloading Documents" }, { "name": "Project Management | Foreign Bid Item Imports" }, { "name": "Project Management | Communications" }, { "name": "Project Management | Daily Journals" }, { "name": "Project Management | Communications Types" }, { "name": "Project Management | Daily Journal Daily Work Plans" }, { "name": "Project Management | Daily Journal Field Forces" }, { "name": "Project Management | Daily Journal Labour" }, { "name": "Project Management | Daily Journal Materials" }, { "name": "Project Management | Daily Journal Owner Equipment" }, { "name": "Project Management | Daily Journal Quality Control" }, { "name": "Project Management | Daily Journal Tasks" }, { "name": "Project Management | Daily Journal Trade Equipment" }, { "name": "Project Management | Daily Journal Transactions" }, { "name": "Project Management | Daily Journal User Defined Data" }, { "name": "Project Management | Daily Journal Visitors" }, { "name": "Project Management | Daily Journal Bill Details" }, { "name": "Project Management | Field Work Directives" }, { "name": "Project Management | Contract Types" }, { "name": "Project Management | Company Contacts" }, { "name": "Project Management | Distribution BCC" }, { "name": "Project Management | Distribution CC" }, { "name": "Project Management | Field Work Directive Statuses" }, { "name": "Project Management | Issues" }, { "name": "Project Management | Key Players" }, { "name": "Project Management | Meetings" }, { "name": "Project Management | Meeting Attendees" }, { "name": "Project Management | Meeting Item Statuses" }, { "name": "Project Management | Meeting Tracks" }, { "name": "Project Management | Notes" }, { "name": "Project Management | Projects" }, { "name": "Project Management | Project Items" }, { "name": "Project Management | Project Item Phase Segment Sums" }, { "name": "Project Management | Project Partners" }, { "name": "Project Management | Notices" }, { "name": "Project Management | Notice Statuses" }, { "name": "Project Management | Owner JS Query" }, { "name": "Project Management | PCI Real Locations" }, { "name": "Project Management | Project Contacts" }, { "name": "Project Management | RFIs (Requests for Information)" }, { "name": "Project Management | RFI Statuses" }, { "name": "Project Management | Submittal Packages" }, { "name": "Project Management | Submittal Package Details" }, { "name": "Project Management | Submittal Package Status" }, { "name": "Project Management | Submittals" }, { "name": "Project Management | Submittal Status" }, { "name": "Project Management | Transmittals" }, { "name": "Project Management | Subcontract Headers" }, { "name": "Project Management | Subcontract Schedules" }, { "name": "Project Management | Subcontract Sechedule Phase Segment Sums" }, { "name": "Project Management | User Roles" }, { "name": "Project Management | Punchlists" }, { "name": "Project Management | Punchlist Details" }, { "name": "Project Management | Punchlist Statuses" }, { "name": "Project Management | Meeting Items" }, { "name": "Project Management | Self Perform Vendor" }, { "name": "Project Management | Submittal Types" }, { "name": "Project Management | Assign contact and partner to project" }, { "name": "Project Management | Subcontract Prequal" }, { "name": "Project Management | Bid Item Package" } ], "paths": { "/ci-rest-api/rest/1/ciclass": { "get": { "tags": [ "Asset Management | Inventory" ], "summary": "Retrieve Inventory Classes By Code", "description": "## Query Standards\n\n\n### Finder\n\nFollowing row finders are available for data filtering and optimizing request performance.\n\n- Select by Date\n- By UUID\n \n\n#### Select by Date\n\nRecommended finder parameters. Refer to Query Parameters for example.\n\n| Parameter | Description | Sample |\n| --- | --- | --- |\n| AuditDate | Create or update date time filter | 2022-12-20 |\n\n#### By UUID\n\nThis is an optional finder for querying a specific Inventory Classe by row ID.\n\n| Parameter | Description | Sample |\n| --- | --- | --- |\n| /VUUID | The VUuid attribute is the Unique row ID | /ci-rest-api/rest/1/ciclass/D2B734260E2A3E82E05316821FAC9629 |", "parameters": [ { "name": "finder", "in": "query", "schema": { "type": "string" }, "example": "selectByDate;AuditDate=2016-12-24" }, { "name": "limit", "in": "query", "schema": { "type": "integer" }, "example": "500" }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "example": "0" }, { "name": "totalResults", "in": "query", "schema": { "type": "boolean" }, "example": "true" }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "example": "CiclasVUuid:desc" } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/vnd.oracle.adf.resourcecollection+json" } } }, "content": { "application/json": { "schema": { "type": "object" }, "example": { "error": "{\n \"items\": [\n {\n \"CiclasAccumDeprAccCode\": null,\n \"CiclasAccumDeprAccName\": null,\n \"CiclasAdjAccCode\": \"50710\",\n \"CiclasAdjAccName\": \"Inventory Adj - Cost Update\",\n \"CiclasAffilRevAccCode\": \"40015\",\n \"CiclasAffilRevAccName\": \"Inventory Revenue\",\n \"CiclasAllowNegQtyFlag\": \"Y\",\n \"CiclasAutoBuildCmpFlag\": \"N\",\n \"CiclasBbPriceOrPctCode\": \"C\",\n \"CiclasClassCode\": \"PROD\",\n \"CiclasClassName\": \"Production Items\",\n \"CiclasCmpFlag\": \"N\",\n \"CiclasCompCode\": \"001\",\n \"CiclasCompName\": \"CMiC Construction Inc\",\n \"CiclasCostMethCode\": \"AVG\",\n \"CiclasCostUpdateLevelCode\": \"I\",\n \"CiclasCreditJcCatCode\": \"PROD\",\n \"CiclasCreditJcCatName\": \"Production Cost\",\n \"CiclasCtrlClassCode\": null,\n \"CiclasCtrlClassName\": null,\n \"CiclasCustRevAccCode\": \"40015\",\n \"CiclasCustRevAccName\": \"Inventory Revenue\",\n \"CiclasDefaultLocCode\": null,\n \"CiclasDefaultLocName\": null,\n \"CiclasDeprExpAccCode\": null,\n \"CiclasDeprExpAccName\": null,\n \"CiclasEmCostComponCode\": null,\n \"CiclasEmCostComponName\": null,\n \"CiclasHier\": \"001 .PROD .\",\n \"CiclasInvAccCode\": \"17010\",\n \"CiclasInvAccName\": \"Inventory Asset\",\n \"CiclasIuCreateDate\": \"2017-02-10T10:32:28-05:00\",\n \"CiclasIuCreateUser\": \"ADWAIT\",\n \"CiclasIuUpdateDate\": \"2017-02-10T11:24:40-05:00\",\n \"CiclasIuUpdateUser\": \"ADWAIT\",\n \"CiclasLotCtrlFlag\": \"N\",\n \"CiclasMsAvailableFlag\": \"N\",\n \"CiclasMszpcCode\": null,\n \"CiclasPartialDasmblFlag\": \"N\",\n \"CiclasProdFlag\": \"Y\",\n \"CiclasRevAccCode\": \"40015\",\n \"CiclasRevAccName\": \"Inventory Revenue\",\n \"CiclasRowid\": \"AAAX0uAAAAAAw5BAAW\",\n \"CiclasRtrnFlag\": \"N\",\n \"CiclasSalesProductFlag\": \"N\",\n \"CiclasSalesTax1Code\": null,\n \"CiclasSalesTax1Name\": null,\n \"CiclasSalesTax2Code\": null,\n \"CiclasSalesTax2Name\": null,\n \"CiclasSalesTax3Code\": null,\n \"CiclasSalesTax3Name\": null,\n \"CiclasSellPrice\": null,\n \"CiclasSellPriceOrPctCode\": \"C\",\n \"CiclasSerialFlag\": \"N\",\n \"CiclasSoldAtCostAccCode\": \"50600\",\n \"CiclasSoldAtCostAccName\": \"Cost of Goods Sold\",\n \"CiclasSuspAccCode\": \"17040\",\n \"CiclasSuspAccName\": \"Inventory Suspense\",\n \"CiclasTax1Code\": null,\n \"CiclasTax1Name\": null,\n \"CiclasTax2Code\": null,\n \"CiclasTax2Name\": null,\n \"CiclasTax3Code\": null,\n \"CiclasTax3Name\": null,\n \"CiclasTruckClassCode\": null,\n \"CiclasUsageCode\": \"N\",\n \"CiclasVUuid\": \"D2B734260ED33E82E05316821FAC9629\",\n \"CiclasVarAccCode\": \"50720\",\n \"CiclasVarAccName\": \"Inventory Variance- Purchasing\",\n \"CiclasVelocityCode\": null,\n \"CiclasWriAccCode\": \"50700\",\n \"CiclasWriAccName\": \"Inventory Writeoff Expense\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/ci-rest-api/rest/1/ciclass/D2B734260ED33E82E05316821FAC9629\",\n \"name\": \"ciclass\",\n \"kind\": \"item\"\n },\n {\n \"rel\": \"canonical\",\n \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/ci-rest-api/rest/1/ciclass/D2B73426\n0ED33E82E05316821FAC9629\",\n \"name\": \"ciclass\",\n \"kind\": \"item\"\n }\n ]\n },\n {\n \"CiclasAccumDeprAccCode\": null,\n \"CiclasAccumDeprAccName\": null,\n \"CiclasAdjAccCode\": \"50710\",\n \"CiclasAdjAccName\": \"Inventory Adj - Cost Update\",\n \"CiclasAffilRevAccCode\": \"40015\",\n \"CiclasAffilRevAccName\": \"Inventory Revenue\",\n \"CiclasAllowNegQtyFlag\": \"Y\",\n \"CiclasAutoBuildCmpFlag\": \"N\",\n \"CiclasBbPriceOrPctCode\": \"P\",\n \"CiclasClassCode\": \"AGGR\",\n \"CiclasClassName\": \"Aggregates\",\n \"CiclasCmpFlag\": \"N\",\n \"CiclasCompCode\": \"001\",\n \"CiclasCompName\": \"CMiC Construction Inc\",\n \"CiclasCostMethCode\": \"STD\",\n \"CiclasCostUpdateLevelCode\": \"I\",\n \"CiclasCreditJcCatCode\": null,\n \"CiclasCreditJcCatName\": null,\n \"CiclasCtrlClassCode\": null,\n \"CiclasCtrlClassName\": null,\n \"CiclasCustRevAccCode\": \"40015\",\n \"CiclasCustRevAccName\": \"Inventory Revenue\",\n \"CiclasDefaultLocCode\": null,\n \"CiclasDefaultLocName\": null,\n \"CiclasDeprExpAccCode\": null,\n \"CiclasDeprExpAccName\": null,\n \"CiclasEmCostComponCode\": null,\n \"CiclasEmCostComponName\": null,\n \"CiclasHier\": \"001 .AGGR .\",\n \"CiclasInvAccCode\": \"17010\",\n \"CiclasInvAccName\": \"Inventory Asset\",\n \"CiclasIuCreateDate\": \"2017-02-10T11:35:45-05:00\",\n \"CiclasIuCreateUser\": \"ADWAIT\",\n \"CiclasIuUpdateDate\": null,\n \"CiclasIuUpdateUser\": null,\n \"CiclasLotCtrlFlag\": \"N\",\n \"CiclasMsAvailableFlag\": \"Y\",\n \"CiclasMszpcCode\": null,\n \"CiclasPartialDasmblFlag\": \"N\",\n \"CiclasProdFlag\": \"N\",\n \"CiclasRevAccCode\": \"40015\",\n \"CiclasRevAccName\": \"Inventory Revenue\",\n \"CiclasRowid\": \"AAAX0uAAAAAAw5GAAP\",\n \"CiclasRtrnFlag\": \"N\",\n \"CiclasSalesProductFlag\": \"N\",\n \"CiclasSalesTax1Code\": null,\n \"CiclasSalesTax1Name\": null,\n \"CiclasSalesTax2Code\": null,\n \"CiclasSalesTax2Name\": null,\n \"CiclasSalesTax3Code\": null,\n \"CiclasSalesTax3Name\": null,\n \"CiclasSellPrice\": null,\n \"CiclasSellPriceOrPctCode\": \"P\",\n \"CiclasSerialFlag\": \"N\",\n \"CiclasSoldAtCostAccCode\": \"50600\",\n \"CiclasSoldAtCostAccName\": \"Cost of Goods Sold\",\n \"CiclasSuspAccCode\": \"20010\",\n \"CiclasSuspAccName\": \"Accrued Liabilities\",\n \"CiclasTax1Code\": null,\n \"CiclasTax1Name\": null,\n \"CiclasTax2Code\": null,\n \"CiclasTax2Name\": null,\n \"CiclasTax3Code\": null,\n \"CiclasTax3Name\": null,\n \"CiclasTruckClassCode\": null,\n \"CiclasUsageCode\": \"N\",\n \"CiclasVUuid\": \"D2B734260F483E82E05316821FAC9629\",\n \"CiclasVarAccCode\": \"50720\",\n \"CiclasVarAccName\": \"Inventory Variance- Purchasing\",\n \"CiclasVelocityCode\": null,\n \"CiclasWriAccCode\": \"50700\",\n \"CiclasWriAccName\": \"Inventory Writeoff Expense\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/ci-rest-api/rest/1/ciclass/D2B734260F483E82E05316821FAC9629\",\n \"name\": \"ciclass\",\n \"kind\": \"item\"\n },\n {\n \"rel\": \"canonical\",\n \"href\": \"http://mobtest.cmiccloudr12.co\nm:80/cmictestrti/ci-rest-api/rest/1/ciclass/D2B734260F483E82E05316821FAC9629\",\n \"name\": \"ciclass\",\n \"kind\": \"item\"\n }\n ]\n }\n ],\n \"count\": 2,\n \"hasMore\": false,\n \"limit\": 50,\n \"offset\": 0,\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/ci-rest-api/rest/1/ciclass\",\n \"name\": \"ciclass\",\n \"kind\": \"collection\"\n }\n ]\n}" } } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````