Projekte mit der Blue API erstellen.


Ein neues Projekt erstellen

Um ein neues Projekt zu erstellen, können Sie die folgende Mutation verwenden:

mutation {
  createProject(
    input: {
      name: "YOUR PROJECT NEW NAME"
      companyId: "YOUR COMPANY ID OR SLUG"
      description: "Project description"
      color: "#3B82F6"
      icon: "briefcase"
      category: GENERAL
    }
  ) {
    id
    name
    slug
    description
    color
    icon
    category
  }
}
icon: lightbulb

Denken Sie daran, die erforderlichen Header in Ihrer Anfrage einzuschließen:

- `X-Bloo-Token-ID`: Ihre API-Token-ID
- `X-Bloo-Token-Secret`: Ihr API-Token-Geheimnis
- `X-Bloo-Company-ID`: Ihre Unternehmens-ID
- `Content-Type: application/json`

Antwortbeispiel

Bei Erfolg gibt die Mutation die Details des neu erstellten Projekts zurück:

{
  "data": {
    "createProject": {
      "id": "newly-created-project-id",
      "name": "YOUR PROJECT NEW NAME",
      "slug": "your-project-new-name",
      "description": "Project description",
      "color": "#3B82F6",
      "icon": "briefcase",
      "category": "GENERAL"
    }
  }
}

Aus einer Vorlage erstellen

Um ein Projekt aus einer vorhandenen Vorlage zu erstellen, können Sie eine optionale templateId zur Mutation hinzufügen.

mutation {
  createProject(
    input: {
      templateId: "YOUR TEMPLATE ID OR SLUG"
      name: "YOUR PROJECT NEW NAME"
      companyId: "YOUR COMPANY ID OR SLUG"
    }
  ) {
    id
  }
}
Das Erstellen eines Projekts aus einer Vorlage wird das Projekt nicht sofort erstellen. Stattdessen wird Ihre Projektcreation in die Warteschlange gestellt.

Fortgeschrittenes Beispiel mit Vorlage

Hier ist ein vollständiges Beispiel, das alle verfügbaren Optionen beim Erstellen aus einer Vorlage zeigt:

mutation {
  createProject(
    input: {
      templateId: "marketing-template"
      name: "Q1 Marketing Campaign"
      companyId: "acme-corp"
      description: "Marketing initiatives for Q1 2024"
      color: "#10B981"
      icon: "megaphone"
      category: MARKETING
      coverConfig: {
        enabled: true
        fit: COVER
        imageSelectionType: FIRST
        source: DESCRIPTION
      }
    }
  ) {
    id
    name
    slug
    description
    color
    icon
    category
  }
}
icon: warning
Der `coverConfig` Parameter funktioniert derzeit nur beim Erstellen eines Projekts aus einer Vorlage. Für Projekte, die von Grund auf neu erstellt werden, müssen Sie die `editProject` Mutation nach der Erstellung verwenden, um Todo-Coverbilder zu konfigurieren.

Status der Erstellung überprüfen

Um den Status Ihrer Projektcreation in der Warteschlange zu überprüfen, können Sie die folgende Abfrage verwenden:

query {
  copyProjectStatus {
    newProjectName
    isTemplate
    isActive
    queuePosition
    totalQueues
  }
}

Diese Abfrage gibt den Status Ihrer Projektcreation in der Warteschlange zurück.

Eingabeparameter

CreateProjectInput

Parameter Typ Erforderlich Beschreibung
name String ✅ Ja Der Projektname. URLs werden aus dem Namen entfernt.
companyId String ✅ Ja Die ID oder der Slug des Unternehmens, in dem das Projekt erstellt wird.
description String Nein Eine Beschreibung des Projekts.
color String Nein Projektfarbe im Hex-Format (z.B. "#3B82F6").
icon String Nein Icon-Identifikator für das Projekt (z.B. "aktentasche", "rakete").
category ProjectCategory Nein Projektkategorie. Standardmäßig auf GENERAL, wenn nicht angegeben.
templateId String Nein ID eines bestehenden Projekts, das als Vorlage verwendet werden soll.
coverConfig TodoCoverConfigInput Nein Konfiguration für Todo-Coverbilder (funktioniert derzeit nur bei vorlagenbasiertem Erstellen).

Projektkategorie-Werte

