REST DokumentationAbteilungenPOST Abteilung anlegen

Abteilung anlegen

Legt eine Abteilung mit den Regeln der Benutzeroberfläche an und liefert sie wie der Endpunkt für eine einzelne Abteilung. Der Name muss eindeutig sein, eine übergeordnete Abteilung muss existieren, und eine aktive Abteilung kann nicht unter einer inaktiven übergeordneten Abteilung angelegt werden. Erfordert das Modul „Standorte & Abteilungen“.

Verfügbarkeit: Vollversion und ZEP Clock

Request

POST /api/v1/departments
curl --request POST \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/departments' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
       "name": "EU",
       "description": "Angebot|en:offer",
       "parent_id": 1,
       "status": true
     }'

Request-Body

  • Name
    name
    Type
    string, erforderlich
    Description

    Der Kurzname der Abteilung, eindeutig über alle Abteilungen. Leerzeichen sind erlaubt; Anführungszeichen, #, &, -- und andere unsichere Zeichen nicht.

  • Name
    description
    Type
    string, nullable
    Description

    Freitext-Beschreibung der Abteilung.

  • Name
    parent_id
    Type
    integer, nullable
    Description

    Kennung der übergeordneten Abteilung. Eine aktive Abteilung kann nicht unter einer inaktiven stehen.

  • Name
    status
    Type
    boolean
    Description

    Gibt an, ob die Abteilung inaktiv ist: true legt sie inaktiv an, false oder weggelassen legt sie aktiv an.

Response

{
  "data": {
    "id": 1,
    "parent_id": 1,
    "name": "EU",
    "description": "Angebot|en:offer",
    "comments": "Wichtiger Kunde - mit Sorgfalt behandeln",
    "status": true,
    "manager": [
      {
        "username": "max.mustermann",
        "firstname": "Max",
        "lastname": "Mustermann",
        "personal_number": "1",
        "email": "erika.mustermann@acme-corp.de",
        "is_deputy": true
      }
    ],
    "children": [
      {}
    ],
    "manager_count": 2,
    "children_count": 10,
    "created": "2024-07-20T11:30:00.000000Z",
    "modified": "2024-07-20T12:30:00.000000Z"
  }
}

Response-Felder

  • Name
    id
    Type
    integer
    Description

    Eindeutige ID der Abteilung.

  • Name
    parent_id
    Type
    integer, nullable
    Description

    ID der übergeordneten Abteilung, falls diese Abteilung einer anderen untergeordnet ist.

  • Name
    name
    Type
    string
    Description

    Anzeigename der Abteilung.

  • Name
    description
    Type
    string, nullable
    Description

    Freitext-Beschreibung des Zwecks oder Aufgabenbereichs der Abteilung.

  • Name
    comments
    Type
    string, nullable
    Description

    Interne Freitext-Kommentare zur Abteilung.

  • Name
    status
    Type
    boolean, nullable
    Description

    Gespeichertes Inaktiv-Kennzeichen, unverändert geliefert: 1 bedeutet inaktiv, 0 oder null bedeutet aktiv.

  • Name
    manager
    Type
    Liste von DepartmentManager
    Description

    Der Mitarbeiter, der derzeit als Leiter dieser Abteilung zugewiesen ist.

  • Name
    manager.username
    Type
    string
    Description

    Eindeutiger Anmeldename des Abteilungsleiters.

  • Name
    manager.firstname
    Type
    string
    Description

    Vorname des Abteilungsleiters.

  • Name
    manager.lastname
    Type
    string
    Description

    Nachname des Abteilungsleiters.

  • Name
    manager.personal_number
    Type
    string, nullable
    Description

    Personalnummer des Abteilungsleiters.

  • Name
    manager.email
    Type
    string, nullable
    Description

    Geschäftliche E-Mail-Adresse des Abteilungsleiters.

  • Name
    manager.is_deputy
    Type
    boolean
    Description

    Ob die Person Stellvertretung der Abteilungsleitung ist; nur das Lizenzmodul Inovex setzt den Wert, ein nicht gesetzter Wert wird als false geliefert.

  • Name
    children
    Type
    Liste von Department
    Description

    Die dieser Abteilung direkt untergeordneten Abteilungen.

  • Name
    children.id
    Type
    integer
    Description

    Eindeutige ID der Abteilung.

  • Name
    children.parent_id
    Type
    integer, nullable
    Description

    ID der übergeordneten Abteilung, falls diese Abteilung einer anderen untergeordnet ist.

  • Name
    children.name
    Type
    string
    Description

    Anzeigename der Abteilung.

  • Name
    children.description
    Type
    string, nullable
    Description

    Freitext-Beschreibung des Zwecks oder Aufgabenbereichs der Abteilung.

  • Name
    children.comments
    Type
    string, nullable
    Description

    Interne Freitext-Kommentare zur Abteilung.

  • Name
    children.status
    Type
    boolean, nullable
    Description

    Gespeichertes Inaktiv-Kennzeichen, unverändert geliefert: 1 bedeutet inaktiv, 0 oder null bedeutet aktiv.

  • Name
    children.manager
    Type
    Liste von DepartmentManager
    Description

    Der Mitarbeiter, der derzeit als Leiter dieser Abteilung zugewiesen ist.

  • Name
    children.children
    Type
    Liste von Department
    Description

    Die dieser Abteilung direkt untergeordneten Abteilungen.

  • Name
    children.manager_count
    Type
    integer
    Description

    Anzahl der derzeit zugewiesenen Abteilungsleiter.

  • Name
    children.children_count
    Type
    integer
    Description

    Anzahl der dieser Abteilung direkt untergeordneten Abteilungen.

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

    Zeitstempel, zu dem die Abteilung angelegt wurde.

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

    Zeitstempel, zu dem die Abteilung zuletzt geändert wurde.

  • Name
    manager_count
    Type
    integer
    Description

    Anzahl der derzeit zugewiesenen Abteilungsleiter.

  • Name
    children_count
    Type
    integer
    Description

    Anzahl der dieser Abteilung direkt untergeordneten Abteilungen.

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

    Zeitstempel, zu dem die Abteilung angelegt wurde.

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

    Zeitstempel, zu dem die Abteilung zuletzt geändert wurde.

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