What's New
Patch 19-2
Patch 20-2
Contents
x
Overview
Tutorials
Guides
Popular Off-the-Shelf Recipes
Powered by
Tutorials
11 Articles
in this category
Print
Dark
Light
Contents
Tutorials
11 Articles
in this category
Dark
Light
Best Practice | API Application Programs
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...
Updated on : 18 Oct 2024
Best Practice | Available Actions
API Actions CMiC APi support the following methods:
Updated on : 16 Feb 2024
Best Practice | URL Format
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 : 16 Feb 2024
Best Practice | Endpoint Introspection
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 : 18 Oct 2024
Best Practice | Polling data with Audit Date Parameter
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 : 10 Oct 2024
Best Practice | Data Filtering requirements
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 : 10 Oct 2024
Best Practice | Oracle ADF BC 'q' Parameter
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 : 04 Nov 2024
Best Practice | API Request Throttling
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...
Updated on : 15 May 2024
Best Practice | Webhooks
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 : 11 Oct 2024
Best Practice | Object Types Table
In CMiC, an object models the structure of a application program and it's behaviour. System-level programs are joined with application programs using object types. These object types are then used by CMiC API's to connect system- level objects like ...
Updated on : 18 Oct 2024
Best Practice | Object Key Tables
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 : 18 Oct 2024