API Catalog

Retrieve Base Codes By Code

06 Jan 2025
1 Minute to read

Print
Dark
Light

Retrieve Base Codes By Code

Updated on 06 Jan 2025
1 Minute to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/hcm-rest-api/rest/1/pybase

Query Standards

Finder

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

Find By Date
By UUID

Find 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 Base Code

This is an optional finder for querying a specific Base Code by its Base Code.

Parameter	Description	Sample
/BaseCode	The Base Code attribute is the Unique row ID	/hcm-rest-api/rest/1/pybase/:AD&D

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByDate;auditDate=2014-12-20

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExampleBdbBaseCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "BdbBaseCode": "401G",
      "BdbBaseDescription": "401K Max Limit Group",
      "BdbShortDesc": "401K  - Max",
      "BdbBaseType": "D",
      "BdbSysDefinedFlag": "N",
      "BdbUser": "ADWAIT",
      "BdbLastUpdDate": "2015-05-01T14:04:22Z",
      "BdbIuCreateDate": "2015-05-01T14:04:22Z",
      "BdbIuCreateUser": "ADWAIT",
      "BdbIuUpdateDate": null,
      "BdbIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/401G",
          "name": "pybase",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/401G",
          "name": "pybase",
          "kind": "item"
        }
      ]
    },
    {
      "BdbBaseCode": "AD&D",
      "BdbBaseDescription": "Accid Death & Dismemberment",
      "BdbShortDesc": "AD&D",
      "BdbBaseType": "O",
      "BdbSysDefinedFlag": "N",
      "BdbUser": "ADWAIT",
      "BdbLastUpdDate": "2015-05-01T14:04:22Z",
      "BdbIuCreateDate": "2015-05-01T14:04:22Z",
      "BdbIuCreateUser": "ADWAIT",
      "BdbIuUpdateDate": null,
      "BdbIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/AD%26D",
          "name": "pybase",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/AD%26D",
          "name": "pybase",
          "kind": "item"
        }
      ]
    },
    {
      "BdbBaseCode": "BANK",
      "BdbBaseDescription": "Banked Hours",
      "BdbShortDesc": "Bank Hours",
      "BdbBaseType": "L",
      "BdbSysDefinedFlag": "N",
      "BdbUser": "ADWAIT",
      "BdbLastUpdDate": "2015-05-01T14:04:23Z",
      "BdbIuCreateDate": "2015-05-01T14:04:23Z",
      "BdbIuCreateUser": "ADWAIT",
      "BdbIuUpdateDate": null,
      "BdbIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/BANK",
          "name": "pybase",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/BANK",
          "name": "pybase",
          "kind": "item"
        }
      ]
    },
    {
      "BdbBaseCode": "BLIF",
      "BdbBaseDescription": "Basic Life Insurance",
      "BdbShortDesc": "Basic Life Ins",
      "BdbBaseType": "O",
      "BdbSysDefinedFlag": "N",
      "BdbUser": "ADWAIT",
      "BdbLastUpdDate": "2015-05-01T14:04:22Z",
      "BdbIuCreateDate": "2015-05-01T14:04:22Z",
      "BdbIuCreateUser": "ADWAIT",
      "BdbIuUpdateDate": null,
      "BdbIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/BLIF",
          "name": "pybase",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/BLIF",
          "name": "pybase",
          "kind": "item"
        }
      ]
    },
    {
      "BdbBaseCode": "DI",
      "BdbBaseDescription": "Disposable Income",
      "BdbShortDesc": "DI",
      "BdbBaseType": "O",
      "BdbSysDefinedFlag": "N",
      "BdbUser": "ADWAIT",
      "BdbLastUpdDate": "2015-05-01T14:04:22Z",
      "BdbIuCreateDate": "2015-05-01T14:04:22Z",
      "BdbIuCreateUser": "ADWAIT",
      "BdbIuUpdateDate": null,
      "BdbIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/DI",
          "name": "pybase",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase/DI",
          "name": "pybase",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybase",
      "name": "pybase",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve PY Plan Code

Retrieve Base Codes By Code

Query Standards

Finder

Find By Date

By Base Code

What's Next

Contact Us