ParameterKey.update¶
Update parameter key fields.
Signature¶
update(**kwargs: Any) -> None
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
key_id |
path |
string |
yes | - |
Fields¶
Schema: ParameterKeyCreateSchema
| Field | Type | Required |
|---|---|---|
code |
string |
no |
editable_default |
boolean |
no |
role |
string |
no |
title |
string |
yes |
type |
string |
no |
unit |
string |
no |
value_type |
string |
no |
Return shape¶
HTTP 200 — OK
Schema: ParameterKeySchema
| Field | Type | Required |
|---|---|---|
code |
string |
yes |
editable_default |
boolean |
no |
id |
string |
yes |
role |
string |
no |
team_id |
string |
no |
title |
string |
yes |
unit |
string |
no |
value_type |
string |
yes |
Permission¶
Required permission: admin
HTTP¶
PATCH /api/parameters/{id} (updateParameterKey)
Usage¶
parameter_key.update()