---
title: NetX Equipment
slug: netx-equipment
description: NetX equipment registry table specification
docTags: 
createdAt: 2026-08-14T16:07:18.730Z
---

The NetX Equipment table is the registry of network equipment. Each piece of equipment owns a set of time series tags (see NetX TimeSeries Configuration). The equipment's **sourceId** must be globally unique.

:::hint{type="warning"}
**Equipment** for a given **sourceId** must be added to the system before attempting to add **TimeSeries Configuration** records referencing that **sourceEquipmentId**.
:::

| **Variable** | **Data Type** | **Is Nullable?** | **Default Value** | **Description**                                                                                                                  |
| ------------ | ------------- | ---------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| sourceId     | String        | No               | -                 | Source ID for the equipment. This sourceId enables upsert functionality from client source systems of record.                    |
| name         | String        | No               | -                 | Equipment name                                                                                                                   |
| description  | String        | Yes              | -                 | Optional equipment description                                                                                                   |
| type         | String        | No               | -                 | Equipment Type:<br /><br />WELL<br />HEAT\_EXCHANGER<br />PIPELINE<br />SOURCE<br />SEPARATOR<br />COMPRESSOR<br />INLINE\_CHOKE |

***

# Data Integrity Checks

| **Condition**                      | **Response**    |
| ---------------------------------- | --------------- |
| sourceId is NULL or Empty          | Record Rejected |
| name is NULL or Empty              | Record Rejected |
| type is not one of the enum values | Record Rejected |

Deleting an equipment record CASCADE DELETES all of its time series configurations and their history.

***

# Common Error Messages

| **API**          | **Scenario**                | **Error Response**                           |
| ---------------- | --------------------------- | -------------------------------------------- |
| Fetch equipment  | Missing or invalid sourceId | Equipment with sourceId "xxx" does not exist |
| Delete equipment | Missing or invalid sourceId | Equipment with sourceId: "xxx" was not found |