Alle benutzerdefinierten Felder auflisten

Abrufen einer paginierten Liste von benutzerdefinierten Feldern für ein Projekt oder mehrere Projekte mit Filter- und Sortieroptionen

Alle benutzerdefinierten Felder auflisten

Benutzerdefinierte Felder ermöglichen es Ihnen, die Standarddatensatzstruktur von Blue mit zusätzlichen Datenfeldern zu erweitern, die spezifisch auf Ihre geschäftlichen Bedürfnisse zugeschnitten sind. Dieser Endpunkt ruft die in Ihren Projekten verfügbaren benutzerdefinierten Felder ab, mit Filterung nach Feldtyp und Unterstützung für die Paginierung.

Einfaches Beispiel

query ListCustomFields {
  customFields(
    filter: { projectId: "project_123" }
    sort: position_ASC
    take: 20
  ) {
    items {
      id
      uid
      name
      type
      position
    }
    pageInfo {
      totalItems
      hasNextPage
    }
  }
}

Fortgeschrittenes Beispiel

query ListCustomFieldsAdvanced {
  customFields(
    filter: {
      projectId: "project_123"
      types: [TEXT_SINGLE, NUMBER, SELECT_SINGLE]
    }
    sort: name_ASC
    skip: 20
    take: 50
  ) {
    items {
      id
      uid
      name
      type
      position
      description
      
      # Type-specific fields
      min              # For NUMBER, RATING, PERCENT
      max              # For NUMBER, RATING, PERCENT
      currency         # For CURRENCY type
      prefix           # For UNIQUE_ID type
      isDueDate        # For DATE type
      formula          # For FORMULA type
      
      # Validation settings
      editable
      metadata
      
      # For SELECT types
      customFieldOptions {
        id
        title
        color
        position
      }
    }
    pageInfo {
      totalItems
      hasNextPage
      hasPreviousPage
    }
  }
}

Eingabeparameter

CustomFieldFilterInput

Parameter	Typ	Erforderlich	Beschreibung
`projectId`	String	Nein	Nach spezifischer Projekt-ID filtern
`types`	[CustomFieldType!]	Nein	Nach benutzerdefinierten Feldtypen filtern

CustomFieldSort-Werte

Wert	Beschreibung
`name_ASC`	Nach Namen aufsteigend sortieren (A-Z)
`name_DESC`	Nach Namen absteigend sortieren (Z-A)
`createdAt_ASC`	Nach Erstellungsdatum sortieren (älteste zuerst)
`createdAt_DESC`	Nach Erstellungsdatum sortieren (neueste zuerst)
`position_ASC`	Nach Position sortieren (Standard)
`position_DESC`	Nach Position absteigend sortieren

CustomFieldType-Werte

Wert	Beschreibung
`TEXT_SINGLE`	Eingabefeld für einzeilige Texte
`TEXT_MULTI`	Eingabefeld für mehrzeilige Texte
`SELECT_SINGLE`	Dropdown für eine Auswahl
`SELECT_MULTI`	Dropdown für mehrere Auswahlmöglichkeiten
`CHECKBOX`	Boolean-Checkbox-Feld
`RATING`	Sternebewertung (1-5 oder benutzerdefinierter Bereich)
`PHONE`	Telefonnummer mit Validierung
`NUMBER`	Numerische Eingabe
`CURRENCY`	Währungsbetrag
`PERCENT`	Prozentwert
`EMAIL`	E-Mail-Adresse mit Validierung
`URL`	Web-URL mit Validierung
`UNIQUE_ID`	Automatisch generierte eindeutige Kennung
`LOCATION`	Geografischer Standort (Breitengrad/Längengrad)
`FILE`	Dateianhang
`DATE`	Datumsauswahl
`COUNTRY`	Länderauswahl
`FORMULA`	Berechnetes Feld basierend auf anderen Feldern
`REFERENCE`	Verknüpfung zu Datensätzen in einem anderen Projekt
`LOOKUP`	Daten aus referenzierten Datensätzen abrufen
`TIME_DURATION`	Zeitverfolgungsfeld
`BUTTON`	Handlungsfeld für Schaltflächen
`CURRENCY_CONVERSION`	Währungsumrechnungsfeld

Paginierungsparameter

