Update Task

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
task-data of type(s) application/json
Required 
{
    "recurrence-start-date": "string",
    "recurrence-end-date": "string",
    "recurrence-pattern": "string",
    "start-mode": "string",
    "name": "string",
    "description": "string",
    "recurrence-cycle": "string",
    "id": "string",
    "state": "string"
}
string As date-time As date-time
recurrence-start-date
Optional

recurrence-start-date

string As date-time As date-time
recurrence-end-date
Optional

recurrence-end-date

string
recurrence-pattern
Optional

recurrence-pattern

string
start-mode
Optional

start-mode

Possible values are : NORMAL, START_IN_THE_PAST,
string
name
Optional

name

string
description
Optional

description

string
recurrence-cycle
Optional

recurrence-cycle

Possible values are : ONE_TIME, EVERY_MINUTES, EVERY_HOURS, EVERY_DAYS, EVERY_WEEKS, EVERY_MONTHS,
string
id
Optional

id

string
state
Optional

state

Possible values are : FINISHED, CANCELED, ERROR, PENDING, RUNNING, SUSPENDED, UNKNOWN,
Responses
200

The request is successful

Returns task of type(s) application/json 
{
    "recurrence-pattern": "string",
    "workflow": {
        "customized-icon": false,
        "name": "string",
        "description": "string",
        "href": "string",
        "id": "string",
        "relations": {
            "total": 0,
            "start": 0,
            "link": [
                {
                    "rel": "string",
                    "attribute": [
                        {
                            "displayValue": "string",
                            "name": "string",
                            "value": "string"
                        }
                    ],
                    "href": "string",
                    "type": "string"
                }
            ]
        },
        "inputParameters": [
            {
                "scope": "string",
                "name": "string",
                "description": "string",
                "type": "string",
                "value": {
                    "objectType": "string"
                },
                "updated": false
            }
        ],
        "version": "string",
        "outputParameters": [
            {
                "scope": "string",
                "name": "string",
                "description": "string",
                "type": "string",
                "value": {
                    "objectType": "string"
                },
                "updated": false
            }
        ]
    },
    "description": "string",
    "recurrence-cycle": "string",
    "recurrence-start-date": "string",
    "recurrence-end-date": "string",
    "start-mode": "string",
    "parameter": [
        {
            "scope": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "value": {
                "objectType": "string"
            },
            "updated": false
        }
    ],
    "name": "string",
    "href": "string",
    "id": "string",
    "state": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "rel": "string",
                "attribute": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "type": "string"
            }
        ]
    },
    "user": "string"
}
string
recurrence-pattern
Optional

recurrence-pattern

workflow
workflow
Required

workflow

string
description
Optional

description

string
recurrence-cycle
Optional

recurrence-cycle

Possible values are : ONE_TIME, EVERY_MINUTES, EVERY_HOURS, EVERY_DAYS, EVERY_WEEKS, EVERY_MONTHS,
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 parameter
parameter
Optional

parameter

string
name
Optional

name

string
href
Optional

href

string
id
Optional

id

string
state
Optional

state

Possible values are : FINISHED, CANCELED, ERROR, PENDING, RUNNING, SUSPENDED, UNKNOWN,
Relations
relations
Optional

relations

string
user
Optional

user


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 task with the specified ID or the user does not have 'read' access rights for that workflow

Operation doesn't return any data structure

On This Page
Task Service Operations
POST
Create Task
DELETE
Delete Permission Rule
DELETE
Delete Permissions For Object
DELETE
Delete Task
GET
Get Executions
GET
Get Permission Rule
GET
Get Permissions For Object
GET
Get Task
GET
Get Tasks
POST
Insert Permissions For Object
PUT
Update Permission Rule
POST
Update Task