Planungseinträge auflisten

Liefert eine paginierte Liste der Planungseinträge, optional ergänzt um die Standardplanung, wo keine erfasst wurde.

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

Request

GET /api/v1/plannings

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/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 Planungseinträge an oder nach diesem Datum zurückgeben.
Name
date_to
Type
string (date), nullable
Description
Nur Planungseinträge an oder vor diesem Datum zurückgeben.
Name
employee_ids[]
Type
Liste von string
Description
Beschränkt das Ergebnis auf einen oder mehrere Mitarbeiter-Benutzernamen.
Name
project_ids[]
Type
Liste von integer
Description
Beschränkt das Ergebnis auf eine oder mehrere Projekt-IDs.
Name
customer_numbers[]
Type
Liste von string
Description
Beschränkt das Ergebnis auf eine oder mehrere Kundennummern.
Name
include_defaults
Type
boolean, nullable
Description
Die Standard-Planungseinträge des Mandanten zusätzlich zu den expliziten Einträgen einbeziehen.

Response

{
  "data": [
    {
      "id": "string",
      "date": "2024-07-20T00:00:00.000000Z",
      "employee_id": "max.mustermann",
      "project_id": 16,
      "customer_number": "K-12345",
      "project_task_id": 1,
      "ticket_id": 1234,
      "subtask_id": 1,
      "type": 1,
      "kind": 1,
      "planning": 1.5,
      "from": "2026-01-31T09:00:00.000000Z",
      "to": "2026-01-31T09:00:00.000000Z",
      "planning_in_hours": 1.5,
      "planning_in_days": 1.5,
      "planning_in_percent": 1.5,
      "working_day": 1,
      "note": "Familienurlaub",
      "created_at": "2024-01-15T10:30:00+01:00",
      "updated_at": "2024-06-20T14:45:00+02:00",
      "planning_details": {
        "type": "string",
        "value": 12.5,
        "unit": "string",
        "effective_hours": 12.5,
        "from_time": "2026-01-31T09:00:00.000000Z",
        "to_time": "2026-01-31T09:00:00.000000Z"
      },
      "employee": {
        "username": "string",
        "firstname": "string",
        "lastname": "string",
        "email": "string"
      },
      "project": {
        "id": 1,
        "name": "string"
      },
      "customer": {
        "customer_number": "string",
        "name": "string"
      }
    }
  ],
  "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
string
Description
Eindeutige Kennung des Planungseintrags.
Name
date
Type
string
Description
Datum, für das der Planungseintrag gilt.
Name
employee_id
Type
string
Description
Kennung des verplanten Mitarbeiters.
Name
project_id
Type
integer, nullable
Description
Kennung des verplanten Projekts.
Name
customer_number
Type
string, nullable
Description
Nummer des verplanten Kunden.
Name
project_task_id
Type
integer, nullable
Description
Kennung des verplanten Vorgangs.
Name
ticket_id
Type
integer, nullable
Description
Kennung des verplanten Tickets.
Name
subtask_id
Type
integer, nullable
Description
Kennung der verplanten Teilaufgabe des Tickets.
Name
type
Type
integer
Description
Welche Art von Objekt der Eintrag verplant: Projekt, Ticket, Vorgang oder Teilaufgabe.
Name
kind
Type
integer
Description
Wie die geplante Menge ausgedrückt wird: Prozent, Stunden, Tag oder ein Zeitbereich.
Name
planning
Type
number, nullable
Description
Die geplante Menge in der durch ihre Art festgelegten Einheit.
Name
from
Type
string (date-time), nullable
Description
Beginn des geplanten Zeitbereichs, wenn die Art ein Zeitbereich ist.
Name
to
Type
string (date-time), nullable
Description
Ende des geplanten Zeitbereichs, wenn die Art ein Zeitbereich ist.
Name
planning_in_hours
Type
number, nullable
Description
Die geplante Menge, umgerechnet in Stunden.
Name
planning_in_days
Type
number, nullable
Description
Die geplante Menge, umgerechnet in Tage.
Name
planning_in_percent
Type
number, nullable
Description
Die geplante Menge, umgerechnet in Prozent.
Name
working_day
Type
integer, nullable
Description
Ob das geplante Datum für den Mitarbeiter ein Arbeitstag ist.
Name
note
Type
string, nullable
Description
Freitext-Notiz zum Planungseintrag.
Name
created_at
Type
string, nullable
Description
Datum und Uhrzeit der Erstellung des Planungseintrags.
Name
updated_at
Type
string, nullable
Description
Datum und Uhrzeit der letzten Änderung des Planungseintrags.
Name
planning_details
Type
object
Description
Planungsdetails je nach Art Aufschlüsselung der geplanten Menge, strukturiert entsprechend der Art des Eintrags.
Name
planning_details.type
Type
string
Description
Name
planning_details.value
Type
number, nullable
Description
Name
planning_details.unit
Type
string
Description
Name
planning_details.effective_hours
Type
number, nullable
Description
Name
planning_details.from_time
Type
string (date-time), nullable
Description
Name
planning_details.to_time
Type
string (date-time), nullable
Description
Name
employee
Type
object
Description
Verknüpfte Daten (wenn geladen) Die Basisdaten des verplanten Mitarbeiters, wenn geladen.
Name
employee.username
Type
string
Description
Name
employee.firstname
Type
string
Description
Name
employee.lastname
Type
string
Description
Name
employee.email
Type
string, nullable
Description
Name
project
Type
object
Description
Die Basisdaten des verplanten Projekts, wenn geladen.
Name
project.id
Type
integer
Description
Name
project.name
Type
string, nullable
Description
Name
customer
Type
object
Description
Die Basisdaten des verplanten Kunden, wenn geladen.
Name
customer.customer_number
Type
string
Description
Name
customer.name
Type
string, nullable
Description

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

Planung GET Planungseinträge auflisten (abgekündigter Alias)