API Catalog

Retrieve PY Plan Code

06 Jan 2025
1 Minute to read

Print
Dark
Light

Retrieve PY Plan 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/pyplan

Query Standards

Finder

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

Find By Date
By Plan Code

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 Plan Code

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

Parameter	Description	Sample
/PlnCode	The Plan Code attribute is the Unique row ID	/hcm-rest-api/rest/1/pyplan/401K

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByDate;auditDate=2015-01-06

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExamplePlnCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "PlnCode": "401K",
      "PlnDescription": "401K",
      "PlnShortDesc": "401K",
      "PlnUser": "ADWAIT",
      "PlnLastUpdDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateUser": "ADWAIT",
      "PlnIuUpdateDate": null,
      "PlnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/401K",
          "name": "pyplan",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/401K",
          "name": "pyplan",
          "kind": "item"
        }
      ]
    },
    {
      "PlnCode": "CHILD",
      "PlnDescription": "Employee and Child",
      "PlnShortDesc": "Child",
      "PlnUser": "ADWAIT",
      "PlnLastUpdDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateUser": "ADWAIT",
      "PlnIuUpdateDate": null,
      "PlnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/CHILD",
          "name": "pyplan",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/CHILD",
          "name": "pyplan",
          "kind": "item"
        }
      ]
    },
    {
      "PlnCode": "DEFAULT",
      "PlnDescription": "DEFAULT PLAN",
      "PlnShortDesc": "DEFAULT PLAN",
      "PlnUser": "ADWAIT",
      "PlnLastUpdDate": "2015-05-04T18:09:05Z",
      "PlnIuCreateDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateUser": "ADWAIT",
      "PlnIuUpdateDate": null,
      "PlnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/DEFAULT",
          "name": "pyplan",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/DEFAULT",
          "name": "pyplan",
          "kind": "item"
        }
      ]
    },
    {
      "PlnCode": "EXEC",
      "PlnDescription": "Executives",
      "PlnShortDesc": "Execs",
      "PlnUser": "ADWAIT",
      "PlnLastUpdDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateUser": "ADWAIT",
      "PlnIuUpdateDate": null,
      "PlnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/EXEC",
          "name": "pyplan",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/EXEC",
          "name": "pyplan",
          "kind": "item"
        }
      ]
    },
    {
      "PlnCode": "FAMILY",
      "PlnDescription": "Employee and Family",
      "PlnShortDesc": "Family",
      "PlnUser": "ADWAIT",
      "PlnLastUpdDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateDate": "2015-05-04T18:09:06Z",
      "PlnIuCreateUser": "ADWAIT",
      "PlnIuUpdateDate": null,
      "PlnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/FAMILY",
          "name": "pyplan",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplan/FAMILY",
          "name": "pyplan",
          "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/pyplan",
      "name": "pyplan",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve PY Plan Options By Code

Retrieve PY Plan Code

Query Standards

Finder

Find By Date

By Plan Code

What's Next

Contact Us