Projecten maken met de Blue API.


Maak een Nieuw Project

Om een nieuw project te maken, kun je de volgende mutatie gebruiken:

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

Vergeet niet de vereiste headers in je verzoek op te nemen:

- `X-Bloo-Token-ID`: Je API-token ID
- `X-Bloo-Token-Secret`: Je API-token geheim
- `X-Bloo-Company-ID`: Je bedrijfs-ID
- `Content-Type: application/json`

Voorbeeld van een Antwoord

Bij succes zal de mutatie de details van het nieuw aangemaakte project retourneren:

{
  "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"
    }
  }
}

Maak vanuit een Sjabloon

Om een project vanuit een bestaand sjabloon te maken, kun je een optionele templateId aan de mutatie toevoegen.

mutation {
  createProject(
    input: {
      templateId: "YOUR TEMPLATE ID OR SLUG"
      name: "YOUR PROJECT NEW NAME"
      companyId: "YOUR COMPANY ID OR SLUG"
    }
  ) {
    id
  }
}
Het maken van een project vanuit een sjabloon zal het project niet onmiddellijk aanmaken. In plaats daarvan zal je projectcreatie in de wachtrij worden geplaatst.

Geavanceerd Voorbeeld met Sjabloon

Hier is een compleet voorbeeld dat alle beschikbare opties toont bij het maken vanuit een sjabloon:

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
De `coverConfig` parameter werkt momenteel alleen bij het maken van een project vanuit een sjabloon. Voor projecten die vanaf nul zijn gemaakt, moet je de `editProject` mutatie na de creatie gebruiken om todo-coverafbeeldingen te configureren.

Controleer de Creatiestatus

Om de status van je projectcreatie in de wachtrij te controleren, kun je de volgende query gebruiken:

query {
  copyProjectStatus {
    newProjectName
    isTemplate
    isActive
    queuePosition
    totalQueues
  }
}

Deze query zal de status van je projectcreatie in de wachtrij retourneren.

Invoervariabelen

CreateProjectInput

Parameter Type Vereist Beschrijving
name String ✅ Ja De projectnaam. URL's worden uit de naam verwijderd.
companyId String ✅ Ja De ID of slug van het bedrijf waar het project zal worden aangemaakt.
description String Nee Een beschrijving van het project.
color String Nee Projectkleur in hex-formaat (bijv. "#3B82F6").
icon String Nee Pictogram-ID voor het project (bijv. "koffer", "raket").
category ProjectCategory Nee Projectcategorie. Standaard op GENERAL als niet gespecificeerd.
templateId String Nee ID van een bestaand project om als sjabloon te gebruiken.
coverConfig TodoCoverConfigInput Nee Configuratie voor todo-coverafbeeldingen (werkt momenteel alleen met sjabloon-gebaseerde creatie).

ProjectCategory Waarden

Waarde Beschrijving
CRM Klantrelatiebeheerprojecten
CROSS_FUNCTIONAL Cross-functionele teamprojecten
CUSTOMER_SUCCESS Klantensuccessen
DESIGN Ontwerp- en creatieve projecten
ENGINEERING Engineering- en ontwikkelingsprojecten
GENERAL Algemene projecten (standaard)
HR Human Resources-projecten
IT Informatie Technologie-projecten
MARKETING Marketingcampagnes en initiatieven
OPERATIONS Operaties en logistiek projecten
PRODUCT Productmanagementprojecten
SALES Verkoop- en bedrijfsontwikkelingsprojecten

TodoCoverConfigInput

Als je wilt configureren hoe todo-coverafbeeldingen in je project werken, kun je de coverConfig parameter opgeven:

Parameter Type Vereist Beschrijving
enabled Boolean ✅ Ja Of coverafbeeldingen zijn ingeschakeld voor todo's
fit ImageFit ✅ Ja Hoe afbeeldingen in het covergebied moeten passen
imageSelectionType ImageSelectionType ✅ Ja Welke afbeelding moet worden geselecteerd uit beschikbare opties
source ImageSource ✅ Ja Waar de afbeeldingen vandaan moeten komen
sourceId String Nee Specifieke bron-ID (bijv. ID van aangepast veld)

ImageFit Waarden: COVER, CONTAIN, FILL, SCALE_DOWN

ImageSelectionType Waarden: FIRST (eerste afbeelding), LAST (laatste afbeelding)

ImageSource Waarden: DESCRIPTION (van todo-beschrijving), COMMENTS (van opmerkingen), CUSTOM_FIELD (van een aangepast veld)

Antwoordvelden

De createProject mutatie retourneert een Project-object met de volgende beschikbare velden:

Veld Type Beschrijving
id ID! Unieke identificatie voor het project
name String! Projectnaam
slug String! URL-vriendelijke projectidentificatie
description String Projectbeschrijving
color String Projectkleur in hex-formaat
icon String Pictogram-ID
category ProjectCategory Projectcategorie enumwaarde
companyId String! ID van het bedrijf
createdAt DateTime! Aanmaak-timestamp
updatedAt DateTime! Laatste update-timestamp
archived Boolean! Of het project is gearchiveerd
isTemplate Boolean! Of dit een sjabloonproject is

Opmerking: Je kunt elke combinatie van deze velden in je antwoord aanvragen.

Belangrijke Opmerkingen

  • Je moet OWNER, ADMIN, of MEMBER niveau-toegang tot het bedrijf hebben om projecten te creëren
  • Bij het maken vanuit een sjabloon mag het sjabloon niet meer dan 250.000 todo's bevatten
  • De aanmaakgebruiker wordt automatisch toegewezen als de project OWNER
  • Projectnamen worden automatisch ontdaan van spaties
  • De coverConfig parameter is momenteel alleen functioneel bij het maken vanuit een sjabloon

Foutantwoorden

Bedrijf Niet Gevonden

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

Sjabloon Niet Gevonden

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

Sjabloon Te Groot

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

Toegang Geweigerd

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

AI Assistent

Antwoorden worden gegenereerd met behulp van AI en kunnen fouten bevatten.

Hoe kan ik u helpen?

Vraag me alles over Blue of deze documentatie.

Voer in om te verzenden • Shift+Enter voor nieuwe regel • ⌘I om te openen