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 zawierający polecenie połączenia Workiva.
Aby włączyć te polecenia, administrator IT najpierw konfiguruje konektor 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/spreadsheets-v1/spreadsheets-updatedataasync/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikatowy identyfikator arkusza kalkulacyjnego z arkuszem do wyczyszczenia. |
| ID/nazwa arkusza | Wprowadź nazwę lub unikatowy identyfikator arkusza do wyczyszczenia. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz plik
Aby przesłać plik CSV (comma-separated values), JSON (Javascript object notation) lub skompresowany plik ZIP i wyświetlić listę jego rekordów, użyj polecenia Create file . Możesz także przesłać adres URL do pliku, na przykład podpisany przez Amazon S3® adres URL do pliku w zasobniku S3.
- Jeśli jest to plik JSON, musi zawierać pojedynczy rekord JSON w wierszu - plik JSON to seria obiektów JSON oddzielonych znakiem nowej linii.
- Jeśli jest to plik ZIP, musi on zawierać pojedynczy plik CSV lub JSON, którego nazwa jest używana do nazwania importowanego pliku. Ponowne pobranie pliku spowoduje pobranie źródła.
- Jeśli jest to adres URL, punkt końcowy wysyła żądanie pobrania pliku przy użyciu 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óły |
|---|---|
| Identyfikator tabeli | Wprowadź identyfikator tabeli, której pliki mają zostać wyświetlone. |
| Plik | Wprowadź plik do przesłania. Ignorowane, jeśli wprowadzono adres URL pobierania . Uwaga: Plik musi mieć rozszerzenie .CSV lub .JSON lub być plikiem ZIP zawierającym plik z rozszerzeniem .CSV lub .JSON. |
| Nazwa | Jeśli wprowadzono Download URL , wprowadź nazwę pliku do przesłania; domyślnie jest to nazwa bazowa Download URL. |
| Pobierz adres URL | Wprowadź adres URL wskazujący plik do pobrania, np. adres URL z podpisem Amazon S3. Opcjonalnie, 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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz edycję nowego rekordu
Aby utworzyć nowe edycje rekordów na podstawie dostarczonych właściwości, użyj polecenia Utwórz nowe edycje rekordów . Każda edycja wymaga co najmniej operacji i targetId.
Limity:
- Na jedno żądanie może zostać przetworzonych 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óły |
|---|---|
| Działanie |
Wybierz operację do wykonania. Opcje:
|
| Etykieta | Wprowadź etykietę opisującą relację mię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 tymczasowy identyfikator rekordu źródła. Służy do tworzenia lub usuwania relacji. |
| Identyfikator celu | Wprowadź identyfikator rekordu docelowego. Jeśli tworzysz rekord, możesz użyć identyfikatora rekordu lub tymczasowego identyfikatora rekordu; jeśli usuwasz rekord, musisz użyć rzeczywistego identyfikatora rekordu. |
| Tymczasowy identyfikator rekordu | 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 ramach tego samego żądania, aby utworzyć relacje między utworzonymi rekordami. |
| Typ | Wprowadź typ rekordu do utworzenia. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Widok przestawny | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz widok przestawny
Aby utworzyć nowy widok Wdata na podstawie zapytania i wyniku zapytania, użyj polecenia Utwórz widok przestawny .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, aby ułatwić identyfikację widoku. |
| Identyfikator zapytania | Wprowadź ID zapytania, na podstawie którego ma zostać utworzony widok. |
| Identyfikator wyniku zapytania | Wprowadź ID wyniku zapytania, na podstawie którego ma zostać utworzony widok. |
| Dodatkowe metadane | Wprowadź metadane zdefiniowane przez użytkownika, aby dołączyć je do widoku jako obiekt JSON (opcjonalnie). |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Widok przestawny | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz zapytanie podglądu
Aby utworzyć tymczasowe zapytanie podglądu tabeli, które można następnie wykonać, użyj polecenia Utwórz zapytanie podglądu .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-previewqueryusingpost/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator tabeli | Wprowadź ID tabeli, której ma dotyczyć zapytanie. |
| Limit | Wprowadź maksymalną liczbę zwracanych wyników. |
| Plik | Jeśli określono, wprowadź nazwę pliku w tabeli, której ma dotyczyć zapytanie. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zapytanie | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
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óły |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, która pomoże zidentyfikować zapytanie. |
| Opis | Wprowadź opis zapytania. |
| Główny identyfikator wyniku | Jeśli określono, wprowadź identyfikator domyślnego wyniku do wypełnienia wynikami zapytania. |
| Tekst zapytania | Wprowadź definicję zapytania jako składnię Presto SQL, tak jak w edytorze SQL zapytania. |
| Tymczasowy | Aby wygenerować zapytanie tymczasowo, tak aby nie nie pojawiało się 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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz rekord
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby utworzyć nowy rekord, skorzystaj z punktu końcowego Create new record edits .
Utwórz listę wyboru
Aby utworzyć listę wartości dla parametru zapytania multi-select, użyj polecenia Create select list .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, aby 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, taki jak 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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd |
Błąd |
Utwórz arkusz
Aby dodać nowy arkusz do arkusza kalkulacyjnego, użyj 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óły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikatowy identyfikator arkusza kalkulacyjnego, do którego chcesz dodać arkusz. |
| Nazwa | Wprowadź unikalną nazwę, aby 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 nadrzędnego | Wprowadź identyfikator arkusza nadrzędnego, w ramach którego ma zostać utworzony arkusz. Aby dodać do głównego arkusza kalkulacyjnego, pozostaw puste pole. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Metadane arkusza | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 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/spreadsheets-v1/spreadsheets-createspreadsheet/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, aby ułatwić identyfikację arkusza kalkulacyjnego. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Metadane arkusza | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Utwórz tabelę
Aby utworzyć nową tabelę Wdata w przestrzeni roboczej, użyj 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óły |
|---|---|
| Nazwa | Wprowadź unikalną nazwę, która pomoże zidentyfikować tabelę. |
| Opis | Wprowadź opis nowej tabeli. |
| Typ | Wybierz, czy chcesz utworzyć tabelę Data (lub fakt) czy Lookup (lub wymiar). |
| Kolumny | Dodaj kolumny do uwzględnienia w tabeli:
|
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Tabela | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń plik
Aby usunąć plik z obszaru roboczego Wdata, użyj polecenia Usuń plik .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator pliku do usunięcia. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń widok przestawny
Aby usunąć widok Wdata z obszaru roboczego, użyj polecenia Usuń widok przestawny .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator | Wprowadź identyfikator widoku do usunięcia. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń zapytanie
Aby usunąć zapytanie Wdata z obszaru roboczego, użyj polecenia Usuń zapytanie .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania do usunięcia. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń rekord
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby usunąć rekord, Utwórz nowy rekord edytuje punkt końcowy.Usuń arkusz
Aby usunąć arkusz i jego arkusze podrzędne (rekurencyjnie) z arkusza kalkulacyjnego, użyj polecenia Usuń arkusz.Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikatowy identyfikator arkusza kalkulacyjnego zawierającego arkusz do usunięcia. |
| ID/nazwa arkusza | Wprowadź nazwę lub unikatowy identyfikator arkusza do usunięcia. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 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óły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego do usunięcia. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń tabelę
Aby usunąć tabelę Wdata z obszaru roboczego, użyj polecenia Usuń tabelę .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli do usunięcia |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz plik
Aby pobrać zestaw danych z obszaru roboczego Wdata, użyj polecenia Pobierz plik .
Uwaga: To polecenie nie jest kompatybilne z innymi typami obiektów, takimi jak arkusze kalkulacyjne, tabele lub kwerendy.
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator pliku do pobrania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Plik | Plik |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
<!--
Download Pivot View
Downloads the content from a pivot view
Inputs
| Input | Detail |
| ID | Enter the ID of the pivot view to download |
Outputs
| Output | Output Type |
| Pivot View Content | File |
Exit Codes
| Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | Error |
Download pivot view
To download the contents of a view, use a Download pivot view command.
Properties
| Property | Detail |
|---|---|
| ID | Enter the ID of the view to download. |
Outputs
| Output | Output Type |
|---|---|
| Pivot view content | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Pobierz wynik zapytania
Aby pobrać wyniki zapytania Wdata do pliku, użyj 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óły |
|---|---|
| Identyfikator wyniku zapytania | Wprowadź identyfikator wyniku zapytania do pobrania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wynik zapytania | Plik |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Edytuj
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby edytować rekord, użyj punktu końcowego Create new record edits .
Eksportuj plik do arkusza kalkulacyjnego
Aby wyeksportować zestaw danych z tabeli Wdata do nowego lub istniejącego arkusza kalkulacyjnego, użyj 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óły |
|---|---|
| Identyfikator pliku | Wprowadź ID zbioru danych tabeli do wyeksportowania. |
| 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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Eksportuj wynik zapytania
Aby wyeksportować wynik zapytania Wdata do nowego lub istniejącego arkusza kalkulacyjnego, użyj polecenia Eksportuj wynik zapytania .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator wyniku zapytania | Wprowadź identyfikator wyniku zapytania do wyeksportowania. |
| 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ć tylko poprzez aktualizację zestawu danych w arkuszu kalkulacyjnym. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz właściwości pliku
Aby pobrać właściwości pliku w obszarze roboczym Wdata, użyj polecenia Get file properties .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-getfile/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator pliku, którego właściwości chcesz uzyskać. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Właściwości pliku | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz widok przestawny
Aby pobrać metadane widoku Wdata, użyj 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óły |
|---|---|
| Identyfikator | Wprowadź identyfikator widoku przestawnego, z którego chcesz pobrać metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Widok przestawny | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz metadane zapytania
Aby pobrać metadane zapytania Wdata, użyj 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óły |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania, z którego mają zostać pobrane metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zapytanie | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz rekord
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby uzyskać rekord, użyj punktu końcowego Retrieve a single record .
Pobierz rekordy
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby uzyskać wiele rekordów, użyj punktu końcowego Retrieve a list of records .
Pobierz raporty
Aby pobrać wszystkie raporty z konta bazy danych SOX i audytu wewnętrznego 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 |
| Liczba raportów | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz listę wyboru
Aby pobrać listę wartości dla parametru zapytania multi-select na podstawie identyfikatora listy, użyj 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óły |
|---|---|
| Wybierz identyfikator listy | Wprowadź unikalny identyfikator listy wyboru do pobrania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Pobierz ładunek listy wyboru | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz dane arkusza
Aby pobrać wszystkie dane w określonym regionie arkusza, użyj 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óły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, z którego mają być pobierane dane. |
| ID/nazwa arkusza | Wprowadź nazwę lub unikatowy identyfikator arkusza, z którego mają być pobierane dane. |
| Region | Wprowadź reprezentację komórki lub zakresu w stylu A1, na przykład [Kolumna początkowa][Wiersz początkowy]:[Kolumna końcowa][Wiersz końcowy]. Aby zakres był nieograniczony w dowolnym lub wszystkich kierunkach, pomiń odpowiednią kolumnę lub wiersz. |
| Styl wartości | Wybierz, czy chcesz zwrócić nieprzetworzoną czy obliczoną wartość komórki. Na przykład, jeśli wartość komórki to =1+:1, wybierz Raw dla =1+1 lub Calculated dla obliczonej wartości 2. |
| Wersja | Wprowadź wersję arkusza, z którego chcesz pobrać dane. Dla bieżącej wersji wpisz -1. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Liczba wierszy | Liczba całkowita |
| Dane | Plik |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz metadane arkusza
Aby pobrać metadane arkusza w arkuszu kalkulacyjnym, użyj polecenia Pobierz metadane arkusza .
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getsheet/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikatowy identyfikator arkusza kalkulacyjnego, z którego mają zostać pobrane metadane. |
| ID/nazwa arkusza | Wprowadź nazwę lub unikatowy identyfikator arkusza, z którego mają zostać pobrane metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Metadane arkusza | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz metadane arkusza kalkulacyjnego
Aby pobrać metadane arkusza kalkulacyjnego, użyj polecenia Get spreadsheet metadata .
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, z którego mają zostać pobrane metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Metadane arkusza kalkulacyjnego | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz metadane tabeli
Aby pobrać metadane tabeli Wdata, użyj 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óły |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli, z której mają być pobierane metadane. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Tabela | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz typ
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby uzyskać rekord, użyj punktu końcowego Retrieve a single record .
Pobierz typy
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby uzyskać wiele typów rekordów, użyj punktu końcowego Retrieve a list of types .
<!-- display page content -->
Kontrola stanu zdrowia
Aby sprawdzić kondycję interfejsu API Wdata, użyj 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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaimportuj plik do tabeli
Aby zaimportować plik do tabeli Wdata, użyj polecenia Importuj plik do tabeli .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-importfile/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator tabeli | Wprowadź ID tabeli, do której chcesz zaimportować plik. |
| Identyfikator pliku | Wprowadź identyfikator pliku do zaimportowania do tabeli. |
| Mapowania kolumn | Mapuj każdą kolumnę w pliku na kolumny tabeli. |
| Działaj asynchronicznie | Aby polecenie było uruchamiane asynchronicznie i nie czekać na zakończenie importu przed kontynuowaniem łańcucha, zaznacz to pole. |
| Tagi | Aby dołączyć 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 |
|---|---|
| Import plików | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaimportuj arkusz kalkulacyjny do tabeli
Aby zaimportować arkusz kalkulacyjny do tabeli i zwrócić wynik meta pliku, użyj polecenia Importuj arkusz kalkulacyjny do tabeli .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| 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ę, która zostanie nadana plikowi po zaimportowaniu do tabeli. |
| Adres URL arkusza kalkulacyjnego | Wprowadź pełny adres URL arkusza kalkulacyjnego, z którego chcesz zaimportować dane. |
| Działaj asynchronicznie | Aby polecenie było uruchamiane asynchronicznie i nie czekać na zakończenie importu przed kontynuowaniem łańcucha, zaznacz to pole. |
| Tagi | Aby dołączyć 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 |
|---|---|
| Import plików | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista połączeń
Aby wyświetlić listę danych między funkcjami platformy Workiva, użyj polecenia List connections .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Właściwość | Szczegóły |
|---|---|
| Typ źródła | Korzystając z rozwijanego menu, wybierz typ pliku lub elementu, z którego chcesz pobrać dane. |
| Typ miejsca docelowego | Korzystając z rozwijanego menu, wybierz typ pliku lub elementu, do którego chcesz wysłać dane. |
| Źródło ID | Wprowadź unikalny identyfikator pliku lub elementu, z którego chcesz pobrać dane. |
| Identyfikator miejsca docelowego | Wprowadź unikalny identyfikator pliku lub elementu, do którego mają zostać wysłane dane. |
Uwaga: Twoje żądanie musi zawierać albo Source Type + Source ID lub Destination Type + Destination ID; żądanie nie powiedzie się, jeśli jedna z tych par nie jest obecna.
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Połączenia | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista błędów pliku
Aby wyświetlić listę błędów związanych z plikiem, np. z powodu importu, użyj 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óły |
|---|---|
| Identyfikator pliku | Wprowadź identyfikator pliku, dla którego mają zostać wyświetlone błędy. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Lista błędów | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista plików
Aby pobrać listę plików w tabeli Wdata i ich metadanych, użyj 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óły |
|---|---|
| Identyfikator tabeli | Wprowadź ID 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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Widoki listy przestawnej
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 przestawne | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista zapytań
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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Wyświetl wyniki zapytania
Aby wyświetlić dostępne wyniki zapytania Wdata, użyj 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óły |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania, z którego chcesz uzyskać wyniki. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wyniki zapytania | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Wybierz listę
Aby wyświetlić wszystkie listy wartości dla parametrów zapytania multi-select w obszarze roboczym i pobrać ich metadane, użyj 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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista arkuszy
Aby wyświetlić listę wszystkich arkuszy w arkuszu kalkulacyjnym i pobrać ich metadane, użyj polecenia List sheets .
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego, którego arkusze mają zostać wyświetlone. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Arkusze | JSON |
| Liczba arkuszy | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista tabel
Aby wyświetlić listę wszystkich tabel Wdata w przestrzeni roboczej i pobrać ich metadane, użyj 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óły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Lista użytkowników
Aby pobrać listę szczegółowych informacji o użytkownikach organizacji, użyj polecenia List users . Twój przypisany użytkownik integracji musi mieć rolę Org Admin, aby wykonać to polecenie.
Podobnie jak w przypadku eksportu "People View" administratora organizacji, szczegóły są sortowane według wyświetlanej nazwy i obejmują użytkowników:
- Nazwy użytkowników
- Adresy e-mail
- Identyfikatory SAML
- Ostatnie logowania
- Członkostwo 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óły |
|---|---|
| Identyfikator organizacji | Wprowadź unikalny identyfikator organizacji, dla której chcesz wyświetlić listę użytkowników. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Użytkownicy zgłaszają | Plik |
| Liczba rekordów | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 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, użyj polecenia Nadpisz dane arkusza .
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikatowy identyfikator arkusza kalkulacyjnego, w którym dane mają zostać nadpisane. |
| ID/nazwa arkusza | Wprowadź nazwę lub unikatowy identyfikator arkusza, w którym dane mają zostać nadpisane. |
| Plik danych | Wprowadź plik CSV zawierający dane do wypełnienia arkusza. |
| Ogranicznik | Wprowadź separator używany w pliku danych . |
| Korzystaj z API platformy | Aby użyć formatu Entered in wartości komórek arkusza kalkulacyjnego, zaznacz to pole. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wiersz napisany | Liczba całkowita |
| Napisane komórki | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Opublikuj arkusz kalkulacyjny
Aby opublikować łącza w arkuszu kalkulacyjnym, użyj polecenia Publish spreadsheet .
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego do opublikowania. |
| Opublikuj wszystkie łącza () | Wybierz, które łącza arkusza kalkulacyjnego mają zostać opublikowane:
|
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Wiadomość | Ciąg |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Odśwież połączenie
Aby odświeżyć określone połączenie na podstawie jego identyfikatora, użyj 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óły |
|---|---|
| Identyfikator połączenia | Wprowadź unikalny identyfikator połączenia do odświeżenia. |
| Użyj poprzednich parametrów źródła | Zaznacz to pole, aby użyć parametrów źródłowych poprzedniego uruchomienia; zastępuje to wszelkie inne określone parametry źródłowe. Dane te zostaną zignorowane przez punkt końcowy "Odśwież partię połączeń". |
| Parametry źródła* |
Wprowadź parametry, które mają zostać wysłane do źródła po pomyślnym odświeżeniu. (Parametry te zostaną zignorowane, jeśli włączona jest opcja "Użyj poprzednich parametrów źródła") |
| Użyj poprzednich parametrów miejsca docelowego | Zaznacz to pole, aby użyć parametrów miejsca docelowego z poprzedniego uruchomienia; zastępuje to wszelkie inne określone parametry miejsca docelowego. Dane te zostaną zignorowane przez punkt końcowy "Odśwież partię połączeń". |
| Parametry miejsca docelowego* |
Wprowadź parametry, które mają zostać wysłane do miejsca docelowego po pomyślnym odświeżeniu. (Parametry te zostaną zignorowane, jeśli włączona jest opcja "Użyj poprzednich parametrów miejsca docelowego") |
Uwaga: Parametry wielokrotnego wyboru nie są obecnie obsługiwane.
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Status odświeżania | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Odśwież partię połączeń
Aby odświeżyć wiele połączeń jednocześnie, użyj polecenia Refresh batch of connections .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Połączenia |
Przełącz, aby włączyć lub wyłączyć używanie zmiennych. Po włączeniu:
|
| Identyfikator połączenia | Wprowadź unikalny identyfikator połączenia do odświeżenia. |
| Użyj poprzednich parametrów źródła | Zaznacz to pole, aby użyć parametrów źródłowych poprzedniego uruchomienia; zastępuje to wszelkie inne określone parametry źródłowe. Dane te zostaną zignorowane przez punkt końcowy "Odśwież partię połączeń". |
| Parametry źródłowe |
Wprowadź parametry, które mają zostać wysłane do źródła po pomyślnym odświeżeniu. (Parametry te zostaną zignorowane, jeśli włączona jest opcja "Użyj poprzednich parametrów źródła") |
| Użyj poprzednich parametrów miejsca docelowego | Zaznacz to pole, aby użyć parametrów miejsca docelowego z poprzedniego uruchomienia; zastępuje to wszelkie inne określone parametry miejsca docelowego. Dane te zostaną zignorowane przez punkt końcowy "Odśwież partię połączeń". |
| Parametry miejsca docelowego |
Wprowadź parametry, które mają zostać wysłane do miejsca docelowego po pomyślnym odświeżeniu. (Parametry te zostaną zignorowane, jeśli opcja "Użyj poprzednich parametrów miejsca docelowego" jest włączona) |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Stan odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Usuń krawędź
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby usunąć krawędź, użyj punktu końcowego Create new record edits .
Pobierz listę rekordów
Aby zwrócić listę rekordów pasujących do podanych filtrów, użyj polecenia Retrieve a list of records . 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óły |
|---|---|
| Rozwiń |
Zwraca powiązane zasoby w linii z głównym zasobem. Opcje:
|
| Filtruj | Właściwości, według których mają być filtrowane wyniki. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Stan odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz listę typów
Aby zwrócić listę typów rekordów i ich atrybutów, użyj polecenia Retrieve a list of types . Dzięki temu poleceniu wiesz, czego możesz się spodziewać po pobraniu rekordów.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-gettypes/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Rozwiń |
Zwraca powiązane zasoby w linii z głównym zasobem. Opcje:
|
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Stan odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz pojedynczy rekord
Aby pobrać pojedynczy rekord, użyj polecenia Retrieve a list of records . Unikalny identyfikator to zazwyczaj UUID, ale może się on różnić.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-getrecordbyid/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Rozwiń |
Zwraca powiązane zasoby w linii z głównym zasobem. Opcje:
|
| Identyfikator rekordu | Wprowadź unikalny identyfikator rekordu. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Stan odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Pobierz pojedynczy typ
Aby pobrać pojedynczy rekord, użyj polecenia Retrieve a list of records . Unikalny identyfikator to zazwyczaj UUID, ale może się on różnić.
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-gettypebyid/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Rozwiń |
Zwraca powiązane zasoby w linii z głównym zasobem. Opcje:
|
| Identyfikator rekordu | Wprowadź unikalny identyfikator rekordu. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Stan odświeżania partii | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Uruchom zapytanie
Aby uruchomić zapytanie Wdata i pobrać jego wyniki, użyj polecenia Uruchom zapytanie .
Równoważne wywołanie API: https://developers.workiva.com/wdata-v1/wdata-runquery/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania do uruchomienia. |
| Parametry | Jeśli zapytanie ma zdefiniowane parametry, dodaj mapę ich nazw i wartości. Uwaga: Wprowadź wartości dowolnych parametrów multi-select w Multi-select params. |
| Działaj asynchronicznie | Aby uruchomić zapytanie asynchronicznie i nie czekać, aż zapytanie zakończy wykonywanie polecenia, 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órego można użyć do pobrania i wyeksportowania wyników.
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Uruchom raport
Aby uruchomić zapisany raport na koncie bazy danych SOX i audytu wewnętrznego organizacji i zwrócić jego wyniki w postaci pliku CSV, użyj polecenia Uruchom raport .
Równoważne wywołanie API: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator raportu | Wprowadź unikalny identyfikator raportu, który zawiera zapisany raport. |
| Podgląd zawartości | Aby dołączyć podgląd wyników raportu do dziennika polecenia, zaznacz to pole. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Raport | Plik |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Ustaw krawędź
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby ustawić krawędź, użyj punktu końcowego Create new record edits .
Ustaw właściwości rekordu
To polecenie jest dostępne tylko za pośrednictwem interfejsu API platformy. Aby ustawić właściwości rekordu, użyj punktu końcowego Create new record edits .
Usuń zaimportowany plik z tabeli
Aby odimportować i usunąć plik z tabeli Wdata, użyj 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óły |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli, z której chcesz usunąć plik. |
| Identyfikator pliku | Wprowadź unikalny identyfikator pliku, który ma zostać usunięty z tabeli. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Import plików | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj widok przestawny
Aby zaktualizować metadane widoku Wdata, użyj 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óły |
|---|---|
| Identyfikator | Wprowadź identyfikator widoku do aktualizacji. |
| Nazwa | Wprowadź nową nazwę widoku. |
| Identyfikator zapytania | Wprowadź ID zapytania, na podstawie którego ma zostać utworzony widok. |
| Identyfikator wyniku zapytania | Wprowadź ID wyniku zapytania, na podstawie którego ma zostać utworzony 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 przestawny | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj definicję zapytania
Aby zaktualizować właściwości zapytania Wdata, użyj 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óły |
|---|---|
| Identyfikator zapytania | Wprowadź identyfikator zapytania do aktualizacji. |
| Nazwa | Wprowadź nową nazwę zapytania. |
| Opis | Wprowadź nowy opis zapytania. |
| Główny identyfikator wyniku | Jeśli określono, wprowadź identyfikator domyślnego wyniku do wypełnienia wynikami zapytania. |
| Tekst zapytania | Wprowadź definicję zapytania jako składnię Presto SQL, tak jak w edytorze SQL zapytania. |
| Tymczasowy | Aby wygenerować zapytanie tylko tymczasowo, aby nie nie pojawiało się 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óły |
|---|---|---|
| 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 multi-select, użyj 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óły |
|---|---|
| Identyfikator | Wprowadź identyfikator listy wyboru do aktualizacji. |
| Nazwa | Wprowadź nową nazwę listy wyboru. |
| Opis | Wprowadź nowy opis listy wyboru. |
| Typ wartości | Wybierz typ danych wartości listy, taki jak ciąg znaków lub liczba całkowita. |
| Wartości | Wprowadź wartości listy, w tym wszelkie aktualizacje. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zaktualizuj listę wyboru | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj metadane arkusza
Aby zaktualizować metadane arkusza w arkuszu kalkulacyjnym, użyj 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óły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikatowy identyfikator arkusza kalkulacyjnego, w którym mają zostać zaktualizowane metadane. |
| ID/nazwa arkusza | Wprowadź nazwę lub unikatowy identyfikator arkusza, w którym mają zostać zaktualizowane metadane. |
| Nazwa | Wprowadź nową nazwę arkusza. |
| Indeks arkusza | Wprowadź nowy indeks arkusza w arkuszu kalkulacyjnym. Domyślnie polecenia aktualizują arkusz jako arkusz górny. |
| Identyfikator arkusza nadrzędnego | Wprowadź identyfikator arkusza nadrzędnego, w ramach którego ma zostać utworzony arkusz. Aby dodać do głównego arkusza kalkulacyjnego, pozostaw puste pole. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj metadane arkusza kalkulacyjnego
Aby zaktualizować metadane arkusza kalkulacyjnego, użyj polecenia Aktualizuj metadane arkusza kalkulacyjnego .
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatespreadsheet/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikatowy identyfikator arkusza kalkulacyjnego, w którym mają zostać zaktualizowane metadane. |
| Nazwa | Wprowadź nową nazwę arkusza kalkulacyjnego. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zaktualizuj tabelę
Aby zaktualizować kolumny tabeli Wdata, użyj 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óły |
|---|---|
| Identyfikator tabeli | Wprowadź unikalny identyfikator tabeli do aktualizacji. |
| Nazwa | Wprowadź nazwę tabeli do aktualizacji. |
| Opis | Wprowadź opis tabeli do aktualizacji. |
| Typ | Wybierz, czy chcesz zaktualizować tabelę Data-or fact-or Lookup-or dimension-table |
| Kolumny | Dodaj kolumny do aktualizacji tabeli. Dla każdej kolumny wprowadź jej nazwę, typ danych, alias i opis. Dla Modepozostaw domyślną wartość Nullable. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Tabela | JSON |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |
Zapisz dane arkusza
Aby zapisać dane w zestawie danych CSV w określonym regionie arkusza, użyj polecenia Zapisz dane arkusza .
Równoważne wywołanie API: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
Właściwości
| Właściwość | Szczegóły |
|---|---|
| Identyfikator arkusza kalkulacyjnego | Wprowadź unikalny identyfikator arkusza kalkulacyjnego z arkuszem, do którego mają być zapisywane dane. |
| ID/nazwa arkusza | Wprowadź unikalny identyfikator arkusza, do którego mają być zapisywane dane. |
| Plik danych | Wprowadź plik CSV z danymi do zapisania w arkuszu. Zakres danych nie może przekraczać regionu . |
| Ogranicznik | Wprowadź separator używany w pliku danych . |
| Region | Wprowadź reprezentację A1 komórki lub zakresu komórek w arkuszu, do którego mają zostać zapisane dane. Aby zakres nie był ograniczony w żadnym lub we wszystkich kierunkach, pozostaw odpowiednią kolumnę lub wiersz puste. |
| Użyj async |
Aby załadować dane asynchronicznie, np. w przypadku dużego zbioru danych, zaznacz to pole. Uwaga: W przypadku korzystania z async, musisz dodać własne odpytywanie w celu określenia statusu zadania. |
| Korzystaj z API platformy |
Aby użyć formatu entered-in wartości komórek Region , zaznacz to pole. Zmusi to polecenie do korzystania z aktualizacji wartości w punkcie końcowym zakresu zamiast zapisu danych interfejsu API arkusza kalkulacyjnego do punktu końcowego regionu. Uwaga: Polecenie to będzie zawsze uruchamiane asynchronicznie podczas korzystania z API platformy. Musisz dodać własne odpytywanie, aby określić status zadania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
|---|---|
| Zapisane wiersze | Liczba całkowita |
| Napisane komórki | Liczba całkowita |
Kody wyjścia
| Kod | Typ | Szczegóły |
|---|---|---|
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Błąd |