DerivedQuantity.update¶
Update derived-quantity fields.
Server: PATCH /api/foundry/derived-quantities/{id}/.
Signature¶
update(**kwargs: Any) -> None
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
derived_quantity_id |
path |
string |
yes | - |
Fields¶
Schema: DerivedQuantityUpdateSchema
| Field | Type | Required |
|---|---|---|
canonical_signal_id |
string |
no |
equation_id |
string |
no |
inputs |
object |
no |
producing_script_run_id |
string |
no |
provenance |
object |
no |
quantity_id |
string |
no |
value_bool |
boolean |
no |
value_number |
string |
no |
value_text |
string |
no |
Return shape¶
HTTP 200 — OK
Schema: DerivedQuantitySchema
| Field | Type | Required |
|---|---|---|
canonical_signal_id |
string |
no |
equation_id |
string |
no |
equation_version |
string |
yes |
id |
string |
yes |
inputs |
object |
yes |
producing_script_run_id |
string |
no |
provenance |
object |
yes |
quantity_id |
string |
yes |
team_id |
string |
yes |
value_bool |
boolean |
no |
value_number |
string |
no |
value_text |
string |
no |
Permission¶
Required permission: admin
HTTP¶
PATCH /api/foundry/derived-quantities/{id}/ (updateDerivedQuantity)
Usage¶
derived_quantity.update()