Jump to

• Request
• Response

Update a Task

put

/process/api/v1/tasks/{id}

Update priority or payload for the given task and optionally add comment. This end point must not be used to update only comments.

Request

Path Parameters

• id(required): string
  Task Id

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request for updating the task title, priority and payload

Show Source

• comment: string
  comment
• dueDate: string
  New Due Date in the format "yyyy-MM-dd'T'HH:mm:ss"
• payload: string
  Updated payload
• priority: integer
  New priority
• summaries: array summaries
  Request for updating process task titles in different locales
• summary: string
  Title Summary for Adhoc Task
• title: string
  Title update for Adhoc Task
• titles: array titles
  Request for updating process task titles in different locales

{
    "type":"object",
    "description":"Request for updating the task title, priority and payload",
    "properties":{
        "title":{
            "type":"string",
            "description":"Title update for Adhoc Task"
        },
        "titles":{
            "type":"array",
            "description":"Request for updating process task titles in different locales",
            "items":{
                "$ref":"#/components/schemas/ProcessTaskTitleUpdateRequest"
            }
        },
        "summary":{
            "type":"string",
            "description":"Title Summary for Adhoc Task"
        },
        "summaries":{
            "type":"array",
            "description":"Request for updating process task titles in different locales",
            "items":{
                "$ref":"#/components/schemas/ProcessTaskSummaryUpdateRequest"
            }
        },
        "dueDate":{
            "type":"string",
            "description":"New Due Date in the format \"yyyy-MM-dd'T'HH:mm:ss\""
        },
        "priority":{
            "type":"integer",
            "description":"New priority"
        },
        "payload":{
            "type":"string",
            "description":"Updated payload"
        },
        "comment":{
            "type":"string",
            "description":"comment"
        }
    }
}

Nested Schema : summaries

Type: array

Request for updating process task titles in different locales

Show Source

• Array of: object ProcessTaskSummaryUpdateRequest
  Request for updating process task summaries in different locales

{
    "type":"array",
    "description":"Request for updating process task titles in different locales",
    "items":{
        "$ref":"#/components/schemas/ProcessTaskSummaryUpdateRequest"
    }
}

Nested Schema : titles

Type: array

Request for updating process task titles in different locales

Show Source

• Array of: object ProcessTaskTitleUpdateRequest
  Request for updating process task titles in different locales

{
    "type":"array",
    "description":"Request for updating process task titles in different locales",
    "items":{
        "$ref":"#/components/schemas/ProcessTaskTitleUpdateRequest"
    }
}

Nested Schema : ProcessTaskSummaryUpdateRequest

Type: object

Request for updating process task summaries in different locales

Show Source

• locale: string
  Task summary locale.
• value: string
  New task summary value for given locale.

{
    "type":"object",
    "description":"Request for updating process task summaries in different locales",
    "properties":{
        "locale":{
            "type":"string",
            "description":"Task summary locale."
        },
        "value":{
            "type":"string",
            "description":"New task summary value for given locale."
        }
    }
}

Nested Schema : ProcessTaskTitleUpdateRequest

Type: object

Request for updating process task titles in different locales

Show Source

• locale: string
  Task title locale.
• value: string
  New task title value for given locale.

{
    "type":"object",
    "description":"Request for updating process task titles in different locales",
    "properties":{
        "locale":{
            "type":"string",
            "description":"Task title locale."
        },
        "value":{
            "type":"string",
            "description":"New task title value for given locale."
        }
    }
}

Examples

Select an example Update a Task

Back to Top

Response

200 Response

Successful operation

401 Response

Unauthorized

404 Response

Task Id does not exist.

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top