Hämta en paginerad lista över anpassade fält för ett projekt eller över flera projekt med filtrerings- och sorteringsalternativ
Lista alla anpassade fält
Anpassade fält gör att du kan utöka Blues standardpoststruktur med ytterligare datafält som är specifika för dina affärsbehov. Denna slutpunkt hämtar anpassade fält som är tillgängliga i dina projekt, med filtrering efter fälttyp och stöd för paginering.
Grundläggande exempel
query ListCustomFields {
customFields(
filter: { projectId: "project_123" }
sort: position_ASC
take: 20
) {
items {
id
uid
name
type
position
}
pageInfo {
totalItems
hasNextPage
}
}
}
Avancerat exempel
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
}
}
}
Indataparametrar
Parameter |
Typ |
Obligatorisk |
Beskrivning |
projectId |
String |
Nej |
Filtrera efter specifik projekt-ID |
types |
[CustomFieldType!] |
Nej |
Filtrera efter anpassade fälttyper |
CustomFieldSort-värden
Värde |
Beskrivning |
name_ASC |
Sortera efter namn stigande (A-Z) |
name_DESC |
Sortera efter namn fallande (Z-A) |
createdAt_ASC |
Sortera efter skapelsedatum (äldst först) |
createdAt_DESC |
Sortera efter skapelsedatum (nyast först) |
position_ASC |
Sortera efter position (standard) |
position_DESC |
Sortera efter position fallande |
CustomFieldType-värden
Värde |
Beskrivning |
TEXT_SINGLE |
En rad textinmatning |
TEXT_MULTI |
Flera rader textområde |
SELECT_SINGLE |
Enkeltval rullgardinsmeny |
SELECT_MULTI |
Flera val rullgardinsmeny |
CHECKBOX |
Boolesk kryssfält |
RATING |
Stjärnbetyg (1-5 eller anpassat intervall) |
PHONE |
Telefonnummer med validering |
NUMBER |
Numerisk inmatning |
CURRENCY |
Valuta belopp |
PERCENT |
Procentvärde |
EMAIL |
E-postadress med validering |
URL |
Webbadress med validering |
UNIQUE_ID |
Automatgenererad unik identifierare |
LOCATION |
Geografisk plats (lat/lng) |
FILE |
Filbilaga |
DATE |
Datumväljare |
COUNTRY |
Landväljare |
FORMULA |
Beräknat fält baserat på andra fält |
REFERENCE |
Länk till poster i ett annat projekt |
LOOKUP |
Hämta data från refererade poster |
TIME_DURATION |
Tidsregistreringsfält |
BUTTON |
Handlingsbar knappfält |
CURRENCY_CONVERSION |
Valutakonverteringsfält |
Paginering Parametrar
Parameter |
Typ |
Obligatorisk |
Beskrivning |
skip |
Int |
Nej |
Antal objekt att hoppa över (standard: 0) |
take |
Int |
Nej |
Antal objekt att returnera (standard: 20, max: 500) |
Svarsfält
CustomField
Fält |
Typ |
Beskrivning |
id |
String! |
Unik identifierare |
uid |
String! |
Unik användarvänlig ID |
name |
String! |
Visningsnamn för fältet |
type |
CustomFieldType! |
Typ av det anpassade fältet |
position |
Float! |
Sorteringsordning |
description |
String |
Valfri fältbeskrivning |
min |
Float |
Minsta värde (NUMMER, BETYG, PROCENT) |
max |
Float |
Största värde (NUMMER, BETYG, PROCENT) |
currency |
String |
Valutakod (VALUTA typ) |
prefix |
String |
Prefix för GENERERING AV UNIK_ID |
isDueDate |
Boolean |
Om DATUM-fältet representerar ett förfallodatum |
formula |
JSON |
Formelkonfiguration (FORMEL typ) |
editable |
Boolean |
Om nuvarande användare kan redigera detta fält |
metadata |
JSON |
Ytterligare fältkonfiguration |
customFieldOptions |
[CustomFieldOption!] |
Tillgängliga alternativ för VÄLJ typer |
CustomFieldOption
Fält |
Typ |
Beskrivning |
id |
String! |
Unik identifierare |
title |
String! |
Visningstext för alternativet |
color |
String! |
Hex färgkod |
position |
Float! |
Sorteringsordning |
PageInfo
Fält |
Typ |
Beskrivning |
totalItems |
Int |
Totalt antal anpassade fält |
hasNextPage |
Boolean! |
Om fler sidor finns |
hasPreviousPage |
Boolean! |
Om tidigare sidor finns |
endCursor |
String |
Markör för paginering (föråldrad - använd offset-baserad paginering) |
Obligatoriska behörigheter
Anpassade fält är tillgängliga baserat på din projektroll. Om du har en anpassad roll med begränsad fältåtkomst kommer endast fält som är markerade som redigerbara för din roll att returneras.
Roll |
Kan lista anpassade fält |
OWNER |
✅ Ja (alla fält) |
ADMIN |
✅ Ja (alla fält) |
MEMBER |
✅ Ja (baserat på rollbehörigheter) |
CLIENT |
✅ Ja (baserat på rollbehörigheter) |
Felrespons
Projekt hittades inte
{
"errors": [{
"message": "Project not found.",
"extensions": {
"code": "PROJECT_NOT_FOUND"
}
}]
}
Ogiltig fälttyp
{
"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"
}
}]
}
Viktiga anteckningar
- Anpassade fält är begränsade till projekt - du måste specificera en
projectId
i filtret
- Parametern
take
är begränsad till 500 objekt per begäran för prestanda
- Fält returneras baserat på användarbehörigheter - anpassade roller kan ha begränsad åtkomst
- Standard sorteringsordning är efter
position
stigande, vilket återspeglar den ordning som visas i användargränssnittet
- Denna fråga stöder filtrering av ett enda projekt - för flerprojektfrågor, använd det inbäddade CustomFieldQueries-gränssnittet
- Vissa fälttyper (som FORMEL och REFERENS) kan innehålla ytterligare inbäddade datastrukturer
- Fältet
editable
indikerar om den aktuella användaren kan ändra värden för detta anpassade fält
Relaterade slutpunkter