Create Task
Use this endpoint to schedule a new task.
Request
URI
POST
https://{api_host}/vco/api/tasks
COPY
Request Body
task
of type(s)
application/json
Required
Show optional properties
{
"recurrence-start-date": "string",
"workflow": {}
}{
"href": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"attribute": [
{
"displayValue": "string",
"value": "string",
"name": "string"
}
],
"href": "string",
"type": "string",
"rel": "string"
}
]
},
"id": "string",
"name": "string",
"user": "string",
"description": "string",
"recurrence-pattern": "string",
"recurrence-cycle": "string",
"parameter": [
{
"description": "string",
"value": {
"objectType": "string"
},
"type": "string",
"name": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"state": "string",
"recurrence-start-date": "string",
"recurrence-end-date": "string",
"workflow": {
"href": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"attribute": [
{
"displayValue": "string",
"value": "string",
"name": "string"
}
],
"href": "string",
"type": "string",
"rel": "string"
}
]
},
"id": "string",
"schema-workflow": {
"display-name": "string",
"description": "string",
"ref-types": "string",
"error-handler": [
{
"position": {
"y": "number",
"x": "number"
},
"name": "string",
"throw-bind-name": "string"
}
],
"position": {
"y": "number",
"x": "number"
},
"input": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"output": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"attrib": [
{
"description": "string",
"value": {
"objectType": "string"
},
"type": "string",
"name": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"workflow-item": [
{
"display-name": "string",
"script": {
"value": "string",
"encoded": false
},
"in-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"out-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"description": "string",
"conditions": {
"condition": [
{
"value": "string",
"name": "string",
"type": "string",
"comparator": "string",
"label": "string"
}
]
},
"condition": [
{
"value": "string",
"name": "string",
"type": "string",
"comparator": "string",
"label": "string"
}
],
"reference": {
"id": "string",
"type": "string"
},
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": false
}
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"name": "string",
"display-name": "string",
"linked-workflow-id": "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"
}
]
}
}
]
},
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
]
},
"position": {
"y": "number",
"x": "number"
},
"name": "string",
"out-name": "string",
"alt-out-name": "string",
"catch-name": "string",
"throw-bind-name": "string",
"type": "string",
"end-mode": "string",
"script-module": "string",
"business-status": "string",
"color": "string",
"prototype-id": "string",
"content-mode": "string",
"launched-workflow-id": "string",
"interaction": "string",
"linked-workflow-id": "string",
"comparator": 0
}
],
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"p-qual": [
{
"value": "string",
"kind": "string",
"name": "string",
"type": "string"
}
]
},
"workflow-note": [
{
"description": "string",
"x": "number",
"y": "number",
"w": "number",
"h": "number",
"color": "string"
}
],
"schemaLocation": "string",
"root-name": "string",
"object-name": "string",
"id": "string",
"icon-id": "string",
"version": "string",
"api-version": "string",
"allowed-operations": "string",
"restartMode": 0,
"resumeFromFailedMode": 0
},
"inputParameters": [
{
"description": "string",
"value": {
"objectType": "string"
},
"type": "string",
"name": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"outputParameters": [
{
"description": "string",
"value": {
"objectType": "string"
},
"type": "string",
"name": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"customized-icon": false,
"name": "string",
"version": "string",
"description": "string"
},
"start-mode": "string"
}
string
href
Optional
href
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
user
Optional
user
string
description
Optional
description
string
recurrence-pattern
Optional
recurrence-pattern
string
recurrence-cycle
Optional
recurrence-cycle
Possible values are :
ONE_TIME,
EVERY_MINUTES,
EVERY_HOURS,
EVERY_DAYS,
EVERY_WEEKS,
EVERY_MONTHS,
array of
object
parameter
Optional
parameter
string
state
Optional
state
Possible values are :
FINISHED,
CANCELED,
ERROR,
PENDING,
RUNNING,
SUSPENDED,
UNKNOWN,
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
object
workflow
Required
workflow
string
start-mode
Optional
start-mode
Possible values are :
NORMAL,
START_IN_THE_PAST,
Responses
202
The request is successful
Operation doesn't return any data structure
400
The request is invalid(validation error)
Operation doesn't return any data structure
401
The user is not authorized
Operation doesn't return any data structure
404
Can not find a workflow with the specified ID or the user does not have 'read' access rights for that workflow
Operation doesn't return any data structure
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
Task Service Operations
GET
Get Tasks
POST
Create Task
GET
Get Task
POST
Update Task
DELETE
Delete Task
GET
Get Executions
GET
Get Permissions For Object
POST
Insert Permissions For Object
DELETE
Delete Permissions For Object
GET
Get Permission Rule
PUT
Update Permission Rule
DELETE
Delete Permission Rule