REST DokumentationRessourcenplanungGET Planungen der Ressourcenplanung auflisten

Planungen der Ressourcenplanung auflisten

Liefert eine paginierte Liste der Planungen der Ressourcenplanung, jeweils mit den geplanten Stunden insgesamt und pro Monat. Nur mit der Ressourcenplanung (MOD_PLANNING_NEXT oder Produktlinie 4 ohne MOD_RESSOURCENPLANUNG); Mandanten mit der bisherigen Planung nutzen weiterhin GET /plannings.

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

Request

GET /api/v1/resource-plannings
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/resource-plannings' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query-Parameter

  • Name
    perPage
    Type
    integer, nullable
    Description

    Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.

  • Name
    page
    Type
    integer, nullable
    Description

    Die zurückzugebende Ergebnisseite, beginnend bei 1.

  • Name
    orderBy
    Type
    string, nullable
    Description

    Name des Feldes, nach dem sortiert wird.

  • Name
    order
    Type
    string, nullable
    Description

    Sortierrichtung, aufsteigend oder absteigend.

    Einer der Werte: "asc", "desc"

  • Name
    limit
    Type
    integer, nullable
    Description

    Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.

  • Name
    modified_after
    Type
    string (date-time)
    Description

    Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).

  • Name
    modified_before
    Type
    string (date-time)
    Description

    Nur Datensätze zurückgeben, die vor oder zu diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).

  • Name
    date_from
    Type
    string (date), nullable
    Description

    Nur Planungen zurückgeben, die an oder nach diesem Datum enden.

  • Name
    date_to
    Type
    string (date), nullable
    Description

    Nur Planungen zurückgeben, die an oder vor diesem Datum beginnen.

  • Name
    employee_ids[]
    Type
    Liste von string
    Description

    Das Ergebnis auf einen oder mehrere Mitarbeiter (Benutzernamen) einschränken.

  • Name
    project_ids[]
    Type
    Liste von integer
    Description

    Das Ergebnis auf ein oder mehrere Projekte (IDs) einschränken.

  • Name
    customer_numbers[]
    Type
    Liste von string
    Description

    Das Ergebnis auf die Projekte eines oder mehrerer Kunden einschränken.

Response

{
  "data": [
    {
      "id": 1,
      "employee_id": "max.mustermann",
      "project_id": 16,
      "project_task_id": 1,
      "start_date": "2026-10-01",
      "end_date": "2026-10-31",
      "unit": "percent",
      "value": 1.5,
      "note": "Familienurlaub",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z",
      "total_hours": 1.5,
      "monthly_hours": [
        {
          "month": "2026-10",
          "hours": 68.9
        },
        {
          "month": "2026-11",
          "hours": 65.7
        }
      ],
      "employee": {
        "username": "max.mustermann",
        "firstname": "Max",
        "lastname": "Mustermann",
        "email": "max.mustermann@example.com"
      },
      "project": {
        "id": 16,
        "name": "Website relaunch"
      }
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response-Felder

  • Name
    id
    Type
    integer
    Description

    Eindeutige Kennung der Planung.

  • Name
    employee_id
    Type
    string
    Description

    Kennung des eingeplanten Mitarbeiters.

  • Name
    project_id
    Type
    integer
    Description

    Kennung des eingeplanten Projekts.

  • Name
    project_task_id
    Type
    integer, nullable
    Description

    Kennung des eingeplanten Vorgangs, oder null, wenn das ganze Projekt eingeplant ist.

  • Name
    start_date
    Type
    string
    Description

    Erster Tag der Planung.

  • Name
    end_date
    Type
    string
    Description

    Letzter Tag der Planung, einschließlich.

  • Name
    unit
    Type
    string
    Description

    Wie der Wert angegeben ist: Prozent der regulären Arbeitszeit des Tages oder Stunden pro Arbeitstag.

    Einer der Werte: "percent", "hours"

  • Name
    value
    Type
    number
    Description

    Der geplante Umfang pro Tag, in der angegebenen Einheit.

  • Name
    note
    Type
    string, nullable
    Description

    Freitext-Notiz zur Planung.

  • Name
    created
    Type
    string, nullable
    Description

    Zeitpunkt, zu dem die Planung angelegt wurde.

  • Name
    modified
    Type
    string, nullable
    Description

    Zeitpunkt, zu dem die Planung zuletzt geändert wurde.

  • Name
    total_hours
    Type
    number
    Description

    Geplante Stunden über die gesamte Planung, berechnet aus der regulären Arbeitszeit des Mitarbeiters an jedem Tag; Feiertage und Fehlzeiten werden nicht abgezogen.

  • Name
    monthly_hours
    Type
    Liste von ResourcePlanningMonth
    Description

    Geplante Stunden je Kalendermonat, den die Planung berührt, aufsteigend sortiert.

  • Name
    monthly_hours.month
    Type
    string
    Description

    Kalendermonat im Format YYYY-MM.

  • Name
    monthly_hours.hours
    Type
    number
    Description

    Geplante Stunden in diesem Monat.

  • Name
    employee
    Type
    object
    Description

    Die Basisdaten des eingeplanten Mitarbeiters, sofern geladen.

  • Name
    employee.username
    Type
    string, nullable
    Description
  • Name
    employee.firstname
    Type
    string, nullable
    Description
  • Name
    employee.lastname
    Type
    string, nullable
    Description
  • Name
    employee.email
    Type
    string, nullable
    Description
  • Name
    project
    Type
    object
    Description

    Die Basisdaten des eingeplanten Projekts, sofern geladen.

  • Name
    project.id
    Type
    integer, nullable
    Description
  • Name
    project.name
    Type
    string, nullable
    Description
Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.