REST DokumentationProjektePATCH Vorgang eines Projekts aktualisieren

Vorgang eines Projekts aktualisieren

Aktualisiert den angegebenen Vorgang mit den in der Anfrage enthaltenen Feldern und liefert den aktualisierten Datensatz.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

PUT wird für diese Operation als Alias von PATCH akzeptiert.

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": "4711",
       "has_explicit_assigned_employees": true,
       "tickets_import_mailbox_name": "string",
       "activities": [
         "Beratung",
         "Entwicklung"
       ],
       "default_activity": "Beratung",
       "dynamicAttributes": [
         [
           "string"
         ]
       ]
     }'

Pfad-Parameter

  • Name
    id
    Type
    integer
    Description

    Die ID des Projekts

  • Name
    task_id
    Type
    integer
    Description

    Die ID des Vorgangs

Request-Body

  • Name
    id
    Type
    integer, erforderlich
    Description

    Kennung des zu aktualisierenden Vorgangs.

  • Name
    project_id
    Type
    integer, erforderlich
    Description

    Kennung des Projekts, zu dem dieser Vorgang gehört.

  • Name
    name
    Type
    string, erforderlich
    Description

    Name des Vorgangs.

  • Name
    description
    Type
    string, nullable
    Description

    Freitext-Beschreibung des Vorgangs.

  • Name
    status_id
    Type
    string, erforderlich
    Description

    Kennung des Status des Vorgangs.

  • Name
    billing_type
    Type
    integer, nullable
    Description

    Wie der Vorgang abgerechnet wird: Stundensatz, Tagessatz, Pauschale oder wie das Projekt.

    Einer der Werte: 0, 1, 2, 3

  • Name
    start_date
    Type
    string (date), nullable
    Description

    Datum, an dem der Vorgang beginnt.

  • Name
    end_date
    Type
    string (date), nullable
    Description

    Datum, an dem der Vorgang endet.

  • Name
    parent_id
    Type
    integer, nullable
    Description

    Kennung des übergeordneten Vorgangs, bei einem Vorgang, der unter einem anderen eingeordnet ist.

  • Name
    cost_object_identifier
    Type
    string, nullable
    Description

    Externe Kennung des Kostenträgers des Vorgangs, verwendet für den Buchhaltungsexport. Eine Zeichenkette mit bis zu 32 Zeichen; ist das Kostenstellenformat des Mandanten numerisch, nur Ziffern (führende Nullen bleiben erhalten).

  • Name
    has_explicit_assigned_employees
    Type
    boolean, nullable
    Description

    Ob Mitarbeiter dem Vorgang explizit zugeordnet werden müssen, statt die Zuordnung des Projekts zu übernehmen.

  • Name
    tickets_import_mailbox_name
    Type
    string, nullable
    Description

    Name des Postfachs, aus dem Tickets in diesen Vorgang importiert werden.

  • Name
    activities
    Type
    Liste von string, nullable
    Description

    Kurzbezeichnungen der Tätigkeiten, die der Vorgang erlaubt, ersetzt die bisherige Liste. Eine leere Liste entfernt alle eigenen Tätigkeiten, dann gelten wieder die Tätigkeiten des Projekts, sonst alle, und die Standardtätigkeit wird zurückgesetzt. Fehlt das Feld, bleibt die Liste unverändert. Nicht erlaubt an einem Gruppierungsvorgang, also einem mit Untervorgängen.

  • Name
    default_activity
    Type
    string, nullable
    Description

    Kurzbezeichnung der Tätigkeit, die bei Buchungen auf den Vorgang vorausgewählt wird; sie muss eine der Tätigkeiten des Vorgangs sein. Null entfernt sie.

  • Name
    dynamicAttributes
    Type
    Liste von array, nullable
    Description

    Dynamische Attribute, die für den Vorgang konfiguriert werden.

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",
    "all_project_employees": true,
    "activities": [
      "Beratung",
      "Entwicklung"
    ],
    "default_activity": "Beratung",
    "dynamicAttributes": [
      {
        "name": "EU",
        "value": "Max Mustermann (Bruder)",
        "type": "Text",
        "description": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "es": "string",
          "pl": "string"
        }
      }
    ]
  }
}

