Retrieves the equipment family with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The equipment family id.

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the equipment family, or 404 Not Found if it doesn't exist.

equipment_family
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier

Required
name

Name of the equipment family

 string

Required

Max length: 50
_parent_id

Parent Equipment Family (Parent / Child) when adding/updating equipment_family

 globally unique identifier
sales_organization_id

FK of sales_organization. Filled if specific of one SO, empty if can be used by all

 globally unique identifier
archived

Indicates whether this equipment family has been archived (no longer selectable).

 boolean
modified_dateutc

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

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "1b6dd189-95d8-4b34-aaf9-618db2a0679c",
  "name": "sample string 2",
  "_parent_id": "ff076168-c3c4-4757-a690-61700b66f5b4",
  "sales_organization_id": "93a7bd91-2030-4f04-a8ff-5769945cf05a",
  "archived": true,
  "modified_dateutc": "2026-11-12T14:29:14.41691+00:00"
}

application/xml, text/xml

Sample: 
<equipment_family xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <_parent_id>ff076168-c3c4-4757-a690-61700b66f5b4</_parent_id>
  <archived>true</archived>
  <id>1b6dd189-95d8-4b34-aaf9-618db2a0679c</id>
  <modified_dateutc>2026-11-12T14:29:14.416Z</modified_dateutc>
  <name>sample string 2</name>
  <sales_organization_id>93a7bd91-2030-4f04-a8ff-5769945cf05a</sales_organization_id>
</equipment_family>