Saltar al contenido principal
PUT
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Parámetros de ruta

dataset
string
requerido

La clave del conjunto de datos: el módulo, un punto y el conjunto de datos, como inventory.stock-movements.

field
string | null
requerido

El ID del campo calculado, un UUID. Omítelo para agregar un campo calculado nuevo.

Cuerpo

application/json

Un campo calculado para agregar a un conjunto de datos, o una versión nueva de uno.

key
string
requerido

La clave con la que los reportes nombran el campo, en minúsculas con guiones, como margin-percent. No puede ser la clave de uno de los campos propios del conjunto de datos.

Pattern: ^[a-z][a-z0-9-]{0,63}$
label
string
requerido

El nombre que se muestra sobre la columna del campo en un reporte, como Margin %.

Maximum string length: 120
formula
string
requerido

La fórmula, como SAFE_DIVIDE(SUM([Margin]), SUM([Revenue])) * 100, con los campos entre corchetes por clave o por nombre.

Maximum string length: 2000

Respuesta

CalculatedFieldResource

data
CalculatedFieldResource · object
requerido

Una fórmula que la organización guardó en un conjunto de datos como campo calculado. Los informes la usan por su clave, como uno de los campos propios del conjunto de datos.