Summary
Array Pop
Description
Pop off the end data item from a job variable array
Route
No Northbound API Available
Roles
admin
apiwrite
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. |
Copied to Clipboard
{
"job_id": "4321abcdef694aa79dae47ad",
"job_variable": "variableArrayName"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"job_id": {
"$ref": "wfEngineCommon#/definitions/mongoObjectId"
},
"job_variable": {
"type": "string",
"examples": [
"variableArrayName"
]
}
},
"required": [
"job_id",
"job_variable"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| popped_item |
* |
Popped Item |
Copied to Clipboard
"last value in the array, now removed from the array"
Copied to Clipboard
{
"type": [
"array",
"boolean",
"integer",
"number",
"object",
"string"
],
"examples": [
"last value in the array, now removed from the array"
]
}
