Użyj tego narzędzia, aby sprawdzić informacje dotyczące konkretnego typu kolumny przed rozpoczęciem pracy z nią. Narzędzie działa w dwóch trybach, wybieranych za pomocą parametru fetchMode:

• schema (domyślny): Zwraca pełny schemat JSON obiektu ustawień kolumny. Użyj tego trybu przed wywołaniem create_column, aby sprawdzić dostępne opcje konfiguracji i prawidłowe wartości.
• guidelines: Zwraca tylko wytyczne dotyczące filtrowania i agregacji dla danego typu kolumny. Użyj tego trybu przed przygotowaniem filters dla get_board_items_page lub aggregations dla board_insights - bez wykonywania zapytania do GraphQL.

Możesz użyć tego narzędzia dla dowolnego z ponad 40 obsługiwanych typów kolumn, w tym status, date, numbers, people, text, dropdown, timeline, formula i innych.

Parametry

Przykład

Pobierz schemat ustawień dla typu kolumny status:

{
  "columnType": "status",
  "fetchMode": "schema"
}

Odpowiedź zawierała obiekt JSON Schema opisujący strukturę właściwości settings dla kolumny statusu. Definiował on tablicę labels (maksymalnie 40 elementów), w której każda etykieta wymagała pola id (jednej z 40 prawidłowych wartości liczbowych), ciągu znaków label (maksymalnie 30 znaków), pola color (nazwy lub identyfikatora liczbowego z wyliczenia StatusColumnColors) oraz pola index. Opcjonalne pola to description, is_deactivated i is_done.

Odpowiednik programistyczny

Dokumentację dotyczącą formatu wartości i struktury ustawień każdego typu kolumny znajdziesz w dokumentacji typów kolumn GraphQL API:

query {
  boards(ids: [18392419286]) {
    columns {
      id
      type
      settings_str
    }
  }
}

Pełną dokumentację znajdziesz w dokumentacji typów kolumn.