Retrieves the equipment_family object with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
key

equipment_family.id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

equipment_family
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier

Required

name

Name of the equipment family (translated)

string

Required

Max length: 50

description

Description of the equipment family

string

Max length: 4000

_parent_id

Parent Equipment Family (Parent / Child)

globally unique identifier
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date

Response Formats

application/json, text/json

Sample:
{
  "id": "a06f2330-24a1-494b-aac9-df08135ba96e",
  "name": "sample string 2",
  "description": "sample string 3",
  "_parent_id": "2e00502b-aaca-41ed-9395-f54a3d7110fd",
  "modified_dateutc": "2026-06-24T04:08:58.7681005+00:00"
}

application/xml, text/xml

Sample:
<equipment_family xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <_parent_id>2e00502b-aaca-41ed-9395-f54a3d7110fd</_parent_id>
  <description>sample string 3</description>
  <id>a06f2330-24a1-494b-aac9-df08135ba96e</id>
  <modified_dateutc>2026-06-24T04:08:58.768Z</modified_dateutc>
  <name>sample string 2</name>
</equipment_family>