Data Types Catalog

Overview

The Data Types catalog defines how to interpret and validate configuration values in the Invernaderos system. Each data type specifies validation rules, regex patterns, and display properties for settings configuration. Supported Types: INTEGER, LONG, DOUBLE, BOOLEAN, STRING, DATE, TIME, DATETIME, JSON

Get All Data Types

curl -X GET "https://api.invernaderos.com/api/v1/catalog/data-types" \
  -H "Authorization: Bearer YOUR_TOKEN"

Retrieves all data types ordered by display order.

Response

data

array

Array of data type objects

Show DataTypeResponse

short

required

Unique identifier

name

string

required

Type name (e.g., “INTEGER”, “BOOLEAN”, “STRING”)

description

string

Description of the data type

validationRegex

string

Regular expression for value validation

exampleValue

string

Example of a valid value

displayOrder

short

required

Sort order for UI display

isActive

boolean

required

Whether the data type is active

[
  {
    "id": 1,
    "name": "INTEGER",
    "description": "Whole number (32-bit)",
    "validationRegex": "^-?\\d+$",
    "exampleValue": "25",
    "displayOrder": 1,
    "isActive": true
  },
  {
    "id": 2,
    "name": "DOUBLE",
    "description": "Decimal number (64-bit)",
    "validationRegex": "^-?\\d+(\\.\\d+)?$",
    "exampleValue": "25.5",
    "displayOrder": 2,
    "isActive": true
  },
  {
    "id": 3,
    "name": "BOOLEAN",
    "description": "True/false value",
    "validationRegex": "^(true|false|1|0)$",
    "exampleValue": "true",
    "displayOrder": 3,
    "isActive": true
  }
]

Get Active Data Types

curl -X GET "https://api.invernaderos.com/api/v1/catalog/data-types/active" \
  -H "Authorization: Bearer YOUR_TOKEN"

Retrieves only active data types (where isActive = true).

Response

Same structure as “Get All Data Types”, but filtered to active types only.

Get Data Type by ID

curl -X GET "https://api.invernaderos.com/api/v1/catalog/data-types/1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

short

required

Data type ID

Response

{
  "id": 1,
  "name": "INTEGER",
  "description": "Whole number (32-bit)",
  "validationRegex": "^-?\\d+$",
  "exampleValue": "25",
  "displayOrder": 1,
  "isActive": true
}

Get Data Type by Name

curl -X GET "https://api.invernaderos.com/api/v1/catalog/data-types/name/INTEGER" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

name

string

required

Data type name (case-insensitive, e.g., “INTEGER”, “BOOLEAN”)

Response

Same structure as “Get Data Type by ID”.

Validate Value

curl -X GET "https://api.invernaderos.com/api/v1/catalog/data-types/1/validate?value=25" \
  -H "Authorization: Bearer YOUR_TOKEN"

Validates whether a value is valid for a specific data type.

Path Parameters

short

required

Data type ID

Query Parameters

value

string

required

Value to validate

Response

{
  "dataTypeId": 1,
  "value": "25",
  "isValid": true
}

Validation Rules

Built-in Validation Rules

Data Type	Validation Logic	Examples
INTEGER	Must parse as 32-bit integer	`25`, `-100`, `0`
LONG	Must parse as 64-bit integer	`1234567890`, `-999`
DOUBLE	Must parse as decimal number	`25.5`, `-10.75`, `0.0`
BOOLEAN	Must be “true”, “false”, “1”, or “0”	`true`, `false`, `1`, `0`
STRING	Any string is valid	`"hello"`, `"123"`, `""`
DATE	Must parse as ISO-8601 date	`2025-03-15`
TIME	Must parse as ISO-8601 time	`14:30:00`, `09:15:30`
DATETIME	Must parse as ISO-8601 datetime	`2025-03-15T14:30:00`
JSON	Must start with `{` or `[` and end with `}` or `]`	`{"key": "value"}`, `[1, 2, 3]`
Custom	Uses `validationRegex` if defined	Regex pattern dependent

Create Data Type

curl -X POST "https://api.invernaderos.com/api/v1/catalog/data-types" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "PERCENTAGE",
    "description": "Value between 0-100",
    "validationRegex": "^(100|[1-9]?[0-9])$",
    "exampleValue": "75",
    "displayOrder": 10,
    "isActive": true
  }'

Request Body

name

string

required

Type name (max 20 characters, will be converted to uppercase, must be unique)

description

string

Description of the data type

validationRegex

string

Regular expression for value validation (must be valid regex)

exampleValue

string

Example of a valid value

displayOrder

short

default:"0"

Sort order for UI display (minimum 0)

isActive

boolean

default:"true"

Whether the data type is active

Response

{
  "id": 10,
  "name": "PERCENTAGE",
  "description": "Value between 0-100",
  "validationRegex": "^(100|[1-9]?[0-9])$",
  "exampleValue": "75",
  "displayOrder": 10,
  "isActive": true
}

Update Data Type

curl -X PUT "https://api.invernaderos.com/api/v1/catalog/data-types/10" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Value between 0-100 with decimals",
    "validationRegex": "^(100|[1-9]?[0-9])(\\.[0-9]+)?$",
    "exampleValue": "75.5"
  }'

Path Parameters

short

required

Data type ID to update

Request Body

All fields are optional. Only provided fields will be updated.

name

string

New type name (max 20 characters, will be converted to uppercase)

