Retrieve Locations

This operation returns Organizational Map locations. Search data can include query info, date, location set, descendants, parent, ancestors, or children.

You can use this powerful operation to retrieve a variety of location-related data.

Consider the following example. Given an employee's primary job, you can retrieve the location type names for each node of the employee's primary job path. In the following example response, the orgNodeTypeRef is the location type of each node in the path. Refer to the example below for request and response details.

Example Request

{
  "multiReadOptions": {
    "includeOrgPathDetails": true
  },
  "where": {
    "ancestorsOf": {
      "context": "ORG",
      "date": "2022-03-18",
      "locationRef": {
        "qualifier": "Organization/United States/Metropolitan Plant/Machine Shop/Apprentice Welder"
      }
    }
  }
}

Example Response

[
  {
    "nodeId": 63,
    "orgNodeTypeRef": {
      "id": 6,
      "qualifier": "Department"
    },
    "parentNodeRef": {
      "id": 51,
      "qualifier": "Organization/United States/Metropolitan Plant"
    },
    "name": "Machine Shop",
    "fullName": "Machine Shop",
    "description": "Machine Shop",
    "effectiveDate": "1900-01-01",
    "expirationDate": "3000-01-01",
    "firstRevision": true,
    "lastRevision": true,
    "transferable": false,
    "orgPath": "Organization/United States/Metropolitan Plant/Machine Shop",
    "orgPathHierarchy": [
      {
        "id": 1,
        "qualifier": "Organization"
      },
      {
        "id": 2,
        "qualifier": "United States"
      },
      {
        "id": 51,
        "qualifier": "Metropolitan Plant"
      },
      {
        "id": 63,
        "qualifier": "Machine Shop"
      }
    ],
    "contextRef": {
      "id": -1,
      "qualifier": "ORG"
    },
    "persistentId": "f367c0ff-0232-49fe-899e-c568cc4e588f"
  },
  {
    "nodeId": 51,
    "orgNodeTypeRef": {
      "id": 5,
      "qualifier": "Site"
    },
    "parentNodeRef": {
      "id": 2,
      "qualifier": "Organization/United States"
    },
    "name": "Metropolitan Plant",
    "fullName": "Metropolitan Plant",
    "description": "Metropolitan Plant",
    "effectiveDate": "2019-02-09",
    "expirationDate": "3000-01-01",
    "address": "1 innovation Way (Manchester St.) Merrimack, NH 03054",
    "firstRevision": false,
    "lastRevision": true,
    "transferable": false,
    "orgPath": "Organization/United States/Metropolitan Plant",
    "orgPathHierarchy": [
      {
        "id": 1,
        "qualifier": "Organization"
      },
      {
        "id": 2,
        "qualifier": "United States"
      },
      {
        "id": 51,
        "qualifier": "Metropolitan Plant"
      }
    ],
    "contextRef": {
      "id": -1,
      "qualifier": "ORG"
    },
    "persistentId": "f227ca87-e3e3-4600-9c04-c5d5a410f8b5"
  },
  {
    "nodeId": 2,
    "orgNodeTypeRef": {
      "id": 11,
      "qualifier": "Region"
    },
    "parentNodeRef": {
      "id": 1,
      "qualifier": "Organization"
    },
    "name": "United States",
    "fullName": "United States",
    "description": "United States",
    "effectiveDate": "1900-01-01",
    "expirationDate": "3000-01-01",
    "firstRevision": true,
    "lastRevision": true,
    "transferable": false,
    "orgPath": "Organization/United States",
    "orgPathHierarchy": [
      {
        "id": 1,
        "qualifier": "Organization"
      },
      {
        "id": 2,
        "qualifier": "United States"
      }
    ],
    "contextRef": {
      "id": -1,
      "qualifier": "ORG"
    },
    "persistentId": "fa058093-d659-4f1c-a479-3412b86b4ea1"
  },
  {
    "nodeId": 1,
    "orgNodeTypeRef": {
      "id": 4,
      "qualifier": "Company"
    },
    "parentNodeRef": {
      "id": -1,
      "qualifier": "/"
    },
    "name": "Organization",
    "fullName": "Organization",
    "description": "Default",
    "effectiveDate": "1900-01-01",
    "expirationDate": "3000-01-01",
    "firstRevision": true,
    "lastRevision": true,
    "transferable": false,
    "orgPath": "Organization",
    "orgPathHierarchy": [
      {
        "id": 1,
        "qualifier": "Organization"
      }
    ],
    "contextRef": {
      "id": -1,
      "qualifier": "ORG"
    },
    "persistentId": "64658ea9-d6d1-49d6-b757-8a655c2dc433"
  }
]