Summary
Create a Job Variable
Description
Create a new Job variable by Job ID and assign it a value.
Route
No Northbound API Available
Roles
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| job_id |
string |
yes |
Job ID |
| name |
string |
yes |
Variable name |
| value |
* |
yes |
The value to put into that new variable |
Copied to Clipboard
{
"job_id": "5cb7b531d06cceb89fd21b1c",
"name": "someVariableName",
"value": 1
}
Copied to Clipboard
{
"type": "object",
"properties": {
"job_id": {
"$ref": "wfEngineCommon#/definitions/mongoObjectId"
},
"name": {
"title": "name",
"type": "string",
"examples": [
"someVariableName"
]
},
"value": {
"title": "value",
"type": [
"array",
"string",
"boolean",
"integer",
"number",
"object"
],
"examples": [
"string value",
1,
true
]
}
},
"required": [
"job_id",
"name",
"value"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| value |
* |
Value of the Job variable. |
Copied to Clipboard
{
"title": "value",
"type": [
"array",
"string",
"boolean",
"integer",
"number",
"object"
],
"examples": [
"string value",
1,
true
]
}
