Get Equipment Instances

Returns a list of equipment instances that matches the provided criteria. The hierarchy is also returned to allow for duplicate names for equipment instances.

Request Parameters

At least one of the following parameters must be specified in the request.

ParameterTypeRequiredDescription
equipmentNameStringY/NRetrieve equipment instances with this display name.
classNameStringY/NRetrieve equipment instances that are associated with this equipment class.

The following example displays all equipment instances with the specified display name.

HTTP MethodGET
URLhttps://serverName:port/ProficyWebApi/api/Equipment?equipmentName=<display name>
Return ValueReturns all equipment instances with the specified equipment name.
Sample Response 
{
    {
    "Id": "0cb0632b-04c1-4f16-9620-44aaa6e0d0a0",
    "Name": "Area1",
    "Description": "",
    "Hierarchy": "Enterprise/Site/Area1",
    "Classes": [
      "Class1",
      "Class2"
    ],
    "Links": [
      {
        "Rel": "self",
        "Href": "https://sql2014server:8444/ProficyWebApi/api/Equipment/0cb0632b-04c1-4f16-9620-44aaa6e0d0a0"
      }
    ]
  },
  {
    "Id": "fcbae6fd-36df-4997-88e5-4a39eddc760c",
    "Name": "Area1",
    "Description": "in Enterprise2",
    "Hierarchy": "Enteprise2/Site/Area1",
    "Classes": [],
    "Links": [
      {
        "Rel": "self",
        "Href": "https://sql2014server:8444/ProficyWebApi/api/Equipment/fcbae6fd-36df-4997-88e5-4a39eddc760c"
      }
    ]
  }
}

The following example displays all equipment instances with the specified display name and that are associated with the specified class name.

HTTP MethodGET
URLhttps://serverName:port/ProficyWebApi/api/Equipment?equipmentName=<display name>&className=<equipment class>
Return ValueReturns all equipment instances with the specified equipment name and class name.
Sample Response 
[
  {
    "Id": "0cb0632b-04c1-4f16-9620-44aaa6e0d0a0",
    "Name": "Area1",
    "Description": "",
    "Hierarchy": "Enterprise/Site/Area1",
    "Classes": [
      "Class1",
      "Class2"
    ],
    "Links": [
      {
        "Rel": "self",
        "Href": "https://sql2014server:8444/ProficyWebApi/api/Equipment/0cb0632b-04c1-4f16-9620-44aaa6e0d0a0"
      }
    ]
  }
]