Aby zautomatyzować zadania na platformie Workiva w ramach łańcucha, np. w celu umożliwienia wymiany danych z innymi źródłami danych, dodaj krok obejmujący polecenie połączenia z Workiva.
Aby włączyć te polecenia, administrator IT najpierw skonfiguruje łącznik Workiva.
Wyczyść dane arkusza
Aby wyczyścić wszystkie dane w arkuszu, użyj polecenia Wyczyść dane arkusza.
Równoważne wywołanie API:https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, który chcesz wyczyścić. |
| Identyfikator/nazwa arkusza | Wprowadź nazwę lub unikalny identyfikator arkusza, który chcesz wyczyścić. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz plik
Aby przesłać plik z wartościami rozdzielonymi przecinkami (CSV), notację obiektów JavaScript (JSON) lub skompresowany plik ZIP i wyświetlić listę jego rekordów, należy użyć polecenia Create file. Możesz również przesłać adres URL do pliku, np. podpisany przez Amazon S3® adres URL do pliku w kontenerze S3.
- W przypadku pliku JSON musi on zawierać pojedynczy rekord JSON w każdym wierszu — plik JSON to seria obiektów JSON oddzielonych znakiem nowej linii.
- W przypadku pliku ZIP musi on zawierać pojedynczy plik CSV lub JSON, którego nazwa zostanie użyta do nazwania importowanego pliku. Ponowne pobranie pliku spowoduje pobranie źródła.
- W przypadku adresu URL punkt końcowy wysyła żądanie pobrania pliku za pomocą prostego, nieuwierzytelnionego żądania
GET.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator tabeli | Wprowadź identyfikator tabeli, której pliki mają zostać wyświetlone. |
| Plik |
Wprowadź plik, który chcesz przesłać. Zignorowano, jeśli wprowadzono adres URL pobierania. Uwaga: Plik musi mieć rozszerzenie .CSV lub .JSON albo być plikiem ZIP zawierającym plik z rozszerzeniem .CSV lub .JSON. |
| Nazwa | Jeśli wprowadzono Adres URL pobierania, wpisz nazwę pliku do przesłania; domyślnie jest to nazwa podstawowa Adres URL pobierania. |
| Pobierz adres URL |
Wprowadź adres URL wskazujący plik do pobrania, np. adres URL podpisany przez Amazon S3. Opcjonalne, jeśli wprowadzono Plik. Uwaga: Polecenie wykonuje proste żądanie |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wyniki | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz nowe edycje rekordu
Aby utworzyć nowe edycje rekordu na podstawie podanych właściwości, należy użyć polecenia Utwórz nowe edycje rekordu. Każda edycja wymaga co najmniej jednej operacji i targetId.
Limit: Na jedno żądanie można przetworzyć do 1000 edycji.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-createedits/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Działanie |
Wybierz operację, którą chcesz wykonać. Opcje:
|
| Etykieta | Wprowadź etykietę opisującą relację pomiędzy dwoma rekordami. Służy do tworzenia lub usuwania relacji. |
| Właściwości | Wprowadź właściwości związane z typem rekordu. Służy do tworzenia rekordu lub ustawiania jego właściwości. |
| Identyfikator rekordu | Wprowadź identyfikator lub identyfikator tymczasowego rekordu źródła. Służy do tworzenia lub usuwania relacji. |
| Identyfikator celu | Wprowadź identyfikator rekordu docelowego. Tworząc rekord, możesz użyć albo identyfikatora rekordu, albo identyfikatora tymczasowego rekordu. Jeśli usuwasz rekord, musisz użyć faktycznego identyfikatora rekordu. |
| Identyfikator rekordu tymczasowego | Wprowadź tymczasowy identyfikator, który zostanie użyty podczas tworzenia rekordu. Ten tymczasowy identyfikator zostanie zastąpiony w momencie przetwarzania. Możesz użyć tego identyfikatora w tym samym żądaniu, aby utworzyć relacje między utworzonymi rekordami. |
| Typ | Wprowadź typ rekordu, który chcesz utworzyć. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Widok obrotowy | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz widok obrotowy
Aby utworzyć nowy widok Wdata na podstawie zapytania i wyniku zapytania, należy użyć polecenia Create pivot view.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, która ułatwi identyfikację widoku. |
| Identyfikator zapytania | Wprowadź identyfikator zapytania, na podstawie którego chcesz utworzyć widok. |
| Identyfikator wyniku zapytania | Wprowadź identyfikator wyniku zapytania, na podstawie którego chcesz utworzyć widok. |
| Dodatkowe metadane | Wprowadź zdefiniowane przez użytkownika metadane, które mają zostać dołączone do widoku jako obiekt JSON (opcjonalnie). |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Widok obrotowy | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz zapytanie podglądu (przestarzałe)
To polecenie jest przestarzałe, ponieważ punkt końcowy nie jest już obsługiwany.
Utwórz zapytanie
Aby utworzyć nowe zapytanie Wdata, użyj polecenia Create query.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-createquery/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, która ułatwi identyfikację zapytania. |
| Opis | Wprowadź opis zapytania. |
| Identyfikator wyniku podstawowego | Jeśli określono, wprowadź identyfikator domyślnego wyniku, który zostanie wypełniony wynikami zapytania. |
| Tekst zapytania | Wprowadź definicję zapytania w składni Presto SQL, tak jak w edytorze SQL zapytania. |
| Tymczasowy | Aby wygenerować zapytanie tymczasowo, tak aby nie pojawiało się ono w obszarze roboczym, zaznacz to pole. |
| Parametry | Wprowadź parametry wymagane do uruchomienia zapytania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zapytanie | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz rekord
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby utworzyć nowy rekord, należy użyć punktu końcowego Utwórz nowe edycje rekordu.
Utwórz listę wyboru
Aby utworzyć listę wartości dla parametru zapytania wielokrotnego wyboru, należy użyć polecenia Utwórz listę wyboru.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, która ułatwi identyfikację listy wyboru. |
| Opis | Aby ułatwić identyfikację listy wyboru, wprowadź opis jej wartości lub parametru. |
| Typ wartości | Wybierz typ danych wartości listy, np. ciąg znaków lub liczba całkowita. |
| Wartości | Wprowadź wartości listy. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Utwórz metadane listy wyboru | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz arkusz
Aby dodać nowy arkusz do arkusza kalkulacyjnego, należy użyć polecenia Utwórz arkusz.
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, do którego chcesz dodać arkusz. |
| Nazwa | Wprowadź unikalną nazwę, która ułatwi identyfikację arkusza. |
| Indeks arkusza |
Wprowadź indeks nowego arkusza w arkuszu kalkulacyjnym. Uwaga: Domyślnie polecenie dodaje arkusz jako arkusz górny. |
| Identyfikator arkusza rodzica | Wprowadź identyfikator arkusza nadrzędnego, pod którym chcesz utworzyć arkusz. Aby dodać do arkusza głównego, pozostaw puste. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Metadane arkusza | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz arkusz kalkulacyjny
Aby utworzyć nowy arkusz kalkulacyjny, użyj polecenia Utwórz arkusz kalkulacyjny.
Równoważne wywołanie API: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html
Właściwości
| Właściwość | Szczegół |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, która ułatwi identyfikację arkusza kalkulacyjnego. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Metadane arkusza | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz tabelę
Aby utworzyć nową tabelę Wdata w obszarze roboczym, należy użyć polecenia Create table.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-createtable/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, która ułatwi identyfikację tabeli. |
| Opis | Wprowadź opis nowej tabeli. |
| Typ | Wybierz, czy chcesz utworzyć tabelę danych (lub faktów), czy tabelę odnośników (lub wymiarów). |
| Kolumny |
Dodaj kolumny, które mają zostać uwzględnione w tabeli:
|
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Tabela | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń plik
Aby usunąć plik z obszaru roboczego Wdata, użyj polecenia Delete file.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator pliku, który chcesz usunąć. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń widok obrotowy
Aby usunąć widok Wdata z obszaru roboczego, należy użyć polecenia Delete pivot view.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator | Wprowadź identyfikator widoku, który chcesz usunąć. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń zapytanie
Aby usunąć zapytanie Wdata z obszaru roboczego, należy użyć polecenia Delete query.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania, które chcesz usunąć. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń rekord
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby usunąć rekord, użyj polecenia Utwórz nowe edycje rekordu.
Usuń arkusz
Aby usunąć arkusz i jego arkusze podrzędne (rekurencyjnie) z arkusza kalkulacyjnego, należy użyć polecenia Delete sheet.
Równoważne wywołanie API: https://developers.workiva.com/2022-01-01/deletelegacysheet.html
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, który chcesz usunąć. |
| Identyfikator/nazwa arkusza | Wprowadź nazwę lub unikalny identyfikator arkusza, który chcesz usunąć. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń arkusz kalkulacyjny
Aby usunąć arkusz kalkulacyjny z obszaru roboczego, użyj polecenia Usuń arkusz kalkulacyjny.
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, który chcesz usunąć. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń tabelę
Aby usunąć tabelę Wdata z obszaru roboczego, należy użyć polecenia Delete table.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli, którą chcesz usunąć |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz plik
Aby pobrać zbiór danych z obszaru roboczego Wdata, należy użyć polecenia Pobierz plik.
Uwaga: To polecenie nie jest zgodne z innymi typami obiektów, takimi jak arkusze kalkulacyjne, tabele lub zapytania.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator pliku, który chcesz pobrać. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Plik | Plik |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz widok obrotowy (przestarzały)
To polecenie jest przestarzałe, ponieważ punkt końcowy nie jest już obsługiwany.
Pobierz wynik zapytania
Aby pobrać wyniki zapytania Wdata do pliku, należy użyć polecenia Pobierz wynik zapytania.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator wyniku zapytania | Wprowadź identyfikator wyniku zapytania, który chcesz pobrać. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wynik zapytania | Plik |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Edytuj
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby edytować rekord, należy użyć punktu końcowego Utwórz nowe edycje rekordu.
Eksportuj plik do arkusza kalkulacyjnego
Aby wyeksportować zbiór danych z tabeli Wdata do nowego lub istniejącego arkusza kalkulacyjnego, należy użyć polecenia Eksportuj plik do arkusza kalkulacyjnego.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator zestawu danych tabeli, który chcesz wyeksportować. |
| Adres URL arkusza kalkulacyjnego | Wprowadź adres URL arkusza kalkulacyjnego, do którego chcesz wyeksportować dane. Aby utworzyć nowy arkusz kalkulacyjny, pozostaw puste pole. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Informacje o arkuszu | Plik |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Eksportuj wynik zapytania
Aby wyeksportować wynik zapytania Wdata do nowego lub istniejącego arkusza kalkulacyjnego, należy użyć polecenia Export query result.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator wyniku zapytania | Wprowadź identyfikator wyniku zapytania, który chcesz wyeksportować. |
| Adres URL arkusza kalkulacyjnego | Wprowadź adres URL arkusza kalkulacyjnego, do którego chcesz wyeksportować dane. Aby utworzyć nowy arkusz kalkulacyjny, pozostaw puste pole. |
| Eksportuj jako zestaw danych | Po zaznaczeniu tej opcji dane zostaną wyeksportowane jako połączony zestaw danych, a komórki będzie można edytować wyłącznie poprzez aktualizację zestawu danych w arkuszu kalkulacyjnym. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz właściwości pliku
Aby pobrać właściwości pliku z obszaru roboczego Wdata, należy użyć polecenia Pobierz właściwości pliku.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-getfile/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator pliku, aby uzyskać jego właściwości. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Właściwości pliku | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Uzyskaj widok obrotowy
Aby pobrać metadane widoku Wdata, należy użyć polecenia Get pivot view.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator | Wprowadź identyfikator widoku obrotowego, z którego chcesz pobrać metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Widok obrotowy | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz metadane zapytania
Aby pobrać metadane zapytania Wdata, należy użyć polecenia Get query metadata.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-getquery/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania, z którego chcesz pobrać metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zapytanie | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Uzyskaj rekord
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby uzyskać rekord, należy użyć punktu końcowego Pobierz pojedynczy rekord.
Pobierz rekordy
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby pobrać wiele rekordów, należy użyć punktu końcowego Pobierz listę rekordów.
Uzyskaj raporty
Aby pobrać wszystkie raporty z konta bazy danych SOX i audytu wewnętrznego Twojej organizacji, użyj polecenia Get reports.
Równoważne wywołanie API:https://developers.workiva.com/platform-v1/platform-graphreportexport/
Właściwości
Brak
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Raporty | Plik |
| Zgłoś liczbę | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz listę wyboru
Aby pobrać listę wartości dla parametru zapytania wielokrotnego wyboru na podstawie identyfikatora listy, należy użyć polecenia Get select list.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Wybierz identyfikator listy | Wprowadź unikalny identyfikator listy wyboru, którą chcesz pobrać. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Pobierz ładunek listy wyboru | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz dane arkusza
Aby pobrać wszystkie dane z określonego obszaru arkusza, należy użyć polecenia Pobierz dane arkusza.
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, z którego chcesz pobrać dane. |
| Identyfikator/nazwa arkusza | Wprowadź nazwę lub unikalny identyfikator arkusza, z którego chcesz pobrać dane. |
| Region | Wprowadź reprezentację komórki lub zakresu w stylu A1, taką jak [Kolumna początkowa][Wiersz początkowy]:[Kolumna końcowa][Wiersz końcowy]. Aby zakres był nieograniczony w żadnym lub wszystkich kierunkach, należy pominąć odpowiadającą mu kolumnę lub wiersz. |
| Styl wartości | Wybierz, czy zwrócić wartość komórki surową czy obliczoną. Na przykład, jeśli wartość komórki to =1+:1, wybierz opcję Surowe dla =1+1 lub Obliczone dla obliczonej wartości 2. |
| Wersja | Wprowadź wersję arkusza, z którego chcesz pobrać dane. Aby uzyskać wersję bieżącą, wpisz -1. |
| Użyj interfejsu API platformy | Gdy to pole jest zaznaczone, polecenie to zwraca dane arkusza przy użyciu standardowej notacji dziesiętnej.Jeżeli pole jest puste, dane arkusza są zwracane przy użyciu notacji naukowej. Wymusza to użycie przez polecenie funkcji Pobierz dane z punktu końcowego arkusza zamiast funkcji Zwróć dane z punktu końcowego regionu interfejsu API arkusza kalkulacyjnego. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Liczba wierszy | Liczba całkowita |
| Dane | Plik |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz metadane arkusza
Aby pobrać metadane arkusza w arkuszu kalkulacyjnym, należy użyć polecenia Pobierz metadane arkusza.
Równoważne wywołanie API: https://developers.workiva.com/2022-01-01/getsheetdata.html
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, dla którego chcesz pobrać metadane. |
| Identyfikator/nazwa arkusza | Wprowadź nazwę lub unikalny identyfikator arkusza, z którego chcesz pobrać metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Metadane arkusza | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz metadane arkusza kalkulacyjnego
Aby pobrać metadane arkusza kalkulacyjnego, należy użyć polecenia Pobierz metadane arkusza kalkulacyjnego.
Równoważne wywołanie API: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, z którego chcesz pobrać metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Metadane arkusza kalkulacyjnego | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz metadane tabeli
Aby pobrać metadane tabeli Wdata, należy użyć polecenia Get table metadata.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-gettable/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli, z której chcesz pobrać metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Tabela | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz typ
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby uzyskać rekord, należy użyć punktu końcowego Pobierz pojedynczy rekord.
Pobierz typy
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby uzyskać wiele typów rekordów, należy użyć punktu końcowego Pobierz listę typów.
Kontrola stanu zdrowia
Aby sprawdzić stan interfejsu API Wdata, należy użyć polecenia Health check.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Właściwości
Brak
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Odpowiedź | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Importuj plik do tabeli
Aby zaimportować plik do tabeli Wdata, należy użyć polecenia Import file into table.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-importfile/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator tabeli | Wprowadź identyfikator tabeli, do której chcesz zaimportować plik. |
| Identyfikator pliku | Wprowadź identyfikator pliku, który chcesz zaimportować do tabeli. |
| Mapowania kolumn | Przypisz każdą kolumnę w pliku do kolumn tabeli. |
| Uruchom asynchronicznie | Aby polecenie zostało wykonane asynchronicznie i nie czekało na zakończenie importu przed kontynuowaniem łańcucha, zaznacz to pole. |
| Tagi | Aby uwzględnić metadane, które Twoja organizacja śledzi na temat danych, dodaj tagi i wybierz ich nazwy i wartości. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Importowanie plików | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Importuj arkusz kalkulacyjny do tabeli
Aby zaimportować arkusz kalkulacyjny do tabeli i zwrócić wynik metadanych pliku, należy użyć polecenia Import spreadsheet into table.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli, do której chcesz zaimportować plik. |
| Identyfikator pliku | Wprowadź unikalny identyfikator pliku, do którego chcesz zaimportować arkusz kalkulacyjny (opcjonalnie). |
| Nazwa pliku | Wprowadź unikalną nazwę, jaką nadasz plikowi po zaimportowaniu go do tabeli. |
| Adres URL arkusza kalkulacyjnego | Wprowadź pełny adres URL arkusza kalkulacyjnego, z którego chcesz zaimportować dane. |
| Uruchom asynchronicznie | Aby polecenie zostało wykonane asynchronicznie i nie czekało na zakończenie importu przed kontynuowaniem łańcucha, zaznacz to pole. |
| Tagi | Aby uwzględnić metadane, które Twoja organizacja śledzi na temat danych, dodaj tagi i wybierz ich nazwy i wartości. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Importowanie plików | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Wyświetl połączenia
Aby wyświetlić listę danych pomiędzy funkcjami platformy Workiva, należy użyć polecenia List connections.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Właściwość | Szczegół |
|---|---|
| Typ źródła | Korzystając z menu rozwijanego, wybierz typ pliku lub elementu, z którego chcesz pobrać dane. |
| Typ miejsca docelowego | Korzystając z menu rozwijanego, wybierz typ pliku lub elementu, do którego chcesz wysłać dane. |
| Identyfikator źródła | Wprowadź unikalny identyfikator pliku lub elementu, z którego chcesz pobrać dane. |
| Identyfikator miejsca docelowego | Wprowadź unikalny identyfikator pliku lub elementu, do którego chcesz wysłać dane. |
Uwaga: Twoje żądanie musi zawierać albo Typ źródła + Identyfikator źródła albo Typ miejsca docelowego + Identyfikator miejsca docelowego; żądanie zakończy się niepowodzeniem, jeśli jedna z tych par nie będzie obecna.
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Połączenia | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Wyświetl błędy pliku
Aby wyświetlić listę błędów skojarzonych z plikiem, np. błędów spowodowanych importem, należy użyć polecenia List file errors.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-geterrors/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator pliku, dla którego chcesz wyświetlić błędy. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Lista błędów | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista plików
Aby pobrać listę plików z tabeli Wdata i ich metadane, należy użyć polecenia List files.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-getfiles/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator tabeli | Wprowadź identyfikator tabeli, z której chcesz pobrać pliki. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Lista plików | Plik |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Wyświetlanie listy widoków obrotowych
Aby wyświetlić listę widoków Wdata w obszarze roboczym i pobrać ich metadane, użyj polecenia List pivot views.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Właściwości
Brak
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Widoki obrotowe | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zapytania listowe
Aby wyświetlić listę zapytań Wdata w obszarze roboczym i pobrać ich metadane, użyj polecenia List queries.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-listqueries/
Właściwości
Brak
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zapytania | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Wyświetl wyniki zapytania
Aby wyświetlić listę dostępnych wyników zapytania Wdata, należy użyć polecenia List query results.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania, aby uzyskać wyniki. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wyniki zapytania | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Wybierz listę
Aby wyświetlić listę wszystkich list wartości dla parametrów zapytania wielokrotnego wyboru w obszarze roboczym i pobrać ich metadane, należy użyć polecenia List select lists.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Właściwości
Brak
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wybierz listę | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Arkusze list
Aby wyświetlić listę wszystkich arkuszy w arkuszu kalkulacyjnym i pobrać ich metadane, należy użyć polecenia List sheets.
Równoważne wywołanie API: https://developers.workiva.com/2022-01-01/getlegacysheets.html
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, aby wyświetlić listę arkuszy. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Arkusze | JSON |
| Liczba arkuszy | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista tabel
Aby wyświetlić listę wszystkich tabel Wdata w obszarze roboczym i pobrać ich metadane, należy użyć polecenia List tables.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-gettables/
Właściwości
Brak
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Lista tabel | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista użytkowników
Aby pobrać listę szczegółów dotyczących użytkowników organizacji, należy użyć polecenia List users. Aby wykonać to polecenie, przypisany Ci użytkownik integracji musi mieć rolę administratora organizacji.
Podobnie jak w przypadku eksportu „Widoku osób” administratora organizacji, szczegóły są sortowane według nazwy wyświetlanej i obejmują:
- Nazwy użytkowników
- Adresy e-mail
- Identyfikatory SAML
- Ostatnie logowania
- Członkostwa w przestrzeni roboczej
- Licencje i role
Równoważne wywołanie API: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator organizacji | Wprowadź unikalny identyfikator organizacji, której użytkownicy mają zostać wymienieni. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Raporty użytkowników | Plik |
| Rekordowa liczba | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Nadpisz dane arkusza
Aby wyczyścić wszystkie komórki w arkuszu i zastąpić je wartościami podanymi w pliku, należy użyć polecenia Nadpisz dane arkusza.
Równoważne wywołanie API: https://developers.workiva.com/2022-01-01/updatesheet.html#
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, w którym chcesz nadpisać dane. |
| Identyfikator/nazwa arkusza | Wprowadź nazwę lub unikalny identyfikator arkusza, w którym chcesz nadpisać dane. |
| Plik danych | Wprowadź plik CSV zawierający dane, którymi chcesz wypełnić arkusz. |
| Ogranicznik | Wprowadź separator używany w Plik danych. |
| Użyj API platformy | Aby użyć formatu Wprowadzono w wartości komórek arkusza kalkulacyjnego, zaznacz to pole. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Napisany wiersz | Liczba całkowita |
| Komórki napisane | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Opublikuj arkusz kalkulacyjny
Aby opublikować łącza w arkuszu kalkulacyjnym, należy użyć polecenia Publikuj arkusz kalkulacyjny.
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, który chcesz opublikować. |
| Opublikuj wszystkie łącza () |
Wybierz, które łącza arkusza kalkulacyjnego chcesz opublikować:
|
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wiadomość | Ciąg |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Odśwież połączenie
Aby odświeżyć określone połączenie na podstawie jego identyfikatora, należy użyć polecenia Refresh connection.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator połączenia | Wprowadź unikalny identyfikator połączenia, które chcesz odświeżyć. |
| Użyj poprzednich parametrów źródłowych | Zaznacz to pole, aby użyć parametrów źródłowych z poprzedniego uruchomienia. To polecenie zastępuje wszystkie inne określone parametry źródłowe. Dane wejściowe zostaną zignorowane przez punkt końcowy „Odśwież partię połączeń”. |
| Parametry źródłowe* |
Wprowadź parametry, które zostaną wysłane do źródła w przypadku pomyślnego odświeżenia. (Te parametry zostaną zignorowane, jeśli włączono opcję „Użyj poprzednich parametrów źródłowych”). |
| Użyj poprzednich parametrów docelowych | Zaznacz to pole, aby użyć parametrów docelowych z poprzedniego uruchomienia. To pole zastępuje wszystkie inne określone parametry docelowe. Dane wejściowe zostaną zignorowane przez punkt końcowy „Odśwież partię połączeń”. |
| Parametry docelowe* |
Wprowadź parametry, które zostaną wysłane do miejsca docelowego w przypadku pomyślnego odświeżenia. (Te parametry zostaną zignorowane, jeśli włączono opcję „Użyj poprzednich parametrów docelowych”). |
Uwaga: Parametry wielokrotnego wyboru nie są obecnie obsługiwane.
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Odśwież status | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Odśwież partię połączeń
Aby odświeżyć wiele połączeń jednocześnie, należy użyć polecenia Odśwież partię połączeń.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Połączenia |
Przełącz, aby włączyć lub wyłączyć używanie zmiennych. Po włączeniu:
|
| Identyfikator połączenia | Wprowadź unikalny identyfikator połączenia, które chcesz odświeżyć. |
| Użyj poprzednich parametrów źródłowych | Zaznacz to pole, aby użyć parametrów źródłowych z poprzedniego uruchomienia. To polecenie zastępuje wszystkie inne określone parametry źródłowe. Dane wejściowe zostaną zignorowane przez punkt końcowy „Odśwież partię połączeń”. |
| Parametry źródłowe |
Wprowadź parametry, które zostaną wysłane do źródła w przypadku pomyślnego odświeżenia. (Te parametry zostaną zignorowane, jeśli włączono opcję „Użyj poprzednich parametrów źródłowych”). |
| Użyj poprzednich parametrów docelowych | Zaznacz to pole, aby użyć parametrów docelowych z poprzedniego uruchomienia. To pole zastępuje wszystkie inne określone parametry docelowe. Dane wejściowe zostaną zignorowane przez punkt końcowy „Odśwież partię połączeń”. |
| Parametry docelowe |
Wprowadź parametry, które zostaną wysłane do miejsca docelowego w przypadku pomyślnego odświeżenia. (Te parametry zostaną zignorowane, jeśli włączono opcję „Użyj poprzednich parametrów docelowych”). |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Status odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń krawędź
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby usunąć krawędź, użyj punktu końcowego Utwórz nowe edycje rekordu.
Pobierz listę rekordów
Aby zwrócić listę rekordów spełniających podane filtry, należy użyć polecenia Pobierz listę rekordów. Zawsze wymagany jest co najmniej jeden filtr.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-getrecords/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Rozwiń |
Zwraca zasoby powiązane z zasobem głównym. Opcje:
|
| Filtruj | Właściwości, według których należy filtrować wyniki. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Status odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz listę typów
Aby zwrócić listę typów rekordów i ich atrybutów, należy użyć polecenia Pobierz listę typów. To polecenie pozwala dowiedzieć się, czego można się spodziewać podczas pobierania rekordów.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-gettypes/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Rozwiń |
Zwraca zasoby powiązane z zasobem głównym. Opcje:
|
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Status odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz pojedynczy rekord
Aby pobrać pojedynczy rekord, użyj polecenia Pobierz listę rekordów. Unikalnym identyfikatorem jest zazwyczaj UUID, ale może być on różny.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-getrecordbyid/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Rozwiń |
Zwraca zasoby powiązane z zasobem głównym. Opcje:
|
| Identyfikator rekordu | Wprowadź unikalny identyfikator rekordu. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Status odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz pojedynczy typ
Aby pobrać pojedynczy rekord, użyj polecenia Pobierz listę rekordów. Unikalnym identyfikatorem jest zazwyczaj UUID, ale może być on różny.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-gettypebyid/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Rozwiń |
Zwraca zasoby powiązane z zasobem głównym. Opcje:
|
| Identyfikator rekordu | Wprowadź unikalny identyfikator rekordu. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Status odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Uruchom zapytanie
Aby uruchomić zapytanie Wdata i pobrać jego wyniki, należy użyć polecenia Run query.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-runquery/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania, które chcesz uruchomić. |
| Parametry |
Jeśli zapytanie ma zdefiniowane parametry, dodaj mapę ich nazw i wartości. Uwaga: Wprowadź wartości wszystkich parametrów wielokrotnego wyboru w Parametry wielokrotnego wyboru. |
| Uruchom asynchronicznie | Aby uruchomić zapytanie asynchronicznie i nie czekać na zakończenie zapytania, aby wykonać polecenie, zaznacz to pole. |
| Parametry wielokrotnego wyboru | Jeśli zapytanie ma zdefiniowane parametry wielokrotnego wyboru, dodaj nazwę i wartości każdego z nich. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wynik zapytania | JSON |
Uwaga:Wynik zapytania zawiera identyfikator, który można wykorzystać do pobrania i wyeksportowania wyników.
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Uruchom raport
Aby wygenerować zapisany raport na koncie bazy danych SOX i audytu wewnętrznego Twojej organizacji i zwrócić jego wyniki w postaci pliku CSV, użyj polecenia Run report.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator raportu | Wprowadź unikalny identyfikator raportu zawierającego zapisany raport. |
| Podgląd zawartości | Aby uwzględnić podgląd wyników raportu w dzienniku poleceń, zaznacz to pole. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Raport | Plik |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Ustaw krawędź
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby ustawić krawędź, użyj punktu końcowego Utwórz nowe edycje rekordu.
Ustaw właściwości rekordu
To polecenie jest dostępne wyłącznie poprzez API platformy. Aby ustawić właściwości rekordu, należy użyć punktu końcowego Utwórz nowe edycje rekordu.
Odimportuj plik z tabeli
Aby anulować import i usunąć plik z tabeli Wdata, należy użyć polecenia Un-import file From table.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli, z której chcesz usunąć plik. |
| Identyfikator pliku | Wprowadź unikalny identyfikator pliku, który chcesz usunąć z tabeli. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Importowanie plików | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Aktualizuj widok obrotowy
Aby zaktualizować metadane widoku Wdata, należy użyć polecenia Update pivot view.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator | Wprowadź identyfikator widoku, który chcesz zaktualizować. |
| Nazwa | Wprowadź nową nazwę widoku. |
| Identyfikator zapytania | Wprowadź identyfikator zapytania, na podstawie którego chcesz utworzyć widok. |
| Identyfikator wyniku zapytania | Wprowadź identyfikator wyniku zapytania, na podstawie którego chcesz utworzyć widok. |
| Dodatkowe metadane | Wprowadź zdefiniowane przez użytkownika metadane, które mają zostać dołączone do widoku jako obiekt JSON (opcjonalnie). |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Widok obrotowy | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj definicję zapytania
Aby zaktualizować właściwości zapytania Wdata, należy użyć polecenia Update query definition.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-updatequery/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania, które chcesz zaktualizować. |
| Nazwa | Wprowadź nową nazwę zapytania. |
| Opis | Wprowadź nowy opis zapytania. |
| Identyfikator wyniku podstawowego | Jeśli określono, wprowadź identyfikator domyślnego wyniku, który zostanie wypełniony wynikami zapytania. |
| Tekst zapytania | Wprowadź definicję zapytania w składni Presto SQL, tak jak zrobiłbyś to w edytorze SQL zapytania. |
| Tymczasowy | Aby wygenerować zapytanie tylko tymczasowo, tak aby nie pojawiało się ono w obszarze roboczym, zaznacz to pole. |
| Parametry | Wprowadź parametry wymagane do uruchomienia zapytania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zapytanie | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj listę wyboru
Aby zaktualizować właściwości lub elementy listy wartości dla parametru zapytania wielokrotnego wyboru, należy użyć polecenia Update select list.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator | Wprowadź identyfikator listy wyboru, którą chcesz zaktualizować. |
| Nazwa | Wprowadź nową nazwę listy wyboru. |
| Opis | Wprowadź nowy opis listy wyboru. |
| Typ wartości | Wybierz typ danych wartości listy, np. ciąg znaków lub liczba całkowita. |
| Wartości | Wprowadź wartości listy, włączając wszelkie aktualizacje. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zaktualizuj listę wyboru | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj metadane arkusza
Aby zaktualizować metadane arkusza w arkuszu kalkulacyjnym, należy użyć polecenia Aktualizuj metadane arkusza.
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, którego metadane mają zostać zaktualizowane. |
| Identyfikator/nazwa arkusza | Wprowadź nazwę lub unikalny identyfikator arkusza, w którym chcesz zaktualizować metadane. |
| Nazwa | Wprowadź nową nazwę arkusza. |
| Indeks arkusza | Wprowadź nowy indeks arkusza do arkusza kalkulacyjnego. Domyślnie polecenia aktualizują arkusz jako arkusz górny. |
| Identyfikator arkusza rodzica | Wprowadź identyfikator arkusza nadrzędnego, pod którym chcesz utworzyć arkusz. Aby dodać do arkusza głównego, pozostaw puste. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj metadane arkusza kalkulacyjnego
Aby zaktualizować metadane arkusza kalkulacyjnego, należy użyć polecenia Aktualizuj metadane arkusza kalkulacyjnego.
Równoważne wywołanie API: https://developers.workiva.com/2022-01-01/updatesheet.html
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, którego metadane mają zostać zaktualizowane. |
| Nazwa | Wprowadź nową nazwę arkusza kalkulacyjnego. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Aktualizacja tabeli
Aby zaktualizować kolumny tabeli Wdata, należy użyć polecenia Update table.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-updatetable/
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli, którą chcesz zaktualizować. |
| Nazwa | Wprowadź nazwę tabeli, którą chcesz zaktualizować. |
| Opis | Wprowadź opis tabeli, którą chcesz zaktualizować. |
| Typ | Wybierz, czy chcesz zaktualizować tabelę danych — faktów— lub wyszukiwania — lub wymiarów— |
| Kolumny | Dodaj kolumny, aby zaktualizować tabelę. Dla każdej kolumny wprowadź jej nazwę, typ danych, alias i opis. W przypadku trybu pozostaw wartość domyślną Nullable. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Tabela | JSON |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zapisz dane arkusza
Aby zapisać dane w zestawie danych CSV w określonym obszarze arkusza, należy użyć polecenia Zapisz dane arkusza.
Właściwości
| Właściwość | Szczegół |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, do którego mają zostać zapisane dane. |
| Identyfikator/nazwa arkusza | Wprowadź unikalny identyfikator arkusza, do którego mają zostać zapisane dane. |
| Plik danych | Wprowadź plik CSV zawierający dane, które mają zostać zapisane w arkuszu. Zakres danych nie może przekraczać regionu. |
| Ogranicznik | Wprowadź separator używany w Plik danych. |
| Region | Wprowadź reprezentację A1 komórki lub zakresu komórek w arkuszu, do którego mają zostać zapisane dane. Aby zakres był nieograniczony w żadnym lub wszystkich kierunkach, pozostaw odpowiednią kolumnę lub wiersz puste. |
| Użyj asynchronicznie |
Aby załadować dane asynchronicznie, np. w przypadku dużego zestawu danych, zaznacz to pole. Uwaga: Używając asynchronicznego, należy dodać własne sondowanie w celu określenia statusu zadania. |
| Użyj API platformy |
Aby użyć wprowadzonego formatu wartości komórekRegion, zaznacz to pole. Spowoduje to, że polecenie będzie używało wartości aktualizacji w punkcie końcowym zakresu zamiast zapisu danych do punktu końcowego regionuinterfejsu API arkusza kalkulacyjnego. Uwaga: To polecenie będzie zawsze uruchamiane asynchronicznie podczas korzystania z interfejsu API platformy. Musisz dodać własną ankietę, aby określić status zadania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wiersze napisane | Liczba całkowita |
| Komórki napisane | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegół |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |