Summary
Update Job Description
Description
Overwrite the job description with a new one
Route
No Northbound API Available
Roles
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| job_id |
string |
yes |
The Job ID |
| description |
string |
yes |
The new job description |
Copied to Clipboard
{
"job_id": "5cb7b531d06cceb89fd21b1c",
"description": "New job description"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"job_id": {
"$ref": "wfEngineCommon#/definitions/mongoObjectId"
},
"description": {
"type": "string",
"title": "description",
"examples": [
"New job description"
]
}
},
"required": [
"job_id",
"description"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| description |
string |
Value of the new job description |
Copied to Clipboard
"New job description"
Copied to Clipboard
{
"type": "string",
"title": "description",
"examples": [
"New job description"
]
}
