Tutorials

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...

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...

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...

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...

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...

API Actions CMiC APi support the following methods:

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....

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...

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...

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...

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...

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...

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...

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,...

Introduction CMiC’s Cloud environment (ATLAS and NOVA) have safeguards in place to ensure that all our customers and integration partners can rely on consistent performance when calling our API endpoints. One of these safeguards throttles the numbe...

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...

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...

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...