Projekte API

API-Endpunkte zum Auflisten und Abrufen von Projekten und deren Aufgaben.

Pro-Funktion

Projekte gruppieren zusammengehörige Aufgaben innerhalb eines Boards. Die Projekte API ermöglicht es Ihnen, Projektinformationen abzurufen, einschließlich Fortschrittsstatistiken und der zugehörigen Aufgaben. Dies ist nützlich für Reporting-Dashboards, Fortschrittsverfolgung und Synchronisierung mit anderen Projektmanagement-Tools.

Jedes Projekt enthält Metadaten über seinen Aufgabenstatus – wie viele Aufgaben offen, in Bearbeitung oder erledigt sind. So können Sie den Projektfortschritt anzeigen, ohne jede einzelne Aufgabe abrufen zu müssen.

Projekt abrufen

Rufen Sie ein bestimmtes Projekt anhand seiner ID ab.

Endpunkt

GET /projects/:id

Parameter

Parameter Typ Beschreibung
id string Projekt-UUID

Erforderliche Berechtigung

read

Antwort

{
  "project": {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "name": "Q1 Marketing-Kampagne",
    "description": "Frühlingskampagne für Produktlaunch",
    "board_id": "550e8400-e29b-41d4-a716-446655440000",
    "position": "aaa",
    "num_tasks_open": 5,
    "num_tasks_in_progress": 3,
    "num_tasks_done": 12,
    "num_tasks_total": 20,
    "progress": 0.6,
    "created_at": "2024-01-15T10:35:00Z",
    "updated_at": "2024-01-20T14:45:00Z"
  }
}

Beispiel

curl https://api.kanman.de/v1/projects/660e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer km_ihr_api_token"

Fehler

Status Fehler Beschreibung
404 project_not_found Projekt existiert nicht oder Sie haben keinen Zugriff

Projekt-Aufgaben auflisten

Rufen Sie alle Aufgaben innerhalb eines bestimmten Projekts ab.

Endpunkt

GET /projects/:id/tasks

Parameter

Parameter Typ Beschreibung
id string Projekt-UUID

Erforderliche Berechtigung

read

Antwort

{
  "tasks": [
    {
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "label": "Landingpage gestalten",
      "status": 2,
      "position": "aaa",
      "description": null,
      "created_at": "2024-01-15T10:40:00Z",
      "updated_at": "2024-01-18T16:30:00Z"
    },
    {
      "id": "770e8400-e29b-41d4-a716-446655440001",
      "label": "E-Mail-Text schreiben",
      "status": 1,
      "position": "aab",
      "description": "E-Mail-Sequenz für Kampagne entwerfen",
      "created_at": "2024-01-16T09:00:00Z",
      "updated_at": "2024-01-20T11:15:00Z"
    },
    {
      "id": "770e8400-e29b-41d4-a716-446655440002",
      "label": "Analytics einrichten",
      "status": 0,
      "position": "aac",
      "description": null,
      "created_at": "2024-01-17T14:00:00Z",
      "updated_at": "2024-01-17T14:00:00Z"
    }
  ]
}

Beispiel

curl https://api.kanman.de/v1/projects/660e8400-e29b-41d4-a716-446655440000/tasks \
  -H "Authorization: Bearer km_ihr_api_token"

Projekt-Objekt

Vollständige Projekt-Objektstruktur:

Feld Typ Beschreibung
id string Eindeutige Kennung (UUID)
name string Projektname
description string Rich-Text-Beschreibung (nullable)
board_id string Übergeordnete Board-UUID
position string Reihenfolge-Position (LexoRank)
num_tasks_open number Anzahl offener Aufgaben (Status 0)
num_tasks_in_progress number Anzahl in Bearbeitung befindlicher Aufgaben (Status 1)
num_tasks_done number Anzahl erledigter Aufgaben (Status 2)
num_tasks_total number Gesamtanzahl der Aufgaben
progress number Abschlussverhältnis (0.0 bis 1.0)
created_at string ISO 8601 Zeitstempel
updated_at string ISO 8601 Zeitstempel

Aufgaben-Statuswerte

Wert Status Beschreibung
0 Offen Noch nicht begonnen
1 In Bearbeitung Wird derzeit bearbeitet
2 Erledigt Abgeschlossen

Projekte auflisten

Um alle Projekte aufzulisten, verwenden Sie den Board-Endpunkt:

curl https://api.kanman.de/v1/boards/:boardId/projects \
  -H "Authorization: Bearer km_ihr_api_token"

Siehe Boards API für Details.

Hinweise

  • Die Projekte API ist derzeit schreibgeschützt für Listen-/Abruf-Operationen
  • Erstellen/Aktualisieren-Operationen sind über die Aufgaben API verfügbar (Aufgaben werden innerhalb von Projekten erstellt)
  • Vollständiges Projekt-CRUD ist in der Web-Oberfläche verfügbar

Verwandte Themen

Zuletzt aktualisiert: January 1, 0001

Kanman testen