API de Tablas Personalizadas

Descripción

La API de Tablas Personalizadas permite crear, leer, actualizar y eliminar datos en tablas definidas por el usuario.

tip

Si trabaja dentro de espacios de trabajo o automatizaciones de Skills Workflow, prefiera usar los métodos del SDK (SW.Document.CustomTable.*) documentados en la Referencia del SDK en lugar de llamar a la API directamente.

---

Todos los endpoints requieren autenticación mediante la cabecera X-AccessToken.

Ruta base: api/v3

Endpoints

Método	Ruta	Descripción
GET	/custom-tables	Lista todas las tablas personalizadas
GET	/custom-tables/{tableName}	Obtiene el esquema de la tabla
GET	/custom-tables/{tableName}/rows/values	Obtiene todas las filas
GET	/custom-tables/{tableName}/row	Obtiene una fila por clave
GET	/custom-tables/{tableName}/rows/columnValue	Obtiene un valor de columna
POST	/custom-tables/{tableName}	Crea la tabla o agrega columnas
PUT	/custom-tables/{tableName}/rows	Inserta o actualiza filas
PUT	/custom-table-definitions/{id}	Actualiza permisos
DELETE	/custom-tables/{tableName}/rows	Elimina filas
DELETE	/custom-tables/{tableName}	Elimina la tabla
GET	/custom-tables/{tableName}/export	Exporta a JSON
PUT	/custom-tables/{tableName}/import	Importa desde JSON

---

Insertar / Actualizar filas

PUT /api/v3/custom-tables/{tableName}/rows

OperationType	Valor	Descripción
Update	0	Actualiza una fila
UpdateMany	1	Inserta o actualiza múltiples filas
UpsertMany	2	Inserta si no existe y actualiza si existe

{
  "OperationType": "UpdateMany",
  "UpdateManyModel": [
    {
      "KeyColumnName": "Oid",
      "KeyValue": "a1b2c3d4-0000-0000-0000-000000000001",
      "KeyDataTypeId": 9,
      "Columns": [
        { "ColumnName": "Name", "Value": "Product A" },
        { "ColumnName": "Category", "Value": "Electronics" }
      ]
    }
  ]
}

---

Eliminar filas

DELETE /api/v3/custom-tables/{tableName}/rows

{
  "OperationType": "Delete",
  "DeleteModel": {
    "KeyColumnName": "Oid",
    "KeyValue": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

---

Leer datos mediante consultas

Al crear consultas SQL en Mantenimiento → Consultas, use CustomTable como namespace. El esquema físico de base de datos es [customtables].

SELECT Oid, Name, Price, IsActive
FROM [customtables].[ProductCatalog]
WHERE IsActive = 1
ORDER BY Name