Retrieve Equipment Home Locations By Code

Prev Next
Get
/em-rest-api/rest/1/emhomeloc

Query Standards

Finder

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

  • find by Code
  • find by Date
  • By UUID

Select by Code

Recommended finder parameters. Refer to Query Parameters for example.

Parameter Description Sample
locationCode Location Code 001-CHI

Select by Date

This is an optional finder for Equipment Home Locations by Audit Date.

Parameter Description Sample
AuditDate Create or update date time filter 2022-12-20

By UUID

This is an optional finder for querying a specific Equipment Home Location by row ID.

Parameter Description Sample
/VUUID The VUuid attribute is the Unique row ID /em-rest-api/rest/1/emhomeloc/001-CHI
Security
HTTP
Type basic

Basic authentication

Query parameters
finder
string
ExamplefindByCode;locationCode=001-SF
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleEmhlHomelocCode:desc
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
example-0

Successful Response - Finder - findByDate

{
  "error": "{\n    \"items\": [\n        {\n            \"EmhlHomelocCode\": \"001-CHI\",\n            \"EmhlName\": \"Chicago Yard / Warehouse\",\n            \"EmhlSname\": null,\n            \"EmhlCompCode\": \"001\",\n            \"EmhlCompName\": \"CMiC Construction Inc\",\n            \"EmhlDeptCode\": \"416\",\n            \"EmhlDeptName\": \"Chicago Equip / Whse\",\n            \"EmhlIuCreateDate\": \"2015-05-11T11:03:28-04:00\",\n            \"EmhlIuUpdateDate\": null,\n            \"EmhlErecIncFlag\": \"N\",\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-CHI\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-CHI\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                }\n            ]\n        },\n        {\n            \"EmhlHomelocCode\": \"001-SF\",\n            \"EmhlName\": \"San Francisco Yard / Warehouse\",\n            \"EmhlSname\": null,\n            \"EmhlCompCode\": \"001\",\n            \"EmhlCompName\": \"CMiC Construction Inc\",\n            \"EmhlDeptCode\": \"716\",\n            \"EmhlDeptName\": \"San Francisco Equip / Whse\",\n            \"EmhlIuCreateDate\": \"2015-05-11T11:03:28-04:00\",\n            \"EmhlIuUpdateDate\": null,\n            \"EmhlErecIncFlag\": \"N\",\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-SF\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-SF\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                }\n            ]\n        },\n        {\n            \"EmhlHomelocCode\": \"001-EXT\",\n            \"EmhlName\": \"External Customers\",\n            \"EmhlSname\": null,\n            \"EmhlCompCode\": \"001\",\n            \"EmhlCompName\": \"CMiC Construction Inc\",\n            \"EmhlDeptCode\": \"080\",\n            \"EmhlDeptName\": \"Support Services\",\n            \"EmhlIuCreateDate\": \"2015-05-11T11:03:28-04:00\",\n            \"EmhlIuUpdateDate\": null,\n            \"EmhlErecIncFlag\": \"N\",\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-EXT\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-EXT\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                }\n            ]\n        },\n        {\n            \"EmhlHomelocCode\": \"HIKUU- YRD\",\n            \"EmhlName\": \"Company HIKUU Yard / Warehouse\",\n            \"EmhlSname\": null,\n            \"EmhlCompCode\": \"HIKUU\",\n            \"EmhlCompName\": \"CMiC Construction Canada Ltd.\",\n            \"EmhlDeptCode\": \"056\",\n            \"EmhlDeptName\": \"Equipment/Warehouse Operations\",\n            \"EmhlIuCreateDate\": \"2015-05-11T11:03:28-04:00\",\n            \"EmhlIuUpdateDate\": null,\n            \"EmhlErecIncFlag\": \"N\",\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-\nrest-api/rest/1/emhomeloc/HIKUU-%20YRD\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/HIKUU-%20YRD\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                }\n            ]\n        },\n        {\n            \"EmhlHomelocCode\": \"002-YARD\",\n            \"EmhlName\": \"Company 002 Yard / Warehouse\",\n            \"EmhlSname\": null,\n            \"EmhlCompCode\": \"002\",\n            \"EmhlCompName\": \"Fresenius Medical Care\",\n            \"EmhlDeptCode\": \"056\",\n            \"EmhlDeptName\": \"Equipment/Warehouse Operations\",\n            \"EmhlIuCreateDate\": \"2015-05-11T11:03:28-04:00\",\n            \"EmhlIuUpdateDate\": null,\n            \"EmhlErecIncFlag\": \"N\",\n            \"links\": [\n                {\n                    \"rel\": \"self\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/002-YARD\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                },\n                {\n                    \"rel\": \"canonical\",\n                    \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/002-YARD\",\n                    \"name\": \"emhomeloc\",\n                    \"kind\": \"item\"\n                }\n            ]\n        }\n    ],\n    \"count\": 5,\n    \"hasMore\": true,\n    \"limit\": 5,\n    \"offset\": 0,\n    \"links\": [\n        {\n            \"rel\": \"self\",\n            \"href\": \"http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc\",\n            \"name\": \"emhomeloc\",\n            \"kind\": \"collection\"\n        }\n    ]\n}"
}
example-1

Successful Response - Finder - findByCode

{
  "items": [
    {
      "EmhlHomelocCode": "001-SF",
      "EmhlName": "San Francisco Yard / Warehouse",
      "EmhlSname": null,
      "EmhlCompCode": "001",
      "EmhlCompName": "CMiC Construction Inc",
      "EmhlDeptCode": "716",
      "EmhlDeptName": "San Francisco Equip / Whse",
      "EmhlIuCreateDate": "2015-05-11T11:03:28-04:00",
      "EmhlIuUpdateDate": null,
      "EmhlErecIncFlag": "N",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-SF",
          "name": "emhomeloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-SF",
          "name": "emhomeloc",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc",
      "name": "emhomeloc",
      "kind": "collection"
    }
  ]
}
object
Copyright © 2024 CMiC All Rights Reserved