Dokumentacja dla programistów
Funkcje
API aplikacjiDokumentacja API
Wszystkie aplikacje zbudowane w oparciu o framework aplikacji monday.com składają się z funkcji. To one określają, gdzie aplikacja pojawia się w interfejsie, jakich metod wymaga jej utworzenie i jakie ma możliwości. Funkcje tworzy się i zarządza nimi w Developer Center.
Zapytania
Pobieranie funkcji
- Zwraca obiekt zawierający metadane funkcji aplikacji.
- Musi być zagnieżdżone w zapytaniu
app.
query {
app(id:123456) {
features(limit:2) {
created_at
data
id
name
}
}
}
Argumenty
| Argument | Typ | Opis |
|---|---|---|
| limit | Int |
Liczba funkcji do zwrócenia. Domyślnie wynosi 25. |
| page | Int |
Numer strony do zwrócenia. Numeracja zaczyna się od 1. |
Pola
| Pole | Typ | Opis |
|---|---|---|
| app_id | ID |
Unikalny identyfikator aplikacji, do której należy funkcja. |
| created_at | Date |
Data utworzenia funkcji aplikacji. |
| data | JSON |
Dane funkcji aplikacji. Pola ikon i logo (iconUrl, logoUrl itp., w tym zagnieżdżone headerConfig.*.iconUrl) muszą zawierać adresy URL HTTPS lub nazwy ikon Vibe. |
| id | ID! |
Unikalny identyfikator funkcji aplikacji. |
| name | String |
Nazwa funkcji aplikacji. |
| type | String |
Typ funkcji aplikacji. |
| updated_at | Date |
Data ostatniej aktualizacji funkcji aplikacji. |
Mutacje
Tworzenie funkcji aplikacji
Tworzy funkcję aplikacji. Zwraca AppFeatureType.
mutation {
create_app_feature(
slug: "test-item-view",
app_id: 9876543210,
type: ITEM_VIEW
) {
id
name
}
}
Argumenty
| Argument | Typ | Opis |
|---|---|---|
| app_id | ID! |
Unikalny identyfikator aplikacji, dla której tworzona jest nowa funkcja. |
| app_version_id | ID |
Unikalny identyfikator wersji aplikacji, dla której tworzona jest nowa funkcja. |
| data | JSON |
Dane funkcji aplikacji. Ich struktura zależy od typu funkcji. Każde pole iconUrl/logoUrl/thumbnailUrl (w tym zagnieżdżone w headerConfig) musi zawierać adres URL HTTPS lub nazwę ikony Vibe. |
| deployment | AppFeatureReleaseInput |
Dane wdrożenia nowej funkcji aplikacji. |
| name | String |
Nazwa nowej funkcji aplikacji. |
| slug | String! |
Unikalny identyfikator slug nowej funkcji aplikacji. |
| type | AppFeatureTypeE! |
Typ nowej funkcji aplikacji. |
Aktualizowanie funkcji aplikacji
Aktualizuje funkcję aplikacji. Zwraca AppFeatureType.
mutation {
update_app_feature(
id: 12345,
input: {
data: {
name: "Updated App Feature",
description: "This is an updated app feature description."
}
deployment: {
kind: CLIENT_SIDE_CODE,
data: {
url: "/sub-route"
}
}
}
) {
id
name
data
}
}
Argumenty
| Argument | Typ | Opis |
|---|---|---|
| id | ID! |
Unikalny identyfikator funkcji aplikacji. |
| input | UpdateAppFeatureInput! |
Dane wejściowe aktualizowanej funkcji aplikacji. |