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.
Request
URI
POST
https://{api_host}/vco/api/tasks/{id}
COPY
Path Parameters
string
id
Required
id
Request Body
WsTask
of type(s)
application/json
Required
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": [
{}
]
}
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
userName
Optional
userName
string
description
Optional
description
string
state
Optional
state
Possible values are :
finished,
canceled,
error,
pending,
running,
suspended,
unknown,
object
workflow
Required
workflow
string
href
Optional
href
string
recurrence-pattern
Optional
recurrence-pattern
string
running-instance-id
Optional
running-instance-id
string
recurrence-cycle
Optional
recurrence-cycle
Possible values are :
one-time,
every-minutes,
every-hours,
every-days,
every-weeks,
every-months,
array of
object
input-parameters
Optional
input-parameters
string As date-time
As date-time
recurrence-start-date
Required
recurrence-start-date
string As date-time
As date-time
recurrence-end-date
Optional
recurrence-end-date
string
start-mode
Optional
start-mode
Possible values are :
normal,
start-in-the-past,
array of
object
formInputs
Optional
formInputs
Responses
200
The request is successful
Returns
WsTask
of type(s)
application/json
"WsTask Object"
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
userName
Optional
userName
string
description
Optional
description
string
state
Optional
state
Possible values are :
finished,
canceled,
error,
pending,
running,
suspended,
unknown,
object
workflow
Required
workflow
string
href
Optional
href
string
recurrence-pattern
Optional
recurrence-pattern
string
running-instance-id
Optional
running-instance-id
string
recurrence-cycle
Optional
recurrence-cycle
Possible values are :
one-time,
every-minutes,
every-hours,
every-days,
every-weeks,
every-months,
array of
object
input-parameters
Optional
input-parameters
string As date-time
As date-time
recurrence-start-date
Required
recurrence-start-date
string As date-time
As date-time
recurrence-end-date
Optional
recurrence-end-date
string
start-mode
Optional
start-mode
Possible values are :
normal,
start-in-the-past,
array of
object
formInputs
Optional
formInputs
400
The request is invalid (validation error)
Returns
WsTask
of type(s)
application/json
"WsTask Object"
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
userName
Optional
userName
string
description
Optional
description
string
state
Optional
state
Possible values are :
finished,
canceled,
error,
pending,
running,
suspended,
unknown,
object
workflow
Required
workflow
string
href
Optional
href
string
recurrence-pattern
Optional
recurrence-pattern
string
running-instance-id
Optional
running-instance-id
string
recurrence-cycle
Optional
recurrence-cycle
Possible values are :
one-time,
every-minutes,
every-hours,
every-days,
every-weeks,
every-months,
array of
object
input-parameters
Optional
input-parameters
string As date-time
As date-time
recurrence-start-date
Required
recurrence-start-date
string As date-time
As date-time
recurrence-end-date
Optional
recurrence-end-date
string
start-mode
Optional
start-mode
Possible values are :
normal,
start-in-the-past,
array of
object
formInputs
Optional
formInputs
401
The user is not authorized
Returns
WsTask
of type(s)
application/json
"WsTask Object"
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
userName
Optional
userName
string
description
Optional
description
string
state
Optional
state
Possible values are :
finished,
canceled,
error,
pending,
running,
suspended,
unknown,
object
workflow
Required
workflow
string
href
Optional
href
string
recurrence-pattern
Optional
recurrence-pattern
string
running-instance-id
Optional
running-instance-id
string
recurrence-cycle
Optional
recurrence-cycle
Possible values are :
one-time,
every-minutes,
every-hours,
every-days,
every-weeks,
every-months,
array of
object
input-parameters
Optional
input-parameters
string As date-time
As date-time
recurrence-start-date
Required
recurrence-start-date
string As date-time
As date-time
recurrence-end-date
Optional
recurrence-end-date
string
start-mode
Optional
start-mode
Possible values are :
normal,
start-in-the-past,
array of
object
formInputs
Optional
formInputs
404
Can not find a task with the specified ID or the user does not have 'read' access rights for that workflow
Returns
WsTask
of type(s)
application/json
"WsTask Object"
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
userName
Optional
userName
string
description
Optional
description
string
state
Optional
state
Possible values are :
finished,
canceled,
error,
pending,
running,
suspended,
unknown,
object
workflow
Required
workflow
string
href
Optional
href
string
recurrence-pattern
Optional
recurrence-pattern
string
running-instance-id
Optional
running-instance-id
string
recurrence-cycle
Optional
recurrence-cycle
Possible values are :
one-time,
every-minutes,
every-hours,
every-days,
every-weeks,
every-months,
array of
object
input-parameters
Optional
input-parameters
string As date-time
As date-time
recurrence-start-date
Required
recurrence-start-date
string As date-time
As date-time
recurrence-end-date
Optional
recurrence-end-date
string
start-mode
Optional
start-mode
Possible values are :
normal,
start-in-the-past,
array of
object
formInputs
Optional
formInputs
Code Samples
COPY
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}