Wert Beschreibung
CRM Projekte im Bereich Kundenbeziehungsmanagement
CROSS_FUNCTIONAL Projekte von funktionsübergreifenden Teams
CUSTOMER_SUCCESS Initiativen zum Kundenerfolg
DESIGN Design- und Kreativprojekte
ENGINEERING Ingenieur- und Entwicklungsprojekte
GENERAL Allgemeine Projekte (Standard)
HR Projekte im Bereich Personalwesen
IT Projekte im Bereich Informationstechnologie
MARKETING Marketingkampagnen und -initiativen
OPERATIONS Projekte im Bereich Betrieb und Logistik
PRODUCT Projekte im Bereich Produktmanagement
SALES Projekte im Bereich Vertrieb und Geschäftsentwicklung

TodoCoverConfigInput

Wenn Sie konfigurieren möchten, wie Todo-Coverbilder in Ihrem Projekt funktionieren, können Sie den coverConfig Parameter angeben:

Parameter Typ Erforderlich Beschreibung
enabled Boolean ✅ Ja Ob Coverbilder für Todos aktiviert sind
fit ImageFit ✅ Ja Wie Bilder im Coverbereich passen sollen
imageSelectionType ImageSelectionType ✅ Ja Welches Bild aus den verfügbaren Optionen ausgewählt werden soll
source ImageSource ✅ Ja Wo Bilder hergezogen werden sollen
sourceId String Nein Spezifischer Quellidentifikator (z.B. ID eines benutzerdefinierten Feldes)

Werte für ImageFit: COVER, CONTAIN, FILL, SCALE_DOWN

Werte für ImageSelectionType: FIRST (erstes Bild), LAST (letztes Bild)

Werte für ImageSource: DESCRIPTION (aus der Todo-Beschreibung), COMMENTS (aus Kommentaren), CUSTOM_FIELD (aus einem benutzerdefinierten Feld)

Antwortfelder

Die createProject-Mutation gibt ein Projektobjekt mit den folgenden verfügbaren Feldern zurück:

Feld Typ Beschreibung
id ID! Eindeutiger Identifikator für das Projekt
name String! Projektname
slug String! URL-freundlicher Projektidentifikator
description String Projektbeschreibung
color String Projektfarbe im Hex-Format
icon String Icon-Identifikator
category ProjectCategory Projektkategorie-Enum-Wert
companyId String! ID des Unternehmens
createdAt DateTime! Zeitstempel der Erstellung
updatedAt DateTime! Zeitstempel der letzten Aktualisierung
archived Boolean! Ob das Projekt archiviert ist
isTemplate Boolean! Ob dies ein Vorlagenprojekt ist

Hinweis: Sie können jede Kombination dieser Felder in Ihrer Antwort anfordern.

Wichtige Hinweise

  • Sie müssen OWNER, ADMIN oder MEMBER Zugriff auf Unternehmensebene haben, um Projekte zu erstellen
  • Beim Erstellen aus einer Vorlage darf die Vorlage nicht mehr als 250.000 Todos enthalten
  • Der erstellende Benutzer wird automatisch als Projekt OWNER zugewiesen
  • Projektnamen werden automatisch von Leerzeichen befreit
  • Der coverConfig Parameter ist derzeit nur beim Erstellen aus einer Vorlage funktionsfähig

Fehlermeldungen

Unternehmen nicht gefunden

{
  "errors": [{
    "message": "Company not found",
    "extensions": {
      "code": "NOT_FOUND"
    }
  }]
}

Vorlage nicht gefunden

{
  "errors": [{
    "message": "Template not found",
    "extensions": {
      "code": "NOT_FOUND"
    }
  }]
}

Vorlage zu groß

{
  "errors": [{
    "message": "Template cannot have more than 250000 todos",
    "extensions": {
      "code": "VALIDATION_ERROR"
    }
  }]
}

Berechtigung verweigert

{
  "errors": [{
    "message": "You do not have permission to create projects in this company",
    "extensions": {
      "code": "FORBIDDEN"
    }
  }]
}

KI-Assistent

Antworten werden mit KI generiert und können Fehler enthalten.

Wie kann ich Ihnen helfen?

Fragen Sie mich alles über Blue oder diese Dokumentation.

Eingabe zum Senden • Shift+Eingabe für neue Zeile • ⌘I zum Öffnen