API Catalog

Retrieve Vertex Location City

06 Jan 2025
1 Minute to read

Print
Dark
Light

Retrieve Vertex Location City

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/vertexloccity

Query Standards

Finder

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

Find By Date
By ESG Code

Find By Date

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
auditDate	Create or Update Date Time Filter	2014-12-20

By ESG Code

This is an optional finder for querying a specific Security Group by ESG Code.

Parameter	Description	Sample
/ESGCODE	The ESG Code attribute is the Unique row ID	/hcm-rest-api/rest/1/pyempsecgrp/EXEC

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleVertexLocCityFinder;GeostateVar=44,GeocountyVar=61,GeocityVar=133,CompressedCityVar=BAYVIEW,NameCityVar=BAYVIEW,AbbrevCityVar=BAYVIE,ZipCodeStartVar=78566,ZipCodeEndVar=78566,ApofPoindVar=0,CityNameTypeVar=3,UpdFlg=c

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExampleEsgCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "EsgCode": "CONF",
      "EsgName": "Confidential Payroll",
      "EsgIuCreateDate": "2015-05-11T13:13:22Z",
      "EsgIuCreateUser": "ADWAIT",
      "EsgIuUpdateDate": null,
      "EsgIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/CONF",
          "name": "pyempsecgrp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/CONF",
          "name": "pyempsecgrp",
          "kind": "item"
        }
      ]
    },
    {
      "EsgCode": "EXEC",
      "EsgName": "Executive Payroll",
      "EsgIuCreateDate": "2015-05-11T13:13:22Z",
      "EsgIuCreateUser": "ADWAIT",
      "EsgIuUpdateDate": null,
      "EsgIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/EXEC",
          "name": "pyempsecgrp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/EXEC",
          "name": "pyempsecgrp",
          "kind": "item"
        }
      ]
    },
    {
      "EsgCode": "NONE",
      "EsgName": "NONE",
      "EsgIuCreateDate": "2019-05-08T19:49:10Z",
      "EsgIuCreateUser": "CANDICE",
      "EsgIuUpdateDate": null,
      "EsgIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/NONE",
          "name": "pyempsecgrp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/NONE",
          "name": "pyempsecgrp",
          "kind": "item"
        }
      ]
    },
    {
      "EsgCode": "TEST",
      "EsgName": "Test",
      "EsgIuCreateDate": "2023-04-04T16:26:24Z",
      "EsgIuCreateUser": "AGAVE",
      "EsgIuUpdateDate": null,
      "EsgIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/TEST",
          "name": "pyempsecgrp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/TEST",
          "name": "pyempsecgrp",
          "kind": "item"
        }
      ]
    },
    {
      "EsgCode": "WORK",
      "EsgName": "Workato Group",
      "EsgIuCreateDate": "2022-11-02T22:32:22Z",
      "EsgIuCreateUser": "WORKATO",
      "EsgIuUpdateDate": null,
      "EsgIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/WORK",
          "name": "pyempsecgrp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp/WORK",
          "name": "pyempsecgrp",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsecgrp",
      "name": "pyempsecgrp",
      "kind": "collection"
    }
  ]
}

object

What's Next

Create a Check

Retrieve Vertex Location City

Query Standards

Finder

Find By Date

By ESG Code

What's Next

Contact Us