Get Equipment Property by Name

Returns the details of the named property for the specified equipment instance.

Request Parameters

The following parameter must be specified in the request.

ParameterTypeRequiredDescription
propertyNameStringYRetrieves the property with this name.
Note:
  • Where <id> is the unique identifier for the equipment instance.
  • Returns the details (Description, Unit of Measure, Value) of a single property.
HTTP MethodGET
URLhttps://serverName:port/ProficyWebApi/api/Equipment/<id>?propertyName=<property name>
Return ValueReturns the details of the named property for the specified equipment instance.
Sample Response 
{
  "Description": "",
  "UnitOfMeasure": "",
  "Value": "Blue",
  "Links": [
    {
      "Rel": "self",
      "Href": "https://sql2014server:8444/ProficyWebApi/api/Equipment/0cb0632b-04c1-4f16-9620-44aaa6e0d0a0?propertyName=ColorProperty"
    },
    {
      "Rel": "parent",
      "Href": "https://sql2014server:8444/ProficyWebApi/api/Equipment/0cb0632b-04c1-4f16-9620-44aaa6e0d0a0"
    }
  ]
}