Summary
Update tree variables
Description
Update the current tree's variables.
Route
PUT /golden_config/treeVariables/:treeId
Roles
admin
engineering
support
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
treeId |
string |
yes |
Id of the current tree |
treeVariables |
array |
yes |
Array of tree variable objects. |
Copied to Clipboard
{
"treeVariables": [
{
"name": "MkMRCBqPnT",
"value": "proident aliqua",
"type": "pattern"
},
{
"name": "Xf",
"value": "aliqua",
"type": "pattern"
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"treeVariables": {
"type": "array",
"items": {
"$ref": "treeVariable"
}
}
},
"required": [
"treeVariables"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
treeVariables |
object |
Response from updating the tree. |
Copied to Clipboard
{
"n": 18,
"nModified": 9,
"ok": 12
}
Copied to Clipboard
{
"type": "object",
"properties": {
"n": {
"type": "number",
"multipleOf": 1,
"minimum": 0,
"maximum": 25
},
"nModified": {
"type": "number",
"multipleOf": 1,
"minimum": 0,
"maximum": 25
},
"ok": {
"type": "number",
"multipleOf": 1,
"minimum": 0,
"maximum": 25
}
},
"required": [
"n",
"nModified",
"type"
]
}