API Catalog

Retrieve Equipment Actual Locations By Code

25 Sep 2024
2 Minutes to read

Print
Dark
Light

Retrieve Equipment Actual Locations By Code

Updated on 25 Sep 2024
2 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/em-rest-api/rest/1/emactloc

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 querying Equipment Actual 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 Actual Location by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/em-rest-api/rest/1/emactloc/001-CHI

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByCode; locationCode=001-CHI

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleEmalActuallocCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - findByDate

{
  "items": [
    {
      "EmalActuallocCode": "032017",
      "EmalName": "HWY 47",
      "EmalSname": null,
      "EmalDefaultCompCode": "HIKUU",
      "EmalDefaultCompName": "CMiC Construction Canada Ltd.",
      "EmalDefaultJobCode": "032017",
      "EmalDefaultJobName": null,
      "EmalDefaultPhsCode": null,
      "EmalDefaultPhsName": null,
      "EmalDefaultCatCode": null,
      "EmalDefaultCatName": null,
      "EmalDefaultCustCode": "CITYOFED",
      "EmalDefaultCustName": "City of Edmonton",
      "EmalStatusFlag": "Y",
      "EmalRetireFlag": "N",
      "EmalExcldTargetUtilCalc": "N",
      "EmalIuCreateDate": "2017-02-06T04:31:27Z",
      "EmalIuUpdateDate": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/032017",
          "name": "emactloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/032017",
          "name": "emactloc",
          "kind": "item"
        }
      ]
    },
    {
      "EmalActuallocCode": "042016",
      "EmalName": "HWY 407",
      "EmalSname": null,
      "EmalDefaultCompCode": "001",
      "EmalDefaultCompName": "CMiC Construction Inc",
      "EmalDefaultJobCode": "042016",
      "EmalDefaultJobName": "CMiC Cloud Prod (July)",
      "EmalDefaultPhsCode": null,
      "EmalDefaultPhsName": null,
      "EmalDefaultCatCode": null,
      "EmalDefaultCatName": null,
      "EmalDefaultCustCode": "46001",
      "EmalDefaultCustName": "City of La Verne",
      "EmalStatusFlag": "Y",
      "EmalRetireFlag": "N",
      "EmalExcldTargetUtilCalc": "N",
      "EmalIuCreateDate": "2016-10-27T02:47:20Z",
      "EmalIuUpdateDate": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/042016",
          "name": "emactloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/042016",
          "name": "emactloc",
          "kind": "item"
        }
      ]
    },
    {
      "EmalActuallocCode": "2016-05-01T12:00:00Z",
      "EmalName": "33 Wells Road",
      "EmalSname": null,
      "EmalDefaultCompCode": "001",
      "EmalDefaultCompName": "CMiC Construction Inc",
      "EmalDefaultJobCode": "2016-05-01T12:00:00Z",
      "EmalDefaultJobName": "32 Wells Street",
      "EmalDefaultPhsCode": null,
      "EmalDefaultPhsName": null,
      "EmalDefaultCatCode": null,
      "EmalDefaultCatName": null,
      "EmalDefaultCustCode": "0588-11-01T12:00:00Z",
      "EmalDefaultCustName": "Minto Group Ltd",
      "EmalStatusFlag": "Y",
      "EmalRetireFlag": "N",
      "EmalExcldTargetUtilCalc": "N",
      "EmalIuCreateDate": "2016-08-18T01:06:56Z",
      "EmalIuUpdateDate": "2016-10-27T02:47:31Z",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/05-2016",
          "name": "emactloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/05-2016",
          "name": "emactloc",
          "kind": "item"
        }
      ]
    },
    {
      "EmalActuallocCode": "051188",
      "EmalName": "58 Bankers Hill",
      "EmalSname": null,
      "EmalDefaultCompCode": "001",
      "EmalDefaultCompName": "CMiC Construction Inc",
      "EmalDefaultJobCode": "051188",
      "EmalDefaultJobName": "58 Bankers Hill Renovations",
      "EmalDefaultPhsCode": null,
      "EmalDefaultPhsName": null,
      "EmalDefaultCatCode": null,
      "EmalDefaultCatName": null,
      "EmalDefaultCustCode": "0588-11-01T12:00:00Z",
      "EmalDefaultCustName": "Minto Group Ltd",
      "EmalStatusFlag": "Y",
      "EmalRetireFlag": "N",
      "EmalExcldTargetUtilCalc": "N",
      "EmalIuCreateDate": "2016-10-26T05:36:41Z",
      "EmalIuUpdateDate": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/051188",
          "name": "emactloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/051188",
          "name": "emactloc",
          "kind": "item"
        }
      ]
    },
    {
      "EmalActuallocCode": "072016",
      "EmalName": "Hilton Hotel",
      "EmalSname": null,
      "EmalDefaultCompCode": "002",
      "EmalDefaultCompName": "Fresenius Medical Care",
      "EmalDefaultJobCode": "072016",
      "EmalDefaultJobName": null,
      "EmalDefaultPhsCode": null,
      "EmalDefaultPhsName": null,
      "EmalDefaultCatCode": null,
      "EmalDefaultCatName": null,
      "EmalDefaultCustCode": "HHO001",
      "EmalDefaultCustName": "Hilton Hotels Inc.",
      "EmalStatusFlag": "Y",
      "EmalRetireFlag": "N",
      "EmalExcldTargetUtilCalc": "N",
      "EmalIuCreateDate": "2016-10-26T05:36:41Z",
      "EmalIuUpdateDate": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/072016",
          "name": "emactloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/072016",
          "name": "emactloc",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc",
      "name": "emactloc",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - findByCode

{
  "items": [
    {
      "EmalActuallocCode": "001-CHI",
      "EmalName": "Chicago Yard / Warehouse",
      "EmalSname": null,
      "EmalDefaultCompCode": "001",
      "EmalDefaultCompName": "CMiC Construction Inc",
      "EmalDefaultJobCode": "2016-05-01T12:00:00Z",
      "EmalDefaultJobName": "32 Wells Street",
      "EmalDefaultPhsCode": "00750",
      "EmalDefaultPhsName": "Permits",
      "EmalDefaultCatCode": "O",
      "EmalDefaultCatName": "Other",
      "EmalDefaultCustCode": "0588-11-01T12:00:00Z",
      "EmalDefaultCustName": "Minto Group Ltd",
      "EmalStatusFlag": "Y",
      "EmalRetireFlag": "N",
      "EmalExcldTargetUtilCalc": "N",
      "EmalIuCreateDate": "2023-08-18T02:29:34Z",
      "EmalIuUpdateDate": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/001-CHI",
          "name": "emactloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emactloc/001-CHI",
          "name": "emactloc",
          "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/emactloc",
      "name": "emactloc",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve Equipment Classes By Code

Retrieve Equipment Actual Locations By Code

Query Standards

Finder

Select by Code

Select by Date

By UUID

What's Next

Contact Us