Skip to main content
PATCH
Update a workbook calculated field
Change a calculated field of a workbook; only the fields you send are changed. Requires edit access to the workbook.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required
workbookId
number
required
fieldId
string
required

Body

application/json

UpdateCalculatedFieldInput

description
string | null
expression
string | null
format
enum<string> | null
Available options:
percent,
currency,
imageUrl,
id,
link
memberRole
enum<string> | null
Available options:
measure,
dimension
name
string | null
semanticView
string | null
title
string | null
valueType
enum<string> | null
Available options:
string,
time,
boolean,
number,
number_agg,
count,
count_distinct,
count_distinct_approx,
sum,
avg,
min,
max,
geo

Response

200 - application/json
createdAt
required
createdBy
number
required
expression
string
required
id
string
required
memberRole
enum<string>
required
Available options:
measure,
dimension
name
string
required
semanticView
string
required
updatedAt
required
valueType
enum<string>
required
Available options:
string,
time,
boolean,
number,
number_agg,
count,
count_distinct,
count_distinct_approx,
sum,
avg,
min,
max,
geo
description
string | null
format
enum<string> | null
Available options:
percent,
currency,
imageUrl,
id,
link
title
string | null