Get Single Equipment Instance

Returns the details of a specific equipment instance and, optionally, the properties. The hierarchy is also returned to allow for duplicate names for equipment instances.

Request Parameters

The following parameter is optional in the request.

ParameterTypeRequiredDescription
returnPropertiesBooleanNIndicates whether to include equipment property details in the response. Valid values are true or false. The default is true.
Note: Where <id> is the unique identifier for the equipment instance.

The following example displays the details for the specified equipment instance, including its properties.

HTTP MethodGET
URLhttps://serverName:port/ProficyWebApi/api/Equipment/<id>
Return ValueReturns the details for the specified equipment instance, including the properties.
Note: The returnProperties parameter is not required when you want to include equipment instance properties in the request.
Sample Response 
{
  "Properties": {
    "Class1-P1": {
      "Description": "",
      "UnitOfMeasure": "",
      "Value": "p1Value",
      "Links": [
        {
          "Rel": "self",
          "Href": "https://sql2014server:8444/ProficyWebApi/api/Equipment/0cb0632b-04c1-4f16-9620-44aaa6e0d0a0?propertyName=Class1-P1"
        }
      ]
    },
    "ColorProperty": {
      "Description": "Color changed to green",
      "UnitOfMeasure": "",
      "Value": "Green",
      "Links": [
        {
          "Rel": "self",
          "Href": "https://sql2014server:8444/ProficyWebApi/api/Equipment/0cb0632b-04c1-4f16-9620-44aaa6e0d0a0?propertyName=ColorProperty"
        }
      ]
    },
    "PropertyInt32": {
      "Description": "",
      "UnitOfMeasure": "",
      "Value": 46,
      "Links": [
        {
          "Rel": "self",
          "Href": "https://sql2014server:8444/ProficyWebApi/api/Equipment/0cb0632b-04c1-4f16-9620-44aaa6e0d0a0?propertyName=PropertyInt32"
        }
      ]
    }
  },
  "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"
    }
  ]
}

The following example displays the details for the specified equipment instance, but does not include its properties.

HTTP MethodGET
URLhttps://serverName:port/ProficyWebApi/api/Equipment/<id>?returnProperties=false
Return ValueReturns the details for the specified equipment instance, excluding the properties.
Sample Response 
{ 
   "Properties": {},
  "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"
    }
  ]
}