Update Task
Use this endpoint to update an already scheduled task. If the scheduling date is changed, the original task is rescheduled. It is not allowed to update the scheduled workflow. To update the scheduled workflow, remove the current task and schedule a new one.
id
Show optional properties
{
"workflow": {},
"recurrence-start-date": "string"
}
{
"relations": {
"startIndex": 0,
"count": 0,
"total": 0,
"link": [
{
"rel": "string",
"type": "string",
"attributes": [
{
"name": "string",
"displayName": "string",
"value": "string",
"displayValue": "string"
}
],
"href": "string"
}
]
},
"id": "string",
"name": "string",
"userName": "string",
"description": "string",
"state": "string",
"workflow": {
"relations": {
"startIndex": 0,
"count": 0,
"total": 0,
"link": [
{
"rel": "string",
"type": "string",
"attributes": [
{
"name": "string",
"displayName": "string",
"value": "string",
"displayValue": "string"
}
],
"href": "string"
}
]
},
"id": "string",
"name": "string",
"version": "string",
"description": "string",
"href": "string",
"schema-workflow": {
"description": "string",
"position": {
"y": "number",
"x": "number"
},
"input": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"output": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"attrib": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
},
"schemaLocation": "string",
"id": "string",
"version": "string",
"restartMode": 0,
"resumeFromFailedMode": 0,
"display-name": "string",
"category-id": "string",
"ref-types": "string",
"error-handler": [
{
"position": {
"y": "number",
"x": "number"
},
"name": "string",
"throw-bind-name": "string"
}
],
"workflow-item": [
{
"description": "string",
"position": {
"y": "number",
"x": "number"
},
"runtime": "string",
"script": {
"encoded": false,
"text": "string"
},
"conditions": {
"condition": [
{
"name": "string",
"type": "string",
"comparator": "string",
"label": "string",
"text": "string"
}
]
},
"condition": [
{
"name": "string",
"type": "string",
"comparator": "string",
"label": "string",
"text": "string"
}
],
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
},
"name": "string",
"type": "string",
"color": "string",
"interaction": "string",
"comparator": 0,
"environment": {
"id": "string",
"name": "string"
},
"display-name": "string",
"in-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"out-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"iteration-catch-block": {
"script": {
"encoded": false,
"text": "string"
}
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"name": "string",
"linked-workflow-id": "string",
"display-name": "string",
"in-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"out-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
}
}
]
},
"out-name": "string",
"alt-out-name": "string",
"catch-name": "string",
"throw-bind-name": "string",
"end-mode": "string",
"script-module": "string",
"business-status": "string",
"prototype-id": "string",
"content-mode": "string",
"launched-workflow-id": "string",
"linked-workflow-id": "string",
"validation-message": "string"
}
],
"workflow-note": [
{
"description": "string",
"x": "number",
"y": "number",
"w": "number",
"h": "number",
"color": "string"
}
],
"root-name": "string",
"object-name": "string",
"icon-id": "string",
"api-version": "string",
"allowed-operations": "string",
"editor-version": "string"
},
"inputParameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"outputParameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"customized-icon": false,
"category-id": "string"
},
"href": "string",
"recurrence-pattern": "string",
"running-instance-id": "string",
"recurrence-cycle": "string",
"input-parameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"recurrence-start-date": "string",
"recurrence-end-date": "string",
"start-mode": "string",
"formInputs": [
{}
]
}
relations
id
name
userName
description
state
workflow
href
recurrence-pattern
running-instance-id
recurrence-cycle
input-parameters
recurrence-start-date
recurrence-end-date
start-mode
formInputs
The request is successful
"WsTask Object"
relations
id
name
userName
description
state
workflow
href
recurrence-pattern
running-instance-id
recurrence-cycle
input-parameters
recurrence-start-date
recurrence-end-date
start-mode
formInputs
The request is invalid (validation error)
"WsTask Object"
relations
id
name
userName
description
state
workflow
href
recurrence-pattern
running-instance-id
recurrence-cycle
input-parameters
recurrence-start-date
recurrence-end-date
start-mode
formInputs
The user is not authorized
"WsTask Object"
relations
id
name
userName
description
state
workflow
href
recurrence-pattern
running-instance-id
recurrence-cycle
input-parameters
recurrence-start-date
recurrence-end-date
start-mode
formInputs
Can not find a task with the specified ID or the user does not have 'read' access rights for that workflow
"WsTask Object"
relations
id
name
userName
description
state
workflow
href
recurrence-pattern
running-instance-id
recurrence-cycle
input-parameters
recurrence-start-date
recurrence-end-date
start-mode
formInputs
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"recurrence-start-date:"string","workflow:"object"}' https://{api_host}/vco/api/tasks/{id}