Passer au contenu principal
PUT
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

dataset
string
requis

La clé du jeu de données : le module, un point et le jeu de données, comme inventory.stock-movements.

field
string | null
requis

L'ID du champ calculé, un UUID. Omettez-le pour ajouter un nouveau champ calculé.

Corps

application/json

Un champ calculé à ajouter à un jeu de données, ou une nouvelle version d'un champ calculé.

key
string
requis

La clé sous laquelle les rapports nomment le champ, en minuscules avec des traits d'union, comme margin-percent. Elle ne peut pas être la clé d'un des champs propres au jeu de données.

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

Le nom affiché au-dessus de la colonne du champ dans un rapport, comme Margin %.

Maximum string length: 120
formula
string
requis

La formule, comme SAFE_DIVIDE(SUM([Margin]), SUM([Revenue])) * 100, avec des champs entre crochets par clé ou par nom.

Maximum string length: 2000

Réponse

CalculatedFieldResource

data
CalculatedFieldResource · object
requis

Une formule que l'organisation a enregistrée sur un jeu de données comme champ calculé. Les rapports l'utilisent par sa clé, comme l'un des champs du jeu de données.