Summary
Push Item to Array
Description
Push item to a job variable array
Route
No Northbound API Available
Roles
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| job_id |
string |
yes |
The Job ID |
| job_variable |
string |
yes |
The name of the variable in the job's variables list. It will be added if it doesn't exist |
| item_to_push |
string |
yes |
The item to added |
Copied to Clipboard
{
"job_id": "4321abcdef694aa79dae47ad",
"job_variable": "variableArrayName",
"item_to_push": "string value to add"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"job_id": {
"$ref": "wfEngineCommon#/definitions/mongoObjectId"
},
"job_variable": {
"type": "string",
"examples": [
"variableArrayName"
]
},
"item_to_push": {
"type": "string",
"examples": [
"string value to add"
]
}
},
"required": [
"job_id",
"job_variable",
"item_to_push"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| job_variable_value |
array |
The contents of the job variable array |
Copied to Clipboard
[
"string value to add"
]
Copied to Clipboard
{
"type": "array",
"items": {
"type": "string",
"examples": [
"string value to add"
]
}
}
