Update a task of a project

Updates the given task with the fields present in the request and returns the updated record.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

PUT is accepted as an alias of PATCH for this operation.

Request

PATCH /api/v1/projects/{id}/tasks/{task_id}

curl --request PATCH \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/projects/{id}/tasks/{task_id}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
       "id": 1,
       "project_id": 16,
       "name": "EU",
       "description": "Angebot|en:offer",
       "status_id": "string",
       "billing_type": 0,
       "start_date": "2024-01-15",
       "end_date": "2024-01-16",
       "parent_id": 1,
       "cost_object_identifier": 1,
       "has_explicit_assigned_employees": true,
       "tickets_import_mailbox_name": "string",
       "dynamicAttributes": [
         [
           "string"
         ]
       ]
     }'

Path parameters

Name
id
Type
integer
Description
The project ID
Name
task_id
Type
integer
Description
The task ID

Request body

Name
id
Type
integer, required
Description
Identifier of the task to update.
Name
project_id
Type
integer, required
Description
Identifier of the project this task belongs to.
Name
name
Type
string, required
Description
Name of the task.
Name
description
Type
string, nullable
Description
Free-text description of the task.
Name
status_id
Type
string, required
Description
Identifier of the task’s status.
Name
billing_type
Type
integer, nullable
Description
How the task is billed: hourly rate, daily rate, flat rate, or the same as the project.
One of: 0, 1, 2, 3
Name
start_date
Type
string (date), nullable
Description
Date the task starts.
Name
end_date
Type
string (date), nullable
Description
Date the task ends.
Name
parent_id
Type
integer, nullable
Description
Identifier of the parent task, for a task nested under another one.
Name
cost_object_identifier
Type
integer, nullable
Description
External identifier of the task’s cost object, used for accounting export.
Name
has_explicit_assigned_employees
Type
boolean, nullable
Description
Whether employees must be explicitly assigned to the task rather than inheriting the project’s.
Name
tickets_import_mailbox_name
Type
string, nullable
Description
Name of the mailbox tickets are imported from into this task.
Name
dynamicAttributes
Type
array of array, nullable
Description
Dynamic attributes to configure for the task.

Response

{
  "data": {
    "id": 1,
    "name": "EU",
    "status": "string",
    "description": "Angebot|en:offer",
    "parent_id": 1,
    "start_date": "2024-01-15T00:00:00.000000Z",
    "end_date": "2024-01-16T00:00:00.000000Z",
    "billing_type": {
      "id": 1,
      "name": "Like project"
    },
    "project_id": 16,
    "created": "2024-07-20T11:30:00.000000Z",
    "modified": "2024-07-20T12:30:00.000000Z",
    "plan_hours_children": 1.5,
    "plan_hours_done": 1.5,
    "plan_wage": 1.5,
    "plan_hours": 1.5,
    "plan_wage_children": 0,
    "plan_hours_invoiced": 1.5,
    "order_number": "string",
    "tickets_import_mailbox_name": "string",
    "dynamicAttributes": [
      {
        "name": "EU",
        "value": "Max Mustermann (Bruder)",
        "type": "Text",
        "description": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "es": "string",
          "pl": "string"
        }
      }
    ]
  }
}

Response fields

Name
id
Type
integer
Description
Unique identifier of the task.
Name
name
Type
string
Description
Name of the task.
Name
status
Type
string, nullable
Description
Identifier of the task’s current status, if the status could be resolved.
Name
description
Type
string, nullable
Description
Free-text description of the task.
Name
parent_id
Type
integer, nullable
Description
Identifier of the parent task, for a task nested under another one.
Name
start_date
Type
string (date-time), nullable
Description
Date the task starts.
Name
end_date
Type
string (date-time), nullable
Description
Date the task ends.
Name
billing_type
Type
object, nullable
Description
How the task is billed: hourly rate, daily rate, flat rate, or the same as the project.
Name
billing_type.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
billing_type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Like project", "Stundensatz", "Tagessatz", "Pausch"
Name
project_id
Type
integer
Description
Identifier of the project this task belongs to.
Name
created
Type
string (date-time), nullable
Description
Date and time the task was created.
Name
modified
Type
string (date-time), nullable
Description
Date and time the task was last modified.
Name
plan_hours_children
Type
number, nullable
Description
Planned hours budgeted across this task’s subtasks.
Name
plan_hours_done
Type
number, nullable
Description
Hours already recorded against the task.
Name
plan_wage
Type
number, nullable
Description
Planned total wage cost budgeted for the task.
Name
plan_hours
Type
number, nullable
Description
Planned total hours budgeted for the task.
Name
plan_wage_children
Type
number, nullable
Description
Planned wage cost budgeted across this task’s subtasks.
Name
plan_hours_invoiced
Type
number, nullable
Description
Hours already invoiced for the task.
Name
order_number
Type
string, nullable
Description
Consecutive order number of the task, used for sorting.
Name
tickets_import_mailbox_name
Type
string, nullable
Description
Name of the mailbox tickets are imported from into this task.
Name
dynamicAttributes
Type
array of DynamicAttribute
Description
Dynamic attributes configured for the task.
Name
dynamicAttributes.name
Type
string
Description
Name of the dynamic attribute definition this value was entered for.
Name
dynamicAttributes.value
Type
any
Description
The stored value; its shape depends on the neighbouring type field (a string, a number, a boolean, a date, an employee reference, or a list of option values).
Name
dynamicAttributes.type
Type
string
Description
The data type of this attribute, e.g. text, number, date or options, which decides how to interpret value.
One of: "Text", "Integer", "Float", "URL", "E-Mail", "Datum", "Uhrzeit", "Datetime", "Boolean", "Betrag", "Optionen", "Prozent", "Time period", "Textarea", "Users", "Upload"
Name
dynamicAttributes.description
Type
object, nullable
Description
Explanation of what this attribute captures, as configured on its definition.

Generated from the OpenAPI specification — edit the source code, not this page.

GET Get a task of a project DELETE Delete a task of a project