Dokumentacja dla programistów
Tagi
Dokumentacja API (rdzeń)Dokumentacja API
Tagi to obiekty, które pozwalają grupować elementy z różnych grup lub tablic na koncie za pomocą wspólnego słowa kluczowego. Publiczne tagi są widoczne na tablicach głównych i domyślnie dostępne dla wszystkich członków oraz osób z uprawnieniami do przeglądania. Prywatne tagi są widoczne tylko na tablicach prywatnych lub z możliwością udostępniania. Tagi są tworzone i wyświetlane w kolumnie tagów.
Zapytania
Pobieranie tagów
- Wymagany zakres:
tags:read - Zwraca tablicę zawierającą metadane jednego lub wielu publicznych tagów na koncie.
- Można wykonać zapytanie bezpośrednio na poziomie głównym lub zagnieździć je w
boards(zwraca tylko tagi przechowywane na tablicach prywatnych lub z możliwością udostępniania).
query {
boards(ids: 1234567890) {
tags {
id
}
}
}
Argumenty
| Argument | Typ | Opis |
|---|---|---|
| ids | [ID!] |
Unikalne identyfikatory tagów, które mają zostać zwrócone. W przypadku identyfikatorów prywatnych tagów zwracany jest pusty wynik. |
Pola
| Pole | Typ | Opis |
|---|---|---|
| color | String! |
Kolor tagu. |
| id | Int! |
Unikalny identyfikator tagu. |
| name | String! |
Nazwa tagu. |
Mutacje
Wymagany zakres:boards:write
Tworzenie tagu lub pobieranie jego danych
Tworzy nowe tagi lub pobiera ich dane, jeśli już istnieją. Zwraca Tag.
Po utworzeniu tag pojawi się w interfejsie dopiero po użyciu go co najmniej raz.
mutation {
create_or_get_tag(
tag_name: "My tag"
) {
id
}
}
Argumenty
| Argument | Typ | Opis |
|---|---|---|
| board_id | ID |
Unikalny identyfikator tablicy z możliwością udostępniania lub prywatnej, na której ma zostać utworzony tag. Jeśli chcesz utworzyć tag publiczny, nie używaj tego argumentu. |
| tag_name | String |
Nazwa nowego tagu. |
Aktualizowanie kolumny tagów
Mutacja change_column_value pozwala zmienić wartość kolumny za pomocą API. Sprawdź dokumentację typu kolumny tagów, aby poznać prawidłowy format!