Response-Felder

  • Name
    id
    Type
    integer
    Description

    Eindeutige Kennung des Vorgangs.

  • Name
    name
    Type
    string
    Description

    Name des Vorgangs.

  • Name
    status
    Type
    string, nullable
    Description

    Kennung des aktuellen Status des Vorgangs, sofern der Status ermittelt werden konnte.

  • Name
    description
    Type
    string, nullable
    Description

    Freitext-Beschreibung des Vorgangs.

  • Name
    parent_id
    Type
    integer, nullable
    Description

    Kennung des übergeordneten Vorgangs, bei einem Vorgang, der unter einem anderen eingeordnet ist.

  • Name
    start_date
    Type
    string (date-time), nullable
    Description

    Datum, an dem der Vorgang beginnt.

  • Name
    end_date
    Type
    string (date-time), nullable
    Description

    Datum, an dem der Vorgang endet.

  • Name
    billing_type
    Type
    object, nullable
    Description

    Wie der Vorgang abgerechnet wird: Stundensatz, Tagessatz, Pauschale oder wie das Projekt.

  • Name
    billing_type.id
    Type
    integer
    Description

    Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.

  • Name
    billing_type.name
    Type
    string
    Description

    Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.

    Einer der Werte: "Like project", "Stundensatz", "Tagessatz", "Pausch"

  • Name
    project_id
    Type
    integer
    Description

    Kennung des Projekts, zu dem dieser Vorgang gehört.

  • Name
    created
    Type
    string (date-time), nullable
    Description

    Datum und Uhrzeit der Erstellung des Vorgangs.

  • Name
    modified
    Type
    string (date-time), nullable
    Description

    Datum und Uhrzeit der letzten Änderung des Vorgangs.

  • Name
    plan_hours_children
    Type
    number, nullable
    Description

    Geplante Stunden, die über die Teilaufgaben dieses Vorgangs budgetiert sind.

  • Name
    plan_hours_done
    Type
    number, nullable
    Description

    Bereits auf den Vorgang erfasste Stunden.

  • Name
    plan_wage
    Type
    number, nullable
    Description

    Geplante Gesamtlohnkosten, die für den Vorgang budgetiert sind.

  • Name
    plan_hours
    Type
    number, nullable
    Description

    Geplante Gesamtstunden, die für den Vorgang budgetiert sind.

  • Name
    plan_wage_children
    Type
    number, nullable
    Description

    Geplante Lohnkosten, die über die Teilaufgaben dieses Vorgangs budgetiert sind.

  • Name
    plan_hours_invoiced
    Type
    number, nullable
    Description

    Bereits für den Vorgang abgerechnete Stunden.

  • Name
    order_number
    Type
    string, nullable
    Description

    Fortlaufende Ordnungsnummer des Vorgangs, wird zur Sortierung verwendet.

  • Name
    tickets_import_mailbox_name
    Type
    string, nullable
    Description

    Name des Postfachs, aus dem Tickets in diesen Vorgang importiert werden.

  • Name
    all_project_employees
    Type
    boolean
    Description

    Ob alle Mitarbeitenden des Projekts auf den Vorgang buchen dürfen. Bei true sind keine Mitarbeiter explizit zugewiesen und die Mitarbeiterliste des Vorgangs ist leer; bei false dürfen nur die aufgelisteten Mitarbeiter buchen.

  • Name
    activities
    Type
    Liste von object
    Description

    Kurzbezeichnungen der eigenen Tätigkeiten des Vorgangs. Leer, wenn der Vorgang keine eigenen hat; dann gelten die Tätigkeiten des Projekts, sonst alle.

  • Name
    default_activity
    Type
    string, nullable
    Description

    Kurzbezeichnung der Tätigkeit, die bei Buchungen auf den Vorgang vorausgewählt wird, null wenn es keine gibt.

  • Name
    dynamicAttributes
    Type
    Liste von DynamicAttribute
    Description

    Für den Vorgang konfigurierte dynamische Attribute.

  • Name
    dynamicAttributes.name
    Type
    string
    Description

    Name der Definition des dynamischen Attributs, für die dieser Wert eingegeben wurde.

  • Name
    dynamicAttributes.value
    Type
    any
    Description

    Der gespeicherte Wert; seine Form hängt vom benachbarten Feld type ab (eine Zeichenkette, eine Zahl, ein Boolean, ein Datum, eine Mitarbeiterreferenz oder eine Liste von Optionswerten).

  • Name
    dynamicAttributes.type
    Type
    string
    Description

    Datentyp dieses Attributs, z. B. Text, Zahl, Datum oder Optionen; bestimmt, wie value zu interpretieren ist.

    Einer der Werte: "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

    Erläuterung, was dieses Attribut erfasst, wie in seiner Definition konfiguriert.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.