Quantity.update¶
Update team-owned quantity fields.
Server: PATCH /api/foundry/quantities/{id}/.
Signature¶
update(**kwargs: Any) -> None
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
quantity_id |
path |
string |
yes | - |
Fields¶
Schema: QuantityUpdateSchema
| Field | Type | Required |
|---|---|---|
canonical_unit |
string |
no |
code |
string |
no |
default_scale |
string |
no |
is_complex |
boolean |
no |
physical_kind |
string |
no |
status |
string |
no |
synonyms |
array<object> |
no |
title |
string |
no |
Return shape¶
HTTP 200 — OK
Schema: QuantitySchema
| Field | Type | Required |
|---|---|---|
canonical_unit |
string |
yes |
code |
string |
yes |
default_scale |
string |
yes |
id |
string |
yes |
is_complex |
boolean |
yes |
physical_kind |
string |
yes |
status |
string |
yes |
superseded_by_id |
string |
no |
synonyms |
array<object> |
yes |
team_id |
string |
no |
title |
string |
yes |
Permission¶
Required permission: admin
HTTP¶
PATCH /api/foundry/quantities/{id}/ (updateQuantity)
Usage¶
quantity.update()