Tutorials

Prev Next
  • Updated on Aug 17, 2026
  • Published on Aug 17, 2026
Summary Starting with Nexus 3, CMiC will verify that a non-empty, non-null value VUuid value that's submitted matches the new standard dashed hexadecimal format. What's Changing Beginning with Nexus 3, CMiC will verify that any third-party-sup...
  • Updated on Jul 4, 2025
  • Published on Jul 4, 2025
Introduction This document outlines important enhancements introduced with Oracle's ADF Business Components (ADF BC) REST Framework 3 and 4, starting from JDeveloper release 12.2.1.2.0. It is designed to assist users in understanding new features,...
  • Updated on Oct 16, 2025
  • Published on Oct 7, 2025
Introduction Effective Nexus 1, CMiC has introduced centralized error handling across all APIs. This ensures every API response follows a consistent, structured JSON format, making errors easier to trace, debug, and handle across all services. E...
  • Updated on Jun 3, 2026
  • Published on Jun 2, 2026
Overview To ensure consistent performance and reliability across all environments, CMiC APIs enforce a global batch size limit on all requests that include a batch payload. Batch Size Limit Effective Nexus 2, all requests with a batch payload ...
  • Updated on Nov 17, 2025
  • Published on Sep 30, 2025
Introduction: To ensure the highest level of data compliance, CMiC applies application-level security across all endpoints. This ensures that API responses respect company, job, project, payroll, and employee relevant security rules, protecting se...
  • Published on Apr 22, 2025
Introduction To ensure optimal performance, reliability, and alignment with industry best practices, CMiC is introducing a global API request record limit beginning with Patch 22. Starting with Patch 22, all API requests will enforce a maxim...
  • Updated on Nov 12, 2025
  • Published on Nov 11, 2025
Introduction As part of our ongoing efforts to stabilize the cloud multi-tenant environments and improve user response times, we’ve introduced a new 1-minute timeout limit for requests that reach the database. This change helps keep the system bal...
  • Updated on Mar 25, 2025
  • Published on Oct 18, 2024
CMiC APIs are structured within API programs. Each API has a governing API program the determines which application the API rolls-up to. API Programs are used as a structural frame across various functions: API builds API Security API Lice...
  • Published on Feb 16, 2024
API Actions CMiC APi support the following methods:
  • Published on Feb 16, 2024
CMiC JSON API url formatting The url format for the actions list above are as follows. Please note the url terms definitions https://hostname.com/hostdomain/[ applicationname ]/rest/[ version ]/[ resource ] GET and POST https://hostname....
  • Updated on Oct 18, 2024
  • Published on Feb 16, 2024
Using /describe Adding "/describe" is a helpful way to extract essential information about a specific endpoint. For instance, if one takes the endpoint "/hcm-rest-api/rest/1/pyemployee," appending "/describe" to it as "/hcm-rest-api/rest/1/pyemplo...
  • Updated on Oct 10, 2024
  • Published on Oct 10, 2024
Audit Date (create and/or update date) Parameter In some cases, there may be a need to continually query newly or updated rows from CMiC. This is when an Audit Date must be utilized. An initial query is completed to retrieve all rows using the q...
  • Updated on Sep 15, 2025
  • Published on Mar 25, 2025
Introduction CMIC’ s REST platform supports execution of multiple operations in a single batch request. The platform commits data at the end of the request, so that if one batch request fails all changes are rolled back and an error response is re...
  • Updated on Dec 16, 2025
  • Published on Dec 11, 2025
Introduction Starting from Nexus 1, a new sorting query parameter will be available to simplify sorting behaviour and ensure consistent pagination results across CMiC APIs. When applied, this parameter automatically uses the default sort order def...
  • Updated on Dec 16, 2025
  • Published on Feb 16, 2024
The following is a list of parameters offered by CMiC to help filter, sort and order data queried. It is strongly recommend by CMiC developers to leverage all four parameters when making GET requests to our API endpoints. CMiC API Oracle ADF BC F...
  • Updated on Jun 17, 2026
  • Published on Jun 17, 2026
Feature Description The expand query parameter instructs the ADF BC REST framework to inline child resource data directly within the parent response payload. By default, a GET request returns child resources as navigational links only. Using ?expa...
  • Updated on Nov 4, 2024
  • Published on Feb 16, 2024
Introduction When querying data, finders can be a useful tool. However, finders are pre-built tools created by developers, and while they offer excellent user-friendliness, they can have limitations. Oracle ADF BC framework offers an alternative c...
  • Updated on May 4, 2026
  • Published on May 15, 2024
Introduction CMiC’s Cloud environment includes safeguards to ensure consistent performance and fair usage across users. These safeguards manage how API requests are processed to prevent traffic spikes and maintain stable system performance under v...
  • Updated on Oct 11, 2024
  • Published on Jun 10, 2024
CMiC is excited to announce the release of webhooks in Patch 20. CMiC Webhooks automate event-based messaging from CMiC’s web application to a recipient platform when a create, update, or delete action occurs. This means CMiC can send data immediate...
  • Updated on Nov 27, 2024
  • Published on Mar 13, 2024
In CMiC, an object models the structure of an application program and it's behaviour. System-level programs are the connecting tissue with application programs using object types. These object types are used by CMiC API's to exchange data between sy...
  • Updated on Apr 9, 2026
  • Published on Mar 13, 2024
Object tables in CMiC are database tables that store rows of records. Each column corresponds to an attribute of an Object Type and represents how the data is stored in that object. The keys on a Object table are uniquely identifiable data sets th...
  • Updated on May 27, 2026
  • Published on May 27, 2026
Introduction Effective as of Patch 22, CMiC APIs support an optional request tracking mechanism via the x-api-request-id HTTP header. The x-api-request-id HTTP header is used to track a disrupted request made to CMiC due to connectivity issues. ...
Copyright © 2024 CMiC All Rights Reserved