Summary
Modify Data
Description
Modify data
Route
No Northbound API Available
Roles
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| job_id |
string |
yes |
The Job ID |
| object_to_update |
* |
yes |
Items to update |
| query |
string |
no |
Query the object_to_update (optional) |
| new_value |
* |
yes |
The new value |
Copied to Clipboard
{
"job_id": "4321abcdef694aa79dae47ad",
"object_to_update": "item to update",
"new_value": "updated item",
"query": "enim"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"job_id": {
"$ref": "wfEngineCommon#/definitions/mongoObjectId"
},
"object_to_update": {
"title": "object_to_update",
"type": [
"string",
"object",
"array",
"integer",
"number",
"boolean"
],
"examples": [
"item to update"
]
},
"query": {
"type": "string",
"title": "query"
},
"new_value": {
"title": "new_value",
"type": [
"string",
"object",
"array",
"integer",
"number",
"boolean"
],
"examples": [
"updated item"
]
}
},
"required": [
"job_id",
"object_to_update",
"new_value"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| updated_object |
* |
Updated Object |
Copied to Clipboard
"updated item"
Copied to Clipboard
{
"title": "updated_object",
"type": [
"array",
"string",
"boolean",
"integer",
"number",
"object"
],
"examples": [
"updated item"
]
}