Parameter	Typ	Erforderlich	Beschreibung
`skip`	Int	Nein	Anzahl der zu überspringenden Elemente (Standard: 0)
`take`	Int	Nein	Anzahl der zurückzugebenden Elemente (Standard: 20, max: 500)

Antwortfelder

CustomField

Feld	Typ	Beschreibung
`id`	String!	Eindeutige Kennung
`uid`	String!	Eindeutige benutzerfreundliche ID
`name`	String!	Anzeigename des Feldes
`type`	CustomFieldType!	Typ des benutzerdefinierten Feldes
`position`	Float!	Sortierreihenfolge
`description`	String	Optionale Feldbeschreibung
`min`	Float	Mindestwert (ZAHL, BEWERTUNG, PROZENT)
`max`	Float	Höchstwert (ZAHL, BEWERTUNG, PROZENT)
`currency`	String	Währungscode (WÄHRUNG-Typ)
`prefix`	String	Präfix für die GENERIERUNG von EINEDEUTIGEN_IDs
`isDueDate`	Boolean	Ob das DATUM-Feld ein Fälligkeitsdatum darstellt
`formula`	JSON	Formelkonfiguration (FORMEL-Typ)
`editable`	Boolean	Ob der aktuelle Benutzer dieses Feld bearbeiten kann
`metadata`	JSON	Zusätzliche Feldkonfiguration
`customFieldOptions`	[CustomFieldOption!]	Verfügbare Optionen für SELECT-Typen

CustomFieldOption

Feld	Typ	Beschreibung
`id`	String!	Eindeutige Kennung
`title`	String!	Anzeigetext für die Option
`color`	String!	Hex-Farbcode
`position`	Float!	Sortierreihenfolge

PageInfo

Feld	Typ	Beschreibung
`totalItems`	Int	Gesamtanzahl der benutzerdefinierten Felder
`hasNextPage`	Boolean!	Ob weitere Seiten existieren
`hasPreviousPage`	Boolean!	Ob vorherige Seiten existieren
`endCursor`	String	Cursor für die Paginierung (veraltet - verwenden Sie die offset-basierte Paginierung)

Erforderliche Berechtigungen

Benutzerdefinierte Felder sind basierend auf Ihrer Projektrolle zugänglich. Wenn Sie eine benutzerdefinierte Rolle mit eingeschränktem Feldzugriff haben, werden nur die Felder zurückgegeben, die für Ihre Rolle als bearbeitbar markiert sind.

Rolle	Kann benutzerdefinierte Felder auflisten
`OWNER`	✅ Ja (alle Felder)
`ADMIN`	✅ Ja (alle Felder)
`MEMBER`	✅ Ja (basierend auf den Berechtigungen der Rolle)
`CLIENT`	✅ Ja (basierend auf den Berechtigungen der Rolle)

Fehlermeldungen

Projekt nicht gefunden

{
  "errors": [{
    "message": "Project not found.",
    "extensions": {
      "code": "PROJECT_NOT_FOUND"
    }
  }]
}

Ungültiger Feldtyp

{
  "errors": [{
    "message": "Variable \"$filter\" got invalid value \"INVALID_TYPE\" at \"filter.types[0]\"; Value \"INVALID_TYPE\" does not exist in \"CustomFieldType\" enum.",
    "extensions": {
      "code": "GRAPHQL_VALIDATION_FAILED"
    }
  }]
}

Wichtige Hinweise

Benutzerdefinierte Felder sind auf Projekte beschränkt - Sie müssen eine projectId im Filter angeben
Der take-Parameter ist auf 500 Elemente pro Anfrage begrenzt, um die Leistung zu optimieren
Felder werden basierend auf den Benutzerberechtigungen zurückgegeben - benutzerdefinierte Rollen können eingeschränkten Zugriff haben
Die Standard-Sortierreihenfolge erfolgt nach position aufsteigend, was der Reihenfolge entspricht, die in der Benutzeroberfläche angezeigt wird
Diese Abfrage unterstützt die Filterung nach einem einzelnen Projekt - für Abfragen über mehrere Projekte verwenden Sie die geschachtelte CustomFieldQueries-Schnittstelle
Einige Feldtypen (wie FORMEL und REFERENZ) können zusätzliche geschachtelte Datenstrukturen enthalten
Das editable-Feld gibt an, ob der aktuelle Benutzer die Werte für dieses benutzerdefinierte Feld ändern kann