description

string

New description

validationRegex

string

New validation regex (must be valid)

exampleValue

string

New example value

displayOrder

short

New display order (minimum 0)

isActive

boolean

New active status

Response

{
  "id": 10,
  "name": "PERCENTAGE",
  "description": "Value between 0-100 with decimals",
  "validationRegex": "^(100|[1-9]?[0-9])(\\.[0-9]+)?$",
  "exampleValue": "75.5",
  "displayOrder": 10,
  "isActive": true
}

Delete Data Type

curl -X DELETE "https://api.invernaderos.com/api/v1/catalog/data-types/10" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

short

required

Data type ID to delete

Response

Data type deleted successfully (no body)

System Data Types (IDs 1-9) Cannot Be DeletedThe first 9 data types are core system types and are protected from deletion:

INTEGER, LONG, DOUBLE, BOOLEAN, STRING, DATE, TIME, DATETIME, JSON

Attempting to delete these will result in a 409 Conflict error.

Active/Inactive Filtering

Data types can be marked as inactive without deletion. This allows you to:

Soft delete deprecated types without losing historical data
Hide unused types from UI dropdowns
Preserve validation rules for existing configurations

Use Cases

Filter Active Only
Get All Types
Deactivate Type

GET /api/v1/catalog/data-types/active

Returns only types where isActive = true.Use this for: Populating dropdowns in configuration UIs.

GET /api/v1/catalog/data-types

Returns all types regardless of active status.Use this for: Admin interfaces, historical data analysis.

PUT /api/v1/catalog/data-types/{id}
{
  "isActive": false
}

Soft deletes the type without removing validation rules.

Integration Examples

// Validate a setting value before saving
const validateSetting = async (dataTypeId, value) => {
  const response = await fetch(
    `https://api.invernaderos.com/api/v1/catalog/data-types/${dataTypeId}/validate?value=${encodeURIComponent(value)}`,
    {
      headers: { 'Authorization': `Bearer ${token}` }
    }
  );
  
  const result = await response.json();
  
  if (!result.isValid) {
    throw new Error(`Invalid value "${value}" for data type ${dataTypeId}`);
  }
  
  return true;
};

// Usage
await validateSetting(1, "25");        // Valid INTEGER
await validateSetting(1, "not-a-number"); // Throws error

Error Codes

Status Code	Description	Resolution
200 OK	Request successful	-
201 Created	Data type created successfully	-
204 No Content	Data type deleted successfully	-
400 Bad Request	Invalid input (duplicate name, invalid regex, validation error)	Check error message for details
404 Not Found	Data type not found with specified ID or name	Verify the ID/name exists
409 Conflict	Cannot delete system data type (IDs 1-9)	Use inactive status instead of deletion

Best Practices

Custom Data Types

When creating custom data types:

Use descriptive names (e.g., PERCENTAGE, PHONE_NUMBER, EMAIL)
Provide validation regex for strict input validation
Include example values to guide users
Set appropriate display order to group related types

Example:

{
  "name": "EMAIL",
  "description": "Valid email address",
  "validationRegex": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
  "exampleValue": "[email protected]",
  "displayOrder": 15,
  "isActive": true
}

Validation Performance

Cache active data types on client side to reduce API calls
Validate on client first before sending to /validate endpoint
Use regex validation for custom types to maintain consistency
Batch validate multiple values if possible (client-side cache)

Soft Deletes vs Hard Deletes

Prefer soft deletes (isActive = false) to preserve historical data
Only hard delete truly unused custom types
Never delete system types (IDs 1-9 are protected)
Document deprecation in the description field before deactivating

Authentication

Tenant Management

Sensor Data

MQTT

Catalogs

Additional Endpoints

Overview

Get All Data Types

Response

Get Active Data Types

Response

Get Data Type by ID

Path Parameters

Response

Get Data Type by Name

Path Parameters

Response

Validate Value

Path Parameters

Query Parameters

Response

Validation Rules

Create Data Type

Request Body

Response

Update Data Type

Path Parameters

Request Body

Response

Delete Data Type

Path Parameters

Response

Active/Inactive Filtering

Use Cases

Integration Examples

Error Codes

Best Practices

Build docs developers (and LLMs) love

Authentication

Tenant Management

Sensor Data

MQTT

Catalogs

Additional Endpoints

​Overview

​Get All Data Types

​Response

​Get Active Data Types

​Response

​Get Data Type by ID

​Path Parameters

​Response

​Get Data Type by Name

​Path Parameters

​Response

​Validate Value

​Path Parameters

​Query Parameters

​Response

​Validation Rules

​Create Data Type

​Request Body

​Response

​Update Data Type

​Path Parameters

​Request Body

​Response

​Delete Data Type

​Path Parameters

​Response

​Active/Inactive Filtering

​Use Cases

​Integration Examples

​Error Codes

​Best Practices

Build docs developers (and LLMs) love

Overview

Get All Data Types

Response

Get Active Data Types

Response

Get Data Type by ID

Path Parameters

Response

Get Data Type by Name

Path Parameters

Response

Validate Value

Path Parameters

Query Parameters

Response

Validation Rules

Create Data Type

Request Body

Response

Update Data Type

Path Parameters

Request Body

Response

Delete Data Type

Path Parameters

Response

Active/Inactive Filtering

Use Cases

Integration Examples

Error Codes

Best Practices