HighQ (wersja zapoznawcza)

Ten łącznik umożliwia bezpieczny i uwierzytelniony dostęp do interfejsów API highQ, umożliwiając bezproblemową integrację funkcji współpracy i zarządzania zawartością w niestandardowych przepływach pracy i aplikacjach. Obsługuje automatyzację dokumentów, synchronizację danych i aranżację przepływu pracy — umożliwiając zespołom usług prawnych i profesjonalnych usprawnianie operacji, zmniejszanie nakładu pracy ręcznej i zwiększanie produktywności.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa	Class	Regions
Copilot Studio	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

Kontakt
Name	Highq
adres URL	https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Email	highq-support@thomsonreuters.com

Metadane łącznika
Publisher	Thomson Reuters włączone
Witryna internetowa	https://legal.thomsonreuters.com/en/products/highq
Zasady ochrony prywatności	https://www.thomsonreuters.com/en/privacy-statement
Kategorie	Kolaboracja; Zawartość i pliki

HighQ

Przegląd

Usługa HighQ zapewnia bezproblemowy, bezpieczny, uwierzytelniony dostęp do interfejsów API highQ. Ten łącznik umożliwia bezproblemową interakcję z różnymi usługami HighQ, w tym modułem ISheet, interfejsami API zasobów dokumentów, interfejsami API administratora ISheet i operacjami użytkownika. Ma ona na celu ułatwienie integracji z platformą HighQ Collaborate, oferując funkcje, takie jak pobieranie i tworzenie elementów iSheet, zarządzanie plikami dokumentów i administrowanie kontami użytkowników.

Wersja łącznika: 1.0.0
Tytuł: HighQ
Opis: Ten łącznik zapewnia bezproblemowy, bezpieczny i uwierzytelniony dostęp do interfejsów API highQ.
Kontakt:
- Nazwa: Highq
- Witryna internetowa:obsługa highQ
- E-mail:highq-support@thomsonreuters.com

Authentication

Łącznik korzysta ze zmiennych środowiskowych dynamicznych w celu zapewnienia bezpiecznej łączności:

Host: @environmentVariables("highqt_host")
Ścieżka podstawowa: /@environmentVariables("highqt_instancename")/api
Identyfikator klienta:@environmentVariables("highqt_clientid")
Klucz tajny klienta:@environmentVariables("highqt_clientsecret")

Aby uzyskać szczegółowe procedury uwierzytelniania, zapoznaj się z portalem pomocy technicznej highQ lub skontaktuj się z pomocą techniczną highQ.

Operacje łącznika

Moduł ISheet

Pobieranie elementów iSheet
GET /{version}/isheet/{isheetid}/items
Pobiera listę elementów w określonym arkuszu iSheet.
Tworzenie elementów iSheet
POST /{version}/isheet/{isheetid}/items
Wstawia nowe elementy do arkusza iSheet z obsługą wielu arkuszy iSheet i śledzenie stanu za pomocą kluczy progresywnych.

Interfejsy API zasobów dokumentów

Pobieranie informacji o pliku
GET /{version}/files/{fileid}
Pobiera szczegółowe informacje o określonym pliku na platformie HighQ Collaborate.
Przekazywanie pliku
POST /{version}/files/content
Przekazuje plik do określonego folderu, obsługując fragmentowane przekazywanie po podaniu nagłówka Content-Range .
Pobieranie listy folderów
GET /{version}/folders/{folderid}/items
Pobiera listę folderów w określonym folderze z obsługą sortowania i stronicowania.

Interfejs API administratora ISheet

Pobieranie kolumn iSheet
GET /{version}/isheets/admin/{isheetid}/columns
Pobiera konfiguracje kolumn dla danego arkusza iSheet.

Operacje użytkownika

Pobieranie użytkowników
GET /{version}/users
Pobiera listę użytkowników z obsługą filtrowania, stronicowania i szczegółowych ról użytkowników.
Dodawanie nowego użytkownika
POST /{version}/users
Tworzy nowe konto użytkownika z atrybutami rozszerzonymi i walidacją.
Archiwizowanie użytkownika
DELETE /{version}/users/{userid}
Archiwizuje istniejącego użytkownika z systemu.

Zarządzanie dokumentami i lokacjami

Tworzenie folderu
POST /{version}/folders
Tworzy nowy folder w określonym folderze nadrzędnym.
Przenoszenie dokumentów
PUT /{version}/files/move
Przenosi jeden lub wiele plików z jednego folderu do innego w tej samej witrynie.
Operacje zarządzania lokacjami:
- Dodaj istniejącą grupę do lokacji: POST /{version}/sites/{siteid}/groups/{groupid}
- Aktualizuj grupę witryn: PUT /{version}/sites/{siteid}/groups/{groupid}
- Dodaj nową witrynę: POST /{version}/sites

Wprowadzenie

Konfiguracja:
- Zdefiniuj zmienne highqt_host środowiskowe i highqt_instancename w środowisku platformy Power Platform.
Authentication (Uwierzytelnianie):
- Postępuj zgodnie z wytycznymi dostarczonymi przez usługę HighQ, aby skonfigurować bezpieczne uwierzytelnianie dla żądań interfejsu API.
Użycie:
- Zaimportuj plik HighQ do wystąpienia platformy Power Platform.
- Skorzystaj z dostępnych operacji zgodnie z potrzebami. Zapoznaj się z powyższymi podsumowaniami operacji, aby uzyskać wskazówki.

Parametry i ustawienia

Parametry ścieżki:
Uwzględnij wymagane parametry, takie jak version, , isheetidfileid, folderidi userid zgodnie z potrzebami.
Parametry zapytania:
Parametry opcjonalne, takie jak sheetviewid, sortcolumnid, limiti offset , są dostępne do uściślinia odpowiedzi interfejsu API.
Parametry treści:
W przypadku operacji wymagających treści żądania (np. tworzenia elementów lub użytkowników w arkuszu iSheet) upewnij się, że żądanie jest zgodne ze zdefiniowanymi schematami (takimi jak isheetDBO, FolderDBOlub IntegrationUserDBO).

Rozwiązywanie problemów i ograniczenia

Kody błędów:
Standardowe kody stanu HTTP są używane w operacjach:
- 200 w przypadku operacji zakończonych powodzeniem
- 401 w przypadku nieautoryzowanego dostępu
- 403 zabronione lub niepowodzenia walidacji
- 405 dla nieprawidłowych metod HTTP
- 500 w przypadku błędów serwera wewnętrznego
  Szczegółowe opisy błędów można znaleźć w dokumentacji poszczególnych interfejsów API.
Ograniczenia:
Niektóre punkty końcowe mogą mieć domyślne limity (np. domyślne limit 100 rekordów). Dodatkowe parametry mogą być wymagane do sortowania i filtrowania dużych zestawów danych.

Dodatkowe zasoby

Aby uzyskać bardziej szczegółowe informacje i rozszerzoną dokumentację, zapoznaj się z:

Pomoc techniczna highQ
Wewnętrzna dokumentacja dołączona do pakietu łącznika HighQ.

Licencjonowanie i pomoc techniczna

Aby uzyskać szczegółowe informacje o licencjonowaniu i pomoc techniczną:

Kontakt: Highq
Adres URL pomocy technicznej: Pomoc techniczna highQ
Adres e-mail pomocy technicznej: highq-support@thomsonreuters.com

Limity ograniczania

Nazwa	Wywołania	Okres odnowienia
Wywołania interfejsu API na połączenie	100	60 sekund

Akcje

Aby utworzyć element iSheet

To wywołanie interfejsu API służy do wstawiania elementu iSheet. Można obsługiwać wiele arkuszy iSheet.

Aby uzyskać stan elementu iSheet na podstawie klucza progresywnego, wywołaj metodę API POST /api/3/progressivekeystatus/{progressive_key}

np. POST /api/{version}/progressivekeystatus/{progressive_key}

Name	Typ	Description
progressive_key	Sznurek	Klucz do sprawdzenia stanu akcji.

Odpowiedź


              
              <progressivekeyresponse>

               \t<items>

                \t\t<, element>

                 \t\t\t<itemid>1232</itemid>

                 \t\t\t<status SUCCESS>/status<>

                 \t\t\t<kod stanu 200>/kod stanu<>

                 \t\t\t<komunikat>Rekord został dodany pomyślnie</komunikat>

                \t\t</item>

                \t\t<, element>

                 \t\t\t<itemid>1233</itemid>

                 \t\t\t<status SUCCESS>/status<>

                 \t\t\t<kod stanu 200>/kod stanu<>

                 \t\t\t<komunikat>Rekord został dodany pomyślnie</komunikat>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Aktualizowanie grupy witryn

Ta metoda interfejsu API aktualizuje nazwę istniejącej grupy w witrynie.
Ten interfejs API został rozszerzony w celu zaktualizowania nazwy istniejącej podstawowej grupy użytkowników w witrynie.

Aktualizowanie witryny

Użyj tego punktu końcowego interfejsu API, aby zaktualizować szczegóły istniejącej witryny. Interfejs API obsługuje te same pola, które są używane w interfejsie API tworzenia witryny.

Ta metoda obsługuje wiele liczb materii do dodania do witryny przy użyciu interfejsu API w wersji 10. Tag "matternos" wskazuje wiele liczb materii z odczytem lub nie.

Wersja 18 lub nowsza: wymagana jest kategoria (przeznaczenie witryny). Jeśli cel witryny jest ukryty, zostanie wyświetlony komunikat; w przeciwnym razie ukryte cele witryny nie są dodawane do witryny.

Teraz właściciel witryny może być również przypisany do innych użytkowników, ale musi być uczestnikami witryny i mieć rolę wyższą niż administrator witryny.

Nowsze wersje 18: właściciel witryny może dodać innych użytkowników do witryny.

Od wersji 19 interfejsu API wprowadzono nowy moduł o nazwie customPages, który jest ściśle powiązany z modułem głównym. Jeśli wartość modułu głównego ma wartość True, właściwości customPages muszą mieć wartość true i na odwrót.

Należy pamiętać, że wszystkie właściwości/elementy w odpowiedzi na witrynę nie są możliwe do zaktualizowania/wstawiania. Zapoznaj się z poniższą tabelą, aby dowiedzieć się, które są tylko do odczytu, możliwe do zaktualizowania lub wstawiane.

Archiwizowanie użytkownika

To wywołanie interfejsu API służy do archiwizowania użytkownika w systemie.

Kody błędów

Streszczenie	Kod ref (przed V4)	Kod ref (V4)
Następujący użytkownicy nie istnieją w systemie	110	110
Wymagany jest identyfikator użytkownika	109	109
Identyfikator użytkownika nie jest w odpowiednim formacie	113	113
Długość identyfikatora użytkownika nie może przekraczać 50 znaków	N/A	304

Bilet JIRA: https://dev.highq.com/jira/browse/COL-67441

Dodaj użytkownika

To wywołanie interfejsu API służy do dodawania nowego użytkownika do systemu.
Uwaga:
1. Dodano obsługę następujących nowych pól
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. Tag adresu został dodany w interfejsie API w wersji 4

Streszczenie	Kod ref (przed V4)	Kod ref (V4)
Adres e-mail jest wymagany	101	101
Nieprawidłowy adres e-mail	104	104
Imię jest wymagane	102	102
Maksymalna dozwolona liczba znaków dla pierwszej nazwy musi należeć do zakresu od 1 do 100	102	352
Adres e-mail sekretarza/asystenta jest nieprawidłowy	104	353
Stan musi być aktywny lub nieaktywny	116	116
Wprowadzony dział nie może zawierać więcej niż 256 znaków	N/A	354
Wprowadzony atrybut ifpartner jest nieprawidłowy	N/A	355
Wprowadzony atrybut systemuser jest nieprawidłowy	N/A	356
Wprowadzony atrybut usertypeid jest nieprawidłowy	N/A	357
Wprowadzony atrybut langcode jest nieprawidłowy	N/A	358
Wprowadzony atrybut sourcetype jest nieprawidłowy. Prawidłowe wartości to System, Active Directory lub System domyślny .	N/A	359
Wprowadź prawidłowy numer telefonu	N/A	360
Wprowadź prawidłowy numer telefonu w formacie {countrycode} ${areacode}${number}.	N/A	361
Wprowadź prawidłowy numer telefonu komórkowego w formacie {countrycode}${number}.	N/A	362
Wprowadź prawidłowy kod kraju telefonu biurowego	N/A	363
Kod kraju telefonu biurowego może mieć maksymalnie 4 cyfry	N/A	364
Wprowadź prawidłowy kod obszaru telefonu biurowego	N/A	365
Kod obszaru telefonu biurowego może mieć maksymalnie 5 cyfr	N/A	366
Numer telefonu pakietu Office powinien mieć maksymalnie 15 cyfr	N/A	368
Wprowadź prawidłowy kod kraju telefonu komórkowego	N/A	369
Kod kraju telefonu komórkowego może mieć maksymalnie 4 cyfry	N/A	372
Wprowadź prawidłowy numer telefonu komórkowego	N/A	373
Numer telefonu komórkowego powinien mieć maksymalnie 20 cyfr	N/A	374
Domena nie istnieje	105	105
Wiadomość e-mail już istnieje w systemie	111	111
Wzmianka organizacji w przypadku domeny zarejestrowanej samodzielnie	187	187
Wzmianka o organizacji w przypadku wyjątkowej domeny	115	115
Identyfikator organizacji nie jest w odpowiednim formacie	112	112
Organizacja nie istnieje	106	106
Domena istnieje w inną organizację	114	114
Wprowadzony identyfikator adresu jest nieprawidłowy	N/A	308
Nie można odnaleźć nazwy łącza społecznościowego w systemie.	N/A	375
Nazwa linku społecznościowego jest wymagana	N/A	376
Wymagana jest wartość łącza społecznościowego	N/A	377
Maksymalna liczba znaków dla wartości łącza społecznościowego musi należeć do zakresu od 1 do 500	N/A	378
Wprowadź nazwę linku niestandardowego	N/A	379
Wymagana wartość łącza niestandardowego	N/A	380
Maksymalna liczba znaków dla nazwy łącza niestandardowego musi należeć do zakresu od 1 do 500	N/A	381
Maksymalna liczba znaków dla niestandardowej wartości łącza musi należeć do zakresu od 1 do 500	N/A	382
Wymagana nazwa linku komunikatu	N/A	383
Nie można odnaleźć nazwy łącza komunikatu w systemie	N/A	384
Wymagana wartość łącza komunikatu	N/A	385
Maksymalna liczba znaków dla wartości łącza wiadomości musi należeć do zakresu od 1 do 500	N/A	386
Link społecznościowy jest wyłączony	N/A	408
Link komunikatu jest wyłączony	N/A	409
Łącze niestandardowe jest wyłączone	N/A	410

Bilet JIRA: https://dev.highq.com/jira/browse/COL-65685

Dodawanie istniejącej grupy do witryny

Ta metoda interfejsu API dodaje istniejącą grupę systemową do lokacji.
Ten interfejs API został rozszerzony w celu dodania istniejących podstawowych grup użytkowników systemu (typu systemu/organizacji) w witrynie.

Dodawanie witryny

Użyj tego interfejsu API, aby utworzyć nową witrynę. Obiekt lokacji obsługuje tylko atrybuty widoczne w interfejsie tworzenia lokacji.

Ten interfejs API wymaga nazwy witryny (i obowiązkowych pól skonfigurowanych na poziomie ASP, jeśli istnieje), aby utworzyć nową witrynę.

Tag "module" reprezentuje inny moduł do skonfigurowania w witrynie, jak pokazano w atrybutach żądania.
Aby utworzyć witrynę na podstawie szablonu, przekazując tag "sitetemplateid"
— W przypadku wersji mniejszej niż 7 w żądaniu zostanie podany żaden moduł ("tag modułu" nie zostanie przekazany), zostanie zainstalowana konfiguracja modułu szablonu. Jeśli tag modułu jest dostarczany z konfiguracją, będzie on uwzględniać to i konfigurować jako podane w żądaniu (zamiast korzystać z konfiguracji modułu szablonu)
— W przypadku nowszej wersji 7 w przypadku podania jakiegokolwiek modułu ("tag modułu" zostanie przekazany) lub nie w żądaniu, zostanie zainstalowana konfiguracja modułu szablonu.

Ta metoda nie obsługuje przekazywania obrazu witryny w tym wywołaniu. Obsługa ikon witryny zostanie udostępniona jako osobne wywołanie.
Wywołanie metody oczekuje istniejącego identyfikatora kategorii. Identyfikator kategorii powinien zostać uzyskany przez aplikację wywołującą przez wcześniejsze wywołanie interfejsu kategorii lokacji. Jeśli w żądaniu nie podano żadnych kategorii, żadna kategoria nie zostanie domyślnie dodana (nie jest to żadna kategoria).

Data rozpoczęcia i zakończenia witryny powinna być w formacie "dd MMM rrrr" i nie ma czasu UTC. Klient interfejsu API zawsze zażąda rzeczywistej daty.

Wartość domyślna "strona docelowa" ma wartość domyślną "files (folder główny)".
"Strona docelowa" oczekuje trzech różnych sformułowań lub identyfikacji dla modułu Plik. Możliwe wartości to:
- pliki (folder główny)
— pliki (ostatnie działanie)
- pliki (wyszukiwanie zaawansowane)
Implementacja metody obsługuje teraz (od wersji 5.1) Wielojęzyczną nazwę witryny. Interfejs API w wersji 6 lub nowszej <nazwa witryny> będzie reprezentować treść żądania na podstawie kolejności preferencji użytkownika. Interfejs API w wersji 5 lub starszej <nazwa witryny> będzie reprezentować domyślny angielski angielski w Wielkiej Brytanii.
<sitenametranslations> będzie reprezentować nazwy witryny w każdym językach (co będzie dodatkowym tagiem w "Interfejs API obiektu" z wersji 5.1 lub nowszej) interfejs API w wersji 6 lub nowszej, w treści żądania, wysyłają oba tagi, tj. <nazwa> witryny i <nazwy witrynytranslacji> , a następnie musimy zweryfikować wartości, np. <nazwa witryny> musi być zgodna z odpowiednim <tagiem tłumaczenia> pod względem preferencji języka użytkownika. Interfejs API 7 lub nowszy, witryna utworzona na podstawie szablonu będzie śledzić moduły z szablonu źródłowego i zignoruje listę modułów wysłaną w treści żądania.

Implementacja metody obsługuje teraz tworzenie witryny na podstawie szablonu, udostępniając tag "sitetemplateid" (stare podejście)

Pamiętaj, że obsługa tworzenia witryny na podstawie szablonu przy użyciu tego interfejsu API zostanie wycofana w przyszłości. Aby utworzyć witrynę na podstawie szablonu, użyj nowego interfejsu API Create site from template (/sites/templates/{templateid}/site), który jest długim interfejsem API sondowania (obsługującym długotrwałe żądania)

Ta metoda obsługuje wiele liczb materii do dodania do witryny przy użyciu interfejsu API w wersji 10. Tag "matternos" wskazuje wiele liczb materii z odczytem lub nie. Starsza wersja (mniejsza niż wersja 10) numer pojedynczej materii "matterno" będzie odzwierciedlać pierwszą liczbę istnień wielu materii w lokacji.

Wersja 18 lub nowsza: wymagana jest kategoria (przeznaczenie witryny). Jeśli cel witryny jest ukryty, zostanie wyświetlony komunikat; w przeciwnym razie ukryte cele witryny nie są dodawane do witryny.

Do wersji 17: właściciel witryny jest zalogowanym użytkownikiem; nie można dodawać innych użytkowników.

Nowsze wersje 18: właściciel witryny może dodać innych użytkowników do witryny.

Od wersji 19 interfejsu API wprowadzono nowy moduł o nazwie "customPages", który jest ściśle powiązany z modułem głównym. Jeśli więc wartość modułu głównego ma wartość True, właściwości customPages będą prawdziwe i na odwrót.

Pobieranie informacji o pliku

To wywołanie interfejsu API pobiera szczegółowe informacje dotyczące określonego pliku z platformy HighQ Collaborate.

Pobieranie kolumn iSheet

To wywołanie interfejsu API pobiera kolumny skojarzone z określonym arkuszem iSheet. Ta funkcja jest obsługiwana w interfejsie API w wersji 3 lub nowszej.

Pobieranie listy elementów iSheet

To wywołanie interfejsu API pobiera listę elementów zawartych w określonym arkuszu iSheet.

Pobieranie listy folderów

To wywołanie interfejsu API pobiera listę folderów zawartych w określonym folderze. Parametr "limit" ustawia maksymalną liczbę elementów do zwrócenia, a parametr "offset" określa pozycję początkową pobierania danych. Wartości domyślne są stosowane, jeśli te parametry zostaną pominięte, a foldery są zwracane w kolejności rosnącej według daty utworzenia.

Pobieranie listy użytkowników

Pobierz listę użytkowników Ten interfejs API pobiera listę użytkowników z systemu. ## Kluczowe funkcje — pobieranie szczegółów użytkownika z wieloma opcjami filtrowania — obsługuje stronicowanie przy `limit` użyciu parametrów i `offset` — Nowe parametry zapytania i pola wprowadzone w ostatnich wersjach — odpowiedź ze strukturą z rolami użytkownika i atrybutami ## Nowe parametry zapytania (Version-Specific) — Wprowadzone w wersji 12: - `systemAdminSearch`W przypadku ustawienia na `1`wartość , zwraca tylko użytkowników z rolą Administratora systemu. - Wprowadzone w wersji 18: - : `userid`akceptuje wartości rozdzielane przecinkami (CSV). ## Aktualizacje treści odpowiedzi — dodano nowe pola: — `emaildomain`, `orginvitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcode`, `publicprofiledateOfBirth`## Zmiana formatu adresu (z wersji 11) — `location` nazwa tagu została zmieniona na `address` w celu zapewnienia spójności. - Przykładowa odpowiedź: `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## Role użytkownika (wprowadzone w interfejsie API W wersji 11+) — przykładowa odpowiedź: `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Limity i przesunięcia — Zachowanie limitu: — ustawienie domyślne: `100` jeśli nie podano żadnej wartości. — Służy `-1` do zwracania wszystkich rekordów. - Jeśli wartość jest mniejsza niż `-1`, wartość domyślna to `100`. - Zachowanie przesunięcia: — ustawienie domyślne: `0` jeśli nie podano żadnej wartości. — Jeśli przesunięcie przekracza łączną liczbę rekordów, domyślnie przywraca wartość .`0` ## Wprowadzono nowe role — wersja 12: , `Basic UserAllow user to bypass XSS protection` - : `Allow user to manage Contract Express system groups`## Kody błędów | Podsumowanie | Kod ref (przed V4) | Kod odwołania (wersja 4) | |---------|----------------------|--------------| | Nieprawidłowe dane wejściowe stanu użytkownika (AKTYWNE, ZARCHIWIZOWANE, NIEAKTYWNE) | 147 | 147 | | Identyfikator organizacji jest nieprawidłowy | Nie dotyczy | 260 | | Nieprawidłowa `neverinvited` wartość (prawda/fałsz) | Nie dotyczy | 387 | | Nieprawidłowa `neverlogin` wartość (prawda/fałsz) | Nie dotyczy | 388 | | Nieprawidłowa `groupids` wartość | Nie dotyczy | 214 | | Nieprawidłowa `notingroup` wartość (prawda/fałsz) | Nie dotyczy | 389 | | Nieprawidłowe `ordertype` (obsługiwane: nazwa, organizacja, stan itp.) | Nie dotyczy | 289 | | Nieprawidłowe `orderby` (obsługiwane: asc, desc) | Nie dotyczy | 290 | | Nieprawidłowa `offset` wartość | 138 | 138 | Nieprawidłowa `limit` wartość | 137 | 137 | ## Uwagi — od wersji 13 nowszej ten interfejs API jest otwarty dla wszystkich użytkowników (wcześniej ograniczony do administratorów systemu). — Od wersji 18 do przodu pole wskazuje, `userregistered2FA` czy użytkownik zarejestrował się do 2FA. --- Ten opis jest zgodny z formatowaniem schematu programu Swagger 2.0 i powinien zostać umieszczony w polu opisu w schemacie łącznika niestandardowego.

Przekazywanie pliku

To wywołanie interfejsu API przekazuje plik do określonego folderu na platformie HighQ Collaborate. Obsługuje fragmentowane przekazywanie po podaniu nagłówka Content-Range.

Przenoszenie dokumentów

Ten interfejs API przenosi wiele plików z jednego folderu do innego w tej samej witrynie.

Tworzenie folderu

Ten interfejs API tworzy nowy folder w określonej witrynie. Umożliwia podanie szczegółów folderu i zapewnienie, że folder zostanie utworzony w ramach danego folderu nadrzędnego.

Uzyskiwanie informacji o folderze

Metoda zawiera szczegóły folderu o podanym identyfikatorze folderu.

Aby utworzyć element iSheet

Identyfikator operacji:: insertISheetItems

To wywołanie interfejsu API służy do wstawiania elementu iSheet. Można obsługiwać wiele arkuszy iSheet.

Aby uzyskać stan elementu iSheet na podstawie klucza progresywnego, wywołaj metodę API POST /api/3/progressivekeystatus/{progressive_key}

np. POST /api/{version}/progressivekeystatus/{progressive_key}

Name	Typ	Description
progressive_key	Sznurek	Klucz do sprawdzenia stanu akcji.

Odpowiedź


              
              <progressivekeyresponse>

               \t<items>

                \t\t<, element>

                 \t\t\t<itemid>1232</itemid>

                 \t\t\t<status SUCCESS>/status<>

                 \t\t\t<kod stanu 200>/kod stanu<>

                 \t\t\t<komunikat>Rekord został dodany pomyślnie</komunikat>

                \t\t</item>

                \t\t<, element>

                 \t\t\t<itemid>1233</itemid>

                 \t\t\t<status SUCCESS>/status<>

                 \t\t\t<kod stanu 200>/kod stanu<>

                 \t\t\t<komunikat>Rekord został dodany pomyślnie</komunikat>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	Wersja interfejsu API
Identyfikator iSheet	isheetid	True	integer	Identyfikator arkusza iSheet
Identyfikator widoku arkusza	sheetviewid		integer	Identyfikator widoku iSheet (opcjonalnie)
id	id		integer	Identyfikator Isheet.
title	title		string	Tytuł arkusza.
opis	description		string	Opis arkusza.
stan	status		string	Stan arkusza.
typ dostępu	accesstype		string	Typ dostępu do arkusza.
typ	type		string	Typ arkusza.
viewlink	viewlink		string	Link do adresu URL, aby wyświetlić arkusz.
allowsections	allowsections		string	Wskazuje, czy sekcje są dozwolone.
allowlookup	allowlookup		string	Wskazuje, czy wyszukiwanie jest dozwolone.
displayisheet	displayisheet		string	Wyświetl arkusz isheet.
searchasdefaultview	searchasdefaultview		string	Ustawia wyszukiwanie jako widok domyślny.
enableversion	enableversion		string	Włącz wersję.
enablesheetalerter	enablesheetalerter		string	Aktywuje alerter arkusza.
alertercondition	alertercondition		string	Warunek wyzwalania alertów.
overrideitemmodifieddate	overrideitemmodifieddate		string	Za przejazdem jest data modyfikacji elementu.
enablebulkinsertupdate	enablebulkinsertupdate		string	Zezwalaj na zbiorcze wstawianie aktualizacji.
opisy pól	fielddescriptions		string	opis pól.
enablerowlocking	enablerowlocking		string	Włącza blokowanie wierszy.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Włącza obcinanie limitów znaków dla tekstu wielowierszowego.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	ustawia limit znaków dla obcinania.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Umożliwia ponowne użycie wartości listy wyboru.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Umożliwia ponowne użycie wartości listy wyników.
allowIsheetComments	allowIsheetComments		string	Zezwala na komentarze w arkuszu.
shareRecordsLimit	shareRecordsLimit		integer	Limit rekordów udostępnionych.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Włącz limit rekordów udostępniania.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Umożliwia udostępnianie formularza dodawania rekordu.
allowViewBaseRendering	allowViewBaseRendering		string	Umożliwia podstawowe renderowanie widoków.
kolumna	column		object
recordcount	recordcount		string	Całkowita liczba rekordów.
viewId	viewId		integer	Unikatowy identyfikator widoku.
siteId	siteId		integer	Identyfikator skojarzonej witryny.
nazwa_witryny	siteName		string	Nazwa witryny.
sheetName	sheetName		string	Nazwa arkusza.
viewName	viewName		string	Nazwa widoku.
sheetId	sheetId		integer	Identyfikator arkusza.
sekwencja	sequence		string	Numer sekwencji kolumny nagłówka.
columnValue	columnValue		string	Wartość kolumny nagłówka.
columnTypeId	columnTypeId		string	Identyfikator typu kolumny.
columnId	columnId		string	Unikatowy identyfikator kolumny.
columnTypeAlias	columnTypeAlias		string	Nazwa aliasu dla typu kolumny.
itemsequence	itemsequence		string	Numer sekwencji elementu.
itemid	itemid		string	Unikatowy identyfikator elementu.
externalid	externalid		string	Identyfikator zewnętrzny skojarzony z elementem.
columnid	columnid		integer	Unikatowy identyfikator kolumny
nazwa	name		string	Nazwa kolumny
typ	type		integer	Typ danych kolumny.
typ systemgenerowany	systemgeneratedtype		string	Informacje o typie generowanym przez system.
section	section		integer	Numer sekcji, w której znajduje się kolumna.
opis	description		string	Szczegółowy opis kolumny.
addtodefaultview	addtodefaultview		string	Wskazuje, czy kolumna jest dodawana do widoku domyślnego.
columnconditionstate	columnconditionstate		string	Stan warunku kolumny.
rowid	rowid		integer	Identyfikator wiersza.
columnid	columnid		integer	Identyfikator kolumny.
operatorid	operatorid		integer	Identyfikator operatora.
oprand	oprand		string	Wartość operandu dla filtru.
typ logiczny	logicaltype		string	Typ logiczny filtru.
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	Identyfikator typu wartości filtru arkusza.
displaytype	displaytype		string	Typ wyświetlania filtru.
sourceColumnId	sourceColumnId		integer	Identyfikator kolumny źródłowej filtru.
scoreConditionTypeid	scoreConditionTypeid		integer	Identyfikator typu warunku oceny.
defaultvalue	defaultvalue		string	Wartość domyślna kolumny.
kolumna w całym	columnwidth		string	Szerokość kolumny.
nazwa arkusza	sheetname		string	Nazwa skojarzonego arkusza.
nazwa witryny	sitename		string	Nazwa witryny.
obowiązkowy	mandatory		string	Wskazuje, czy kolumna jest obowiązkowa.
allowsearch	allowsearch		string	Określa, czy wyszukiwanie jest dozwolone.
maxchars	maxchars		integer	Maksymalna liczba znaków.
allowfieldfromanotherisheet	allowfieldfromanotherisheet		string	Zezwala na pole z innego arkusza.
allowrichhtmltext	allowrichhtmltext		string	Określa, czy tekst sformatowany HTML jest dozwolony.
numberoflines	numberoflines		integer	Liczba wierszy w kolumnie.
displaymethod	displaymethod		string	Metoda używana do wyświetlania kolumny.
includeotheroption	includeotheroption		string	Zawiera opcję "Inne".
singleormultileselectioninsearch	singleormultileselectioninsearch		string	Określa typ wyboru w wyszukiwaniu.
id	id		string	Unikatowy identyfikator wybranego elementu.
etykieta	label		string	Etykieta do wyboru.
wynik	score		string	Wynik skojarzony z wyborem.
color	color		string	Kolor kodu do wyboru.
imageid	imageid		integer	Identyfikator skojarzonego obrazu.
includeinalertpreferences	includeinalertpreferences		string	Uwzględnia w preferencjach alertów.
min	min		string	Minimalna wartość kolumny.
max	max		string	Maksymalna wartość kolumny.
miejsca dziesiętne	decimalplaces		integer	Liczba miejsc dziesiętnych.
showthousandseparators	showthousandseparators		string	Wyświetla separatory tysięcy.
showaspercentage	showaspercentage		string	Wyświetla wartość jako wartość procentową.
formattype	formattype		string	Określa typ formatu kolumny.
format daty	dateformat		string	Definiuje format daty dla kolumny.
defaultdateandtime	defaultdateandtime		string	Ustawia domyślną wartość daty i godziny dla kolumny.
arkuszlookup	sheetlookup		string	Wskazuje, czy kolumna jest odnośnikem do innego arkusza.
fielddisplay	fielddisplay		string	Określa sposób wyświetlania pola.
allowmultipleusers	allowmultipleusers		string	Określa, czy wielu użytkowników może uzyskać dostęp do pola.
methodtype	methodtype		string	Definiuje typ metody dla kolumny.
sheetids	sheetids		string	Wyświetla identyfikatory arkuszy skojarzonych z kolumną.
allowuserstorenamelinks	allowuserstorenamelinks		string	Wskazuje, czy użytkownicy mogą zmieniać nazwy łączy w kolumnie.
sheetid	sheetid		integer	Określa identyfikator arkusza.
columnids	columnids		string	Wyświetla listę identyfikatorów kolumn.
viewid	viewid		integer	Określa identyfikator widoku.
allowmultiplevalues	allowmultiplevalues		string	Wskazuje, czy w kolumnie jest dozwolonych wiele wartości.
restrictdelete	restrictdelete		string	Określa, czy usunięcie jest ograniczone dla kolumny.
displaycolumnnameprefix	displaycolumnnameprefix		string	Ustawia prefiks dla wyświetlanej nazwy kolumny.
nazwa łącza	linkname		string	Definiuje nazwę łącza skojarzonego z kolumną.
donotcountweekendsonlycountmontofri	donotcountweekendsonlycountmontofri		string	Określa, czy weekendy są wykluczone w liczeniu.
currentsheetcolumnid	currentsheetcolumnid		integer	Identyfikator bieżącej kolumny arkusza.
targetsheetcolumnid	targetsheetcolumnid		integer	Identyfikator kolumny arkusza docelowego.
formuła	formula		string	Określa formułę zastosowaną do kolumny.
startvalue	startvalue		integer	Ustawia wartość początkową dla kolumny.
prefix	prefix		string	Definiuje prefiks wartości kolumny.
Postfix	postfix		string	Definiuje postfiks wartości kolumny.
minlength	minlength		integer	Określa minimalną długość wartości kolumny.
lookupglossarysheetid	lookupglossarysheetid		integer	Określa identyfikator arkusza słownika odnośników.
lookupglossarysheetviewid	lookupglossarysheetviewid		integer	Określa identyfikator widoku arkusza słownika odnośników.
width	width		integer	Ustawia szerokość kolumny.
otherscorevalue	otherscorevalue		string	Definiuje inną wartość wyniku dla kolumny.
importdatafromexternalsource	importdatafromexternalsource		string	Wskazuje, czy dane są importowane ze źródła zewnętrznego.
analysisengine	analysisengine		string	Określa aparat analizy używany dla kolumny.
attachmentcustomfolderid	attachmentcustomfolderid		integer	Określa identyfikator folderu niestandardowego dla załączników.
isattachmentfoldercurrentsite	isattachmentfoldercurrentsite		integer	Wskazuje, czy folder załącznika znajduje się w bieżącej witrynie.
singleLineEmailValidation	singleLineEmailValidation		string	Określa, czy jest stosowana weryfikacja jednowierszowej poczty e-mail.
readonly	readonly		string	Wskazuje, czy kolumna jest tylko do odczytu.
virtualColumn	virtualColumn		integer	Określa, czy kolumna jest wirtualna.
allowInlineEditing	allowInlineEditing		string	Wskazuje, czy edytowanie wbudowane jest dozwolone dla kolumny.
sekwencja	sequence		string	Numer sekwencji kolumny.
atrybutcolumnid	attributecolumnid		string	Identyfikator kolumny atrybutu.
value	value		string	Wartość danych pierwotnych.
date	date		string	data nieprzetworzonych danych.
time	time		string	Czas nieprzetworzonych danych.
linkdisplayname	linkdisplayname		string	Nazwa łącza wyświetlanego.
linkdisplayurl	linkdisplayurl		string	Wyświetl link adresu URL.
id	id		string	Identyfikator odnośnika
e-mail	email		string	Adres e-mail.
userlookuptype	userlookuptype		string	Typ wyszukiwania użytkownika.
folderid	folderid		string	Identyfikator folderu.
docid	docid		string	Identyfikator dokumentu.
fromdate	fromdate		string	Od daty.
todate	todate		string	Do tej pory.
plik	file		string	Zawartość pliku.
nazwa	name		string	Nazwa załącznika.
porządek	order		string	Kolejność załącznika.
id	id		integer	Unikatowy identyfikator załącznika.
rozszerzenie	extension		string	Formatem.
parentfolderid	parentfolderid		integer	Identyfikator folderu nadrzędnego.
filehttplink	filehttplink		string	Link HTTP w celu uzyskania dostępu do pliku.
ścieżka folderu	folderpath		string	Ścieżka do folderu zawierającego plik.
folderhttplink	folderhttplink		string	Link HTTP do folderu.
filesize	filesize		integer	Rozmiar pliku w bajtach.
redactionStatus	redactionStatus		boolean	Wskazuje, czy plik został zredagowany.
displayname	displayname		string	Nazwa wyświetlana załącznika.
siteid	siteid		integer	Identyfikator witryny skojarzonej z załącznikiem.
recordid (identyfikator rekordu)	recordid		string	Identyfikator rekordu.
nazwa łącza	linkname		string	Nazwa łącza.
apilink	apilink		string	Łącze interfejsu API.
httplink	httplink		string	Łącze HTTP.
colViewPosition	colViewPosition		integer	Położenie kolumny w widoku.
typ kolumny	columntype		string	Typ kolumny.
data utworzenia	createdDate		date-time	Data i godzina utworzenia kolumny.
modifiedDate	modifiedDate		date-time	Data i godzina ostatniej modyfikacji kolumny.
injectReferenceColumn	injectReferenceColumn		integer	Odwołanie do wstrzykiwanej kolumny
parentColumnID	parentColumnID		integer	Identyfikator kolumny nadrzędnej.
reusecolumnidfromisheet	reusecolumnidfromisheet		integer	Identyfikator kolumny ponownie użyty z arkusza danych wejściowych.
choicelistid	choicelistid		integer	Identyfikator listy wyboru skojarzonej z kolumną.
alerteroption	alerteroption		string	Ustawienie opcji alertu dla elementu.
sheettypeid	sheettypeid		integer	Identyfikator typu arkusza.
enableSmartForm	enableSmartForm		string	Aktywuje funkcje formularzy inteligentnych.
allowDeletedItemsView	allowDeletedItemsView		string	Umożliwia wyświetlanie usuniętych elementów.
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	Zezwala na wszystkie kolumny w widokach niestandardowych.

Zwraca

Body: ProgressiveKeyDBO

Aktualizowanie grupy witryn

Identyfikator operacji:: updateSiteGroup

Ta metoda interfejsu API aktualizuje nazwę istniejącej grupy w witrynie.
Ten interfejs API został rozszerzony w celu zaktualizowania nazwy istniejącej podstawowej grupy użytkowników w witrynie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	wersja
Identyfikator witryny	siteid	True	string	Identyfikator witryny.
Wersja interfejsu API	groupid	True	string	`The ID of the site group.`
nazwa	name		string
id	id		integer
copypermissionsfrom	copypermissionsfrom		string
komunikat	message		string
typeID	typeID		integer
typ	type		string
numberofusers	numberofusers		string
utworzone	created		string
modified	modified		string
systemGroupID	systemGroupID		integer
opis	description		string
basicusergroup	basicusergroup		integer

Zwraca

Body: sitegroup

Aktualizowanie witryny

Identyfikator operacji:: updateSite

Użyj tego punktu końcowego interfejsu API, aby zaktualizować szczegóły istniejącej witryny. Interfejs API obsługuje te same pola, które są używane w interfejsie API tworzenia witryny.

Ta metoda obsługuje wiele liczb materii do dodania do witryny przy użyciu interfejsu API w wersji 10. Tag "matternos" wskazuje wiele liczb materii z odczytem lub nie.

Teraz właściciel witryny może być również przypisany do innych użytkowników, ale musi być uczestnikami witryny i mieć rolę wyższą niż administrator witryny.

Nowsze wersje 18: właściciel witryny może dodać innych użytkowników do witryny.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Żądana wersja interfejsu API	version	True	string	wersja interfejsu API
Unikatowy identyfikator witryny	siteid	True	string	Identyfikator witryny
id	id		integer	Identyfikator witryny.
nazwa witryny	sitename		string	Nazwa witryny.
rola	role		string	Rola witryny.
opis witryny	sitedescription		string	Opis witryny.
enabledmodules	enabledmodules		string	Lista modułów z włączoną obsługą witryny.
sitefolderID	sitefolderID		string	Identyfikator folderu witryny.
sitefolderpermission	sitefolderpermission		string	Poziom uprawnień dla folderu witryny.
włączyć	enable		string	Włącz stan homeDBO.
włączyć	enable		string	Włącz stan activityDBO.
mikroblog	microblog		string	Zawartość mikroblogu skojarzona z elementem ActivityDBO.
docid	docid		string	Identyfikator dokumentu.
blogTitle	blogTitle		string	Tytuł wpisu w blogu.
blogContent	blogContent		string	Zawartość wpisu w blogu.
showComment	showComment		integer	pokaż komentarz.
Lista tagów	tagList		array of string	Lista tagów skojarzonych z blogiem.
stan	status		integer	stan wpisu w blogu.
identyfikator witryny	siteID		integer	Identyfikator skojarzonej witryny.
autor	author		string	Autor bloga.
categoryList	categoryList		array of string	Kategorie przypisane do wpisu w blogu.
notificationTypeID	notificationTypeID		integer	Identyfikator typu powiadomienia.
komunikat	message		string	Zawartość wiadomości powiązana z blogem.
messageCode	messageCode		integer	Kod skojarzony z komunikatem.
zewnętrzny ID	externalID		string	Identyfikator zewnętrzny połączony z blogem.
data publikacji	publishDate		string	Data publikacji blogu.
typ procesu	processtype		string	Typ procesu skojarzony z blogiem.
włączyć	enable		string	Włącz stan blogDBO.
wikiid	wikiid		integer	Unikatowy identyfikator witryny typu wiki.
currentversionid	currentversionid		integer	Identyfikator bieżącej wersji witryny typu wiki
parentwikiid	parentwikiid		integer	Identyfikator nadrzędnej witryny typu wiki.
wikititle	wikititle		string	Tytuł strony typu wiki.
wikicontent	wikicontent		string	Zawartość witryny typu wiki.
showcomment	showcomment		integer	Wskazuje, czy komentarze są włączone.
data utworzenia	createddate		string	Data utworzenia witryny typu wiki.
data modyfikacji	modifieddate		string	Data ostatniej modyfikacji witryny typu wiki.
lista tagów	taglist		string	Rozdzielona przecinkami lista tagów skojarzonych ze witryną typu wiki.
wikipath	wikipath		string	Ścieżka dostępu do witryny typu wiki.
wikidraftid	wikidraftid		integer	Identyfikator wersji roboczej witryny typu wiki.
typ wersji roboczej	drafttype		string	Typ wersji roboczej skojarzonej z witryną typu wiki.
stan	status		integer	Bieżący stan strony typu wiki.
wikiversionid	wikiversionid		integer	Identyfikator wersji witryny typu wiki.
indeks	index		string	Indeks lub identyfikator zadania.
parenttaskid	parenttaskid		integer	Identyfikator zadania nadrzędnego.
identyfikator zadania	taskid		integer	Unikatowy identyfikator zadania.
title	title		string	Tytuł zadania.
opis	description		string	Szczegółowy opis zadania.
data ukończenia	duedate		string	Data ukończenia zadania.
data rozpoczęcia	startdate		string	Data rozpoczęcia, kiedy zadanie zostało zainicjowane.
mattermaptaskid	mattermaptaskid		string	Identyfikator łączący się z zadaniem mapy materii.
typ	type		string	Wpisz lub kategorię zadania.
zależny	dependenton		string	Zadania, od których zależy to zadanie.
daysfromdependent	daysfromdependent		string	Liczba dni od zadania zależnego.
ignoreweekend	ignoreweekend		integer	Wskazuje, czy weekendy są ignorowane w harmonogramie.
duration	duration		integer	Czas trwania zadania.
zasób	resource		string	Zasoby przydzielone do zadania.
eventTitle	eventTitle		string	Tytuł wydarzenia.
eventContent	eventContent		string	Zawartość zdarzenia.
showComment	showComment		integer	Wskazuje, czy komentarze są włączone dla zdarzenia.
Lista tagów	tagList		array of string	Lista tagów skojarzonych ze zdarzeniem.
stan	status		integer	Bieżący stan zdarzenia.
identyfikator witryny	siteID		integer	Identyfikator witryny.
kontakt	contact		string	Informacje kontaktowe dotyczące zdarzenia.
categoryList	categoryList		array of string	Kategorie, w których jest wyświetlane zdarzenie.
notificationTypeID	notificationTypeID		integer	Typ powiadomienia związany ze zdarzeniem.
komunikat	message		string	Komunikat zdarzenia.
messageCode	messageCode		integer	Kod komunikatu zdarzenia.
zewnętrzny ID	externalID		string	Identyfikator zewnętrzny.
startDate	startDate		string	Data rozpoczęcia zdarzenia.
data zakończenia	endDate		string	Data zakończenia wydarzenia.
startTime	startTime		string	Godzina rozpoczęcia zdarzenia.
endTime	endTime		string	Godzina zakończenia zdarzenia.
lokalizacja	location		string	Lokalizacja zdarzenia.
autor	author		string	Autor wydarzenia.
typ procesu	processtype		string	Czas procesu zdarzenia.
włączyć	enable		string	Włącz zdarzenie.
id	id		integer	Unikatowy identyfikator arkusza iSheet.
title	title		string	Tytuł arkusza iSheet.
opis	description		string	Opis arkusza isheet.
stan	status		string	Stan arkusza isheet.
typ dostępu	accesstype		string	Typ dostępu arkusza isheet.
typ	type		string	Typ arkusza isheet.
viewlink	viewlink		string	Połącz, aby wyświetlić arkusz iSheet.
allowsections	allowsections		string	Czy sekcje są dozwolone.
allowlookup	allowlookup		string	Określa, czy pola odnośników są włączone.
displayisheet	displayisheet		string	Opcje wyświetlania dla arkusza iSheet.
searchasdefaultview	searchasdefaultview		string	Wskazuje, czy wyszukiwanie jest widokiem domyślnym.
enableversion	enableversion		string	Flaga z włączoną obsługą wersji.
enablesheetalerter	enablesheetalerter		string	Flaga umożliwiająca włączenie alertów arkusza.
alertercondition	alertercondition		string	Warunki wyzwalania alertów.
overrideitemmodifieddate	overrideitemmodifieddate		string	Zastąpij flagę daty modyfikacji.
enablebulkinsertupdate	enablebulkinsertupdate		string	Włącz wstawianie/aktualizowanie zbiorcze.
opisy pól	fielddescriptions		string	Opisy pól dla arkusza iSheet.
enablerowlocking	enablerowlocking		string	Włącz blokowanie na poziomie wiersza.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Obcinanie wielowierszowej flagi tekstowej.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Limit znaków dla obcinania wielowierszowego.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Zezwalaj na ponowne użycie wartości listy wyboru.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Zezwalaj na ponowne użycie wartości listy wyników.
allowIsheetComments	allowIsheetComments		string	Zezwalaj na komentarze w usłudze iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Limit rekordów, które mogą być udostępniane.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Włączony limit udziału rekordów.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Włącz udostępnianie formularzy na potrzeby dodawania rekordów.
recordcount	recordcount		string	Bieżąca liczba rekordów.
sheettypeid	sheettypeid		integer	Identyfikator typu arkusza iSheet
włączyć	enable		string	Włącz funkcję QA.
userid	userid		integer	Identyfikator użytkownika.
e-mail	email		string	adres e-mail.
httpavatar	httpavatar		string	Adres URL HTTP awatara.
awatar	avatar		string	Obraz awatara.
userlink	userlink		string	Połącz z profilem użytkownika.
httplink	httplink		string	Link HTTP do profilu użytkownika.
phone	phone		string	Numer.
mobilne	mobile		string	Numer telefonu komórkowego.
departament	department		string	Dział użytkownika.
włączyć	enable		string	Włącz integrację kontraktu Express.
adminnote	adminnote		string	Uwagi administracyjne związane z witryną.
data rozpoczęcia	startdate		string	Data rozpoczęcia operacji lokacji.
enddate	enddate		string	Data zakończenia operacji lokacji.
data utworzenia	createddate		string	Data utworzenia witryny.
archiveddate	archiveddate		string	Data archiwizacji witryny.
clientno	clientno		string	Numer klienta skojarzony z lokacją.
matterno	matterno		string	Numer sprawy skojarzony z witryną.
strona docelowa	landingpage		string	Adres URL strony docelowej witryny.
łącze	link		string	Link powiązany z witryną.
stan	status		string	Bieżący stan witryny.
statusid	statusid		integer	Identyfikator stanu witryny.
size	size		string	Rozmiar witryny.
przypisy rozliczeniowe	billingnotes		string	Uwagi związane z rozliczeniami dla witryny.
billingnextinvoicedate	billingnextinvoicedate		string	Data następnej faktury dla witryny.
billinglastinvoicedate	billinglastinvoicedate		string	Data ostatniej faktury dla witryny.
filepagecount	filepagecount		string	Łączna liczba stron plików w witrynie.
maxpagecount	maxpagecount		string	Maksymalna dozwolona liczba stron dla plików w witrynie.
sitehttplink	sitehttplink		string	Link HTTP do witryny.
isSyncable	isSyncable		integer	Wskazuje, czy lokacja jest synchronizowana.
enforceusergroups	enforceusergroups		string	Grupy użytkowników wymuszane dla witryny.
csvSiteCategory	csvSiteCategory		string	Kategoria witryny w formacie CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Nazwa witryny w języku domyślnym.
widoczny	visible		integer	Wskazuje, czy witryna jest widoczna.
siteLogoName	siteLogoName		string	Nazwa pliku logo witryny.
siteLogoFileSize	siteLogoFileSize		integer	Rozmiar pliku logo witryny.
siteLogoHeight	siteLogoHeight		integer	Wysokość logo witryny.
siteLogoWidth	siteLogoWidth		integer	Szerokość logo witryny.
siteStatus	siteStatus		integer	Kod stanu witryny.
applySiteTerms	applySiteTerms		integer	Wskazuje, czy są stosowane terminy witryny.
siteTerm	siteTerm		string	Warunki stosowane do witryny.
termType	termType		integer	Typ terminów zastosowanych do witryny.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Wskazuje, czy warunki witryny są wymagane podczas następnego logowania.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Wskazuje, czy są włączone domyślne terminy witryny.
advancedQAPermission	advancedQAPermission		integer	Zaawansowany poziom uprawnień kontroli jakości dla witryny.
isInternal (Wewnętrzny)	isInternal		integer	Wskazuje, czy lokacja jest wewnętrzna.
Psm	psm		integer	Identyfikator menedżera usług produktu.
siteLabelDisplay	siteLabelDisplay		string	Etykieta wyświetlana witryny.
allowSiteAdministration	allowSiteAdministration		integer	Wskazuje, czy administrowanie witryną jest dozwolone.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Aby włączyć ochronę haseł na poziomie lokacji.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Aby włączyć ochronę kodu dostępu na poziomie lokacji.
kod dostępuUsingAuthApp	passcodeUsingAuthApp		integer	Wskazuje, czy uwierzytelnianie kodu dostępu używa aplikacji uwierzytelniania.
sitePassword	sitePassword		string	Hasło skojarzone z witryną.
ipRestrictionEnable	ipRestrictionEnable		integer	Aby włączyć ograniczenia adresów IP dla dostępu do witryny.
availableIP	availableIP		string	Rozdzielona przecinkami lista adresów IP, które mogą uzyskiwać dostęp do witryny.
highqDrive	highqDrive		integer	Wskazuje, czy włączono integrację dysku HighQ.
applySiteHomePage	applySiteHomePage		integer	Aby zastosować niestandardową stronę główną witryny.
siteHomePage	siteHomePage		string	Adres URL niestandardowej strony głównej witryny.
siteHomePageType	siteHomePageType		integer	Typ strony głównej.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Aby ustawić następne logowanie do strony głównej witryny.
applyDisplayContent	applyDisplayContent		integer	Aby zastosować ustawienia zawartości wyświetlania.
displayContent	displayContent		string	Zawartość do wyświetlenia w witrynie.
rssSecurity	rssSecurity		integer	Poziom zabezpieczeń kanału informacyjnego RSS.
zaszyfrowane hasło	encryptedPassword		integer	Wskazuje, czy hasło witryny jest szyfrowane.
availableIPRangeCSV	availableIPRangeCSV		string	Rozdzielona przecinkami lista zakresów adresów IP, które mogą uzyskiwać dostęp do witryny.
siteModuleID	siteModuleID		integer	Identyfikator modułu lokacji.
icalSecurity	icalSecurity		integer	Poziom zabezpieczeń kanału informacyjnego iCal.
defaultDisplayContent	defaultDisplayContent		string	Domyślna zawartość do wyświetlenia w witrynie.
defaultEmailAlert	defaultEmailAlert		integer	Aby włączyć domyślne alerty e-mail.
excelReportFooter	excelReportFooter		integer	Zawiera stopkę w raportach programu Excel.
excelReportFooterText	excelReportFooterText		string	Tekst do wyświetlenia w stopce raportów programu Excel.
anonsMLJSON	announcementMLJSON		string	Anonsy w formacie JSON dla witryny.
templateType (typ szablonu)	templateType		integer	Typ szablonu używanego dla witryny.
templateLicence	templateLicence		integer	Typ licencji szablonu witryny.
openChannelAppID	openChannelAppID		string	Identyfikator aplikacji na potrzeby integracji z otwartym kanałem.
itemid	itemid		integer	Identyfikator elementu skojarzonego z witryną.
sitemetadatasheetid	sitemetadatasheetid		integer	Identyfikator arkusza metadanych skojarzonego z witryną.
moja witryna	mysite		boolean	Wskazuje, czy jest to witryna osobista użytkownika.
lastaccesseddate	lastaccesseddate		string	Data i godzina ostatniego uzyskania dostępu do witryny.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Domyślna karta metadanych przeglądarki witryn.
documentMetadataViewId	documentMetadataViewId		integer	metadane dokumentu dla identyfikatora widoku.
folderMetadataViewId	folderMetadataViewId		integer	metadane folderu dla identyfikatora widoku.
docSort	docSort		integer	Kolejność sortowania dokumentów.
folderSort	folderSort		integer	Kolejność sortowania folderów.
defaultFolderRenderView	defaultFolderRenderView		integer	Określa domyślny tryb wyświetlania folderów.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Domyślna lokalizacja załączników zadań.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Unikatowy identyfikator folderu wyznaczonego jako domyślna lokalizacja załączników zadań.
faworyt	favourite		string	status ulubionego.
enabledocumentredaction	enabledocumentredaction		boolean	Określa, czy dla witryny włączono redaction dokumentu.
grupy wzmianek	mentiongroups		integer	Wymienione grupy.
enablefilerelationships	enablefilerelationships		boolean	Wskazuje, czy relacje plików są włączone.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Poziom uprawnień wymagany do zarządzania relacjami plików.

Archiwizowanie użytkownika

Identyfikator operacji:: deleteUser

To wywołanie interfejsu API służy do archiwizowania użytkownika w systemie.

Kody błędów

Streszczenie	Kod ref (przed V4)	Kod ref (V4)
Następujący użytkownicy nie istnieją w systemie	110	110
Wymagany jest identyfikator użytkownika	109	109
Identyfikator użytkownika nie jest w odpowiednim formacie	113	113
Długość identyfikatora użytkownika nie może przekraczać 50 znaków	N/A	304

Bilet JIRA: https://dev.highq.com/jira/browse/COL-67441

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	wersja interfejsu API
Identyfikator użytkownika	userid	True	string	identyfikator użytkownika

Dodaj użytkownika

Identyfikator operacji:: createUser

Streszczenie	Kod ref (przed V4)	Kod ref (V4)
Adres e-mail jest wymagany	101	101
Nieprawidłowy adres e-mail	104	104
Imię jest wymagane	102	102
Maksymalna dozwolona liczba znaków dla pierwszej nazwy musi należeć do zakresu od 1 do 100	102	352
Adres e-mail sekretarza/asystenta jest nieprawidłowy	104	353
Stan musi być aktywny lub nieaktywny	116	116
Wprowadzony dział nie może zawierać więcej niż 256 znaków	N/A	354
Wprowadzony atrybut ifpartner jest nieprawidłowy	N/A	355
Wprowadzony atrybut systemuser jest nieprawidłowy	N/A	356
Wprowadzony atrybut usertypeid jest nieprawidłowy	N/A	357
Wprowadzony atrybut langcode jest nieprawidłowy	N/A	358
Wprowadzony atrybut sourcetype jest nieprawidłowy. Prawidłowe wartości to System, Active Directory lub System domyślny .	N/A	359
Wprowadź prawidłowy numer telefonu	N/A	360
Wprowadź prawidłowy numer telefonu w formacie {countrycode} ${areacode}${number}.	N/A	361
Wprowadź prawidłowy numer telefonu komórkowego w formacie {countrycode}${number}.	N/A	362
Wprowadź prawidłowy kod kraju telefonu biurowego	N/A	363
Kod kraju telefonu biurowego może mieć maksymalnie 4 cyfry	N/A	364
Wprowadź prawidłowy kod obszaru telefonu biurowego	N/A	365
Kod obszaru telefonu biurowego może mieć maksymalnie 5 cyfr	N/A	366
Numer telefonu pakietu Office powinien mieć maksymalnie 15 cyfr	N/A	368
Wprowadź prawidłowy kod kraju telefonu komórkowego	N/A	369
Kod kraju telefonu komórkowego może mieć maksymalnie 4 cyfry	N/A	372
Wprowadź prawidłowy numer telefonu komórkowego	N/A	373
Numer telefonu komórkowego powinien mieć maksymalnie 20 cyfr	N/A	374
Domena nie istnieje	105	105
Wiadomość e-mail już istnieje w systemie	111	111
Wzmianka organizacji w przypadku domeny zarejestrowanej samodzielnie	187	187
Wzmianka o organizacji w przypadku wyjątkowej domeny	115	115
Identyfikator organizacji nie jest w odpowiednim formacie	112	112
Organizacja nie istnieje	106	106
Domena istnieje w inną organizację	114	114
Wprowadzony identyfikator adresu jest nieprawidłowy	N/A	308
Nie można odnaleźć nazwy łącza społecznościowego w systemie.	N/A	375
Nazwa linku społecznościowego jest wymagana	N/A	376
Wymagana jest wartość łącza społecznościowego	N/A	377
Maksymalna liczba znaków dla wartości łącza społecznościowego musi należeć do zakresu od 1 do 500	N/A	378
Wprowadź nazwę linku niestandardowego	N/A	379
Wymagana wartość łącza niestandardowego	N/A	380
Maksymalna liczba znaków dla nazwy łącza niestandardowego musi należeć do zakresu od 1 do 500	N/A	381
Maksymalna liczba znaków dla niestandardowej wartości łącza musi należeć do zakresu od 1 do 500	N/A	382
Wymagana nazwa linku komunikatu	N/A	383
Nie można odnaleźć nazwy łącza komunikatu w systemie	N/A	384
Wymagana wartość łącza komunikatu	N/A	385
Maksymalna liczba znaków dla wartości łącza wiadomości musi należeć do zakresu od 1 do 500	N/A	386
Link społecznościowy jest wyłączony	N/A	408
Link komunikatu jest wyłączony	N/A	409
Łącze niestandardowe jest wyłączone	N/A	410

Bilet JIRA: https://dev.highq.com/jira/browse/COL-65685

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	wersja interfejsu API
indeks	index		integer	Unikatowy indeks dla użytkownika.
userid	userid		integer	Unikatowy identyfikator użytkownika.
imię	firstname		string	Imię użytkownika.
nazwisko	lastname		string	Nazwisko użytkownika.
grupa robocza	practicegroup		string	Grupa praktyk, do którego należy użytkownik.
langcode	langcode		string	Kod języka użytkownika.
identyfikator ustawień regionalnych	localeID		string	Identyfikator ustawień regionalnych użytkownika.
publicprofile	publicprofile		string	Profil publiczny użytkownika.
pwpid	pwpid		string	Identyfikator programu PWP użytkownika.
usertypeid	usertypeid		string	Identyfikator typu użytkownika.
systemuser	systemuser		string	Flaga użytkownika systemu.
e-mail	email		string	Email adres użytkownika.
phone	phone		string	Numer telefonu użytkownika.
mobilne	mobile		string	Numer telefonu komórkowego użytkownika.
departament	department		string	Dział użytkownika.
organizacja	org		string	Organizacja, do którego należy użytkownik.
addressline1	addressline1		string	Pierwszy wiersz adresu.
addressline2	addressline2		string	Drugi wiersz adresu.
addressline3	addressline3		string	Trzeci wiersz adresu.
city	city		string	Miasto, w którym znajduje się adres.
stan	state		string	Stan adresu.
country	country		string	Kraj adresu.
Kodów pocztowych	postcode		string	Kod pocztowy adresu.
addressid	addressid		string	Unikatowy identyfikator adresu.
addressline1	addressline1		string	Pierwszy wiersz adresu.
addressline2	addressline2		string	Drugi wiersz adresu.
addressline3	addressline3		string	Trzeci wiersz adresu.
city	city		string	Miasto, w którym znajduje się adres.
stan	state		string	Stan adresu.
country	country		string	Kraj adresu.
Kodów pocztowych	postCode		string	Kod pocztowy adresu.
znane	knownas		string	Alternatywna nazwa lub pseudonim adresu.
środowisko	experience		array of string
id	id		string	Identyfikator łącza
nazwa	name		string	Nazwa łącza.
value	value		string	Wartość łącza.
id	id		string	Identyfikator łącza
nazwa	name		string	Nazwa łącza.
value	value		string	Wartość łącza.
id	id		string	Identyfikator łącza
nazwa	name		string	Nazwa łącza.
value	value		string	Wartość łącza.
img	img		string
reportsto	reportsto		string
nazwa metadanych	metadataname		array of string
metadatavalue	metadatavalue		array of string
grupa	group		array of string
externalid	externalid		string	Identyfikator zewnętrzny użytkownika.
jobtitle	jobtitle		string	Stanowisko użytkownika.
sekretarzname	secretaryname		string	Nazwa sekretarza użytkownika.
sekretarzmail	secretarymail		string	Adres e-mail sekretarza użytkownika.
Specjały	specialities		string	Kolekcje użytkownika.
title	title		string	Tytuł użytkownika.
goesby	goesby		string	preferowana nazwa użytkownika.
przyrostek	suffix		string	Sufiks nazwy użytkownika.
atomlink	atomlink		string	Link Atom skojarzony z użytkownikiem.
bio	bio		string	Biografia użytkownika.
dateOfBirth	dateOfBirth		string	Data urodzenia użytkownika.
łącze	link		string	Łącze skojarzone z użytkownikiem.
stan	status		string	Stan użytkownika.
statuscode	statuscode		string	Kod stanu użytkownika.
komunikat	message		string	Komunikat skojarzony z użytkownikiem.
typ źródła	sourcetype		string	Typ źródła użytkownika.
identyfikator orgid	orgid		string	Identyfikator organizacji.
ifpartner	ifpartner		string	Flaga partnera.
emaildomain	emaildomain		string	Domena poczty e-mail użytkownika.
zaproszenie	invitationsent		string	Flaga wysłanego zaproszenia.
utworzone przez	createdby		string	Użytkownik, który utworzył rekord.
data utworzenia	createddate		string	Data utworzenia rekordu.
zmodyfikowany przez	modifiedby		string	Użytkownik, który zmodyfikował rekord.
data modyfikacji	modifieddate		string	Data modyfikacji rekordu.
lastlogindate	lastlogindate		string	Data ostatniego logowania.
invalidlogins	invalidlogins		string	Liczba nieprawidłowych prób logowania.
publicwebsiteprofileid	publicwebsiteprofileid		string	Identyfikator profilu publicznej witryny internetowej.
resetpassworddate	resetpassworddate		string	Data zresetowania hasła.
awatar	avatar		string	Adres URL obrazu awatara.
następujące konto	followingcount		integer	Liczba obserwowanych użytkowników.
liczba obserwowanych	followercount		integer	Liczba obserwujących.
następujący	following		boolean	Następująca flaga.
rola	role		string	Rola użytkownika.
isbasicuser	isbasicuser		string	Flaga użytkownika podstawowego.
encryptedUserId	encryptedUserId		string	Zaszyfrowany identyfikator użytkownika.
selfregistered	selfregistered		integer	Flaga zarejestrowana samodzielnie.
registeredWith2FA	registeredWith2FA		string	Flaga rejestracji uwierzytelniania dwuskładnikowego.
isInternal (Wewnętrzny)	isInternal		integer	Wewnętrzna flaga użytkownika.
nazwa organizacji	orgName		string	Nazwa organizacji.

Zwraca

Body: IntegrationUserDBO

Dodawanie istniejącej grupy do witryny

Identyfikator operacji:: addExistingGroupToSite

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	wersja
Identyfikator witryny	siteid	True	string	Identyfikator witryny.
Identyfikator grupy systemowej	groupid	True	string	Identyfikator grupy systemowej, która ma zostać dodana do lokacji.

Zwraca

Body: sitegroup

Dodawanie witryny

Identyfikator operacji:: createSite

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Żądana wersja interfejsu API	version	True	string	wersja interfejsu API
id	id		integer	Identyfikator witryny.
nazwa witryny	sitename		string	Nazwa witryny.
rola	role		string	Rola witryny.
opis witryny	sitedescription		string	Opis witryny.
enabledmodules	enabledmodules		string	Lista modułów z włączoną obsługą witryny.
sitefolderID	sitefolderID		string	Identyfikator folderu witryny.
sitefolderpermission	sitefolderpermission		string	Poziom uprawnień dla folderu witryny.
włączyć	enable		string	Włącz stan homeDBO.
włączyć	enable		string	Włącz stan activityDBO.
mikroblog	microblog		string	Zawartość mikroblogu skojarzona z elementem ActivityDBO.
docid	docid		string	Identyfikator dokumentu.
blogTitle	blogTitle		string	Tytuł wpisu w blogu.
blogContent	blogContent		string	Zawartość wpisu w blogu.
showComment	showComment		integer	pokaż komentarz.
Lista tagów	tagList		array of string	Lista tagów skojarzonych z blogiem.
stan	status		integer	stan wpisu w blogu.
identyfikator witryny	siteID		integer	Identyfikator skojarzonej witryny.
autor	author		string	Autor bloga.
categoryList	categoryList		array of string	Kategorie przypisane do wpisu w blogu.
notificationTypeID	notificationTypeID		integer	Identyfikator typu powiadomienia.
komunikat	message		string	Zawartość wiadomości powiązana z blogem.
messageCode	messageCode		integer	Kod skojarzony z komunikatem.
zewnętrzny ID	externalID		string	Identyfikator zewnętrzny połączony z blogem.
data publikacji	publishDate		string	Data publikacji blogu.
typ procesu	processtype		string	Typ procesu skojarzony z blogiem.
włączyć	enable		string	Włącz stan blogDBO.
wikiid	wikiid		integer	Unikatowy identyfikator witryny typu wiki.
currentversionid	currentversionid		integer	Identyfikator bieżącej wersji witryny typu wiki
parentwikiid	parentwikiid		integer	Identyfikator nadrzędnej witryny typu wiki.
wikititle	wikititle		string	Tytuł strony typu wiki.
wikicontent	wikicontent		string	Zawartość witryny typu wiki.
showcomment	showcomment		integer	Wskazuje, czy komentarze są włączone.
data utworzenia	createddate		string	Data utworzenia witryny typu wiki.
data modyfikacji	modifieddate		string	Data ostatniej modyfikacji witryny typu wiki.
lista tagów	taglist		string	Rozdzielona przecinkami lista tagów skojarzonych ze witryną typu wiki.
wikipath	wikipath		string	Ścieżka dostępu do witryny typu wiki.
wikidraftid	wikidraftid		integer	Identyfikator wersji roboczej witryny typu wiki.
typ wersji roboczej	drafttype		string	Typ wersji roboczej skojarzonej z witryną typu wiki.
stan	status		integer	Bieżący stan strony typu wiki.
wikiversionid	wikiversionid		integer	Identyfikator wersji witryny typu wiki.
indeks	index		string	Indeks lub identyfikator zadania.
parenttaskid	parenttaskid		integer	Identyfikator zadania nadrzędnego.
identyfikator zadania	taskid		integer	Unikatowy identyfikator zadania.
title	title		string	Tytuł zadania.
opis	description		string	Szczegółowy opis zadania.
data ukończenia	duedate		string	Data ukończenia zadania.
data rozpoczęcia	startdate		string	Data rozpoczęcia, kiedy zadanie zostało zainicjowane.
mattermaptaskid	mattermaptaskid		string	Identyfikator łączący się z zadaniem mapy materii.
typ	type		string	Wpisz lub kategorię zadania.
zależny	dependenton		string	Zadania, od których zależy to zadanie.
daysfromdependent	daysfromdependent		string	Liczba dni od zadania zależnego.
ignoreweekend	ignoreweekend		integer	Wskazuje, czy weekendy są ignorowane w harmonogramie.
duration	duration		integer	Czas trwania zadania.
zasób	resource		string	Zasoby przydzielone do zadania.
eventTitle	eventTitle		string	Tytuł wydarzenia.
eventContent	eventContent		string	Zawartość zdarzenia.
showComment	showComment		integer	Wskazuje, czy komentarze są włączone dla zdarzenia.
Lista tagów	tagList		array of string	Lista tagów skojarzonych ze zdarzeniem.
stan	status		integer	Bieżący stan zdarzenia.
identyfikator witryny	siteID		integer	Identyfikator witryny.
kontakt	contact		string	Informacje kontaktowe dotyczące zdarzenia.
categoryList	categoryList		array of string	Kategorie, w których jest wyświetlane zdarzenie.
notificationTypeID	notificationTypeID		integer	Typ powiadomienia związany ze zdarzeniem.
komunikat	message		string	Komunikat zdarzenia.
messageCode	messageCode		integer	Kod komunikatu zdarzenia.
zewnętrzny ID	externalID		string	Identyfikator zewnętrzny.
startDate	startDate		string	Data rozpoczęcia zdarzenia.
data zakończenia	endDate		string	Data zakończenia wydarzenia.
startTime	startTime		string	Godzina rozpoczęcia zdarzenia.
endTime	endTime		string	Godzina zakończenia zdarzenia.
lokalizacja	location		string	Lokalizacja zdarzenia.
autor	author		string	Autor wydarzenia.
typ procesu	processtype		string	Czas procesu zdarzenia.
włączyć	enable		string	Włącz zdarzenie.
id	id		integer	Unikatowy identyfikator arkusza iSheet.
title	title		string	Tytuł arkusza iSheet.
opis	description		string	Opis arkusza isheet.
stan	status		string	Stan arkusza isheet.
typ dostępu	accesstype		string	Typ dostępu arkusza isheet.
typ	type		string	Typ arkusza isheet.
viewlink	viewlink		string	Połącz, aby wyświetlić arkusz iSheet.
allowsections	allowsections		string	Czy sekcje są dozwolone.
allowlookup	allowlookup		string	Określa, czy pola odnośników są włączone.
displayisheet	displayisheet		string	Opcje wyświetlania dla arkusza iSheet.
searchasdefaultview	searchasdefaultview		string	Wskazuje, czy wyszukiwanie jest widokiem domyślnym.
enableversion	enableversion		string	Flaga z włączoną obsługą wersji.
enablesheetalerter	enablesheetalerter		string	Flaga umożliwiająca włączenie alertów arkusza.
alertercondition	alertercondition		string	Warunki wyzwalania alertów.
overrideitemmodifieddate	overrideitemmodifieddate		string	Zastąpij flagę daty modyfikacji.
enablebulkinsertupdate	enablebulkinsertupdate		string	Włącz wstawianie/aktualizowanie zbiorcze.
opisy pól	fielddescriptions		string	Opisy pól dla arkusza iSheet.
enablerowlocking	enablerowlocking		string	Włącz blokowanie na poziomie wiersza.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Obcinanie wielowierszowej flagi tekstowej.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Limit znaków dla obcinania wielowierszowego.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Zezwalaj na ponowne użycie wartości listy wyboru.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Zezwalaj na ponowne użycie wartości listy wyników.
allowIsheetComments	allowIsheetComments		string	Zezwalaj na komentarze w usłudze iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Limit rekordów, które mogą być udostępniane.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Włączony limit udziału rekordów.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Włącz udostępnianie formularzy na potrzeby dodawania rekordów.
recordcount	recordcount		string	Bieżąca liczba rekordów.
sheettypeid	sheettypeid		integer	Identyfikator typu arkusza iSheet
włączyć	enable		string	Włącz funkcję QA.
userid	userid		integer	Identyfikator użytkownika.
e-mail	email		string	adres e-mail.
httpavatar	httpavatar		string	Adres URL HTTP awatara.
awatar	avatar		string	Obraz awatara.
userlink	userlink		string	Połącz z profilem użytkownika.
httplink	httplink		string	Link HTTP do profilu użytkownika.
phone	phone		string	Numer.
mobilne	mobile		string	Numer telefonu komórkowego.
departament	department		string	Dział użytkownika.
włączyć	enable		string	Włącz integrację kontraktu Express.
adminnote	adminnote		string	Uwagi administracyjne związane z witryną.
data rozpoczęcia	startdate		string	Data rozpoczęcia operacji lokacji.
enddate	enddate		string	Data zakończenia operacji lokacji.
data utworzenia	createddate		string	Data utworzenia witryny.
archiveddate	archiveddate		string	Data archiwizacji witryny.
clientno	clientno		string	Numer klienta skojarzony z lokacją.
matterno	matterno		string	Numer sprawy skojarzony z witryną.
strona docelowa	landingpage		string	Adres URL strony docelowej witryny.
łącze	link		string	Link powiązany z witryną.
stan	status		string	Bieżący stan witryny.
statusid	statusid		integer	Identyfikator stanu witryny.
size	size		string	Rozmiar witryny.
przypisy rozliczeniowe	billingnotes		string	Uwagi związane z rozliczeniami dla witryny.
billingnextinvoicedate	billingnextinvoicedate		string	Data następnej faktury dla witryny.
billinglastinvoicedate	billinglastinvoicedate		string	Data ostatniej faktury dla witryny.
filepagecount	filepagecount		string	Łączna liczba stron plików w witrynie.
maxpagecount	maxpagecount		string	Maksymalna dozwolona liczba stron dla plików w witrynie.
sitehttplink	sitehttplink		string	Link HTTP do witryny.
isSyncable	isSyncable		integer	Wskazuje, czy lokacja jest synchronizowana.
enforceusergroups	enforceusergroups		string	Grupy użytkowników wymuszane dla witryny.
csvSiteCategory	csvSiteCategory		string	Kategoria witryny w formacie CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Nazwa witryny w języku domyślnym.
widoczny	visible		integer	Wskazuje, czy witryna jest widoczna.
siteLogoName	siteLogoName		string	Nazwa pliku logo witryny.
siteLogoFileSize	siteLogoFileSize		integer	Rozmiar pliku logo witryny.
siteLogoHeight	siteLogoHeight		integer	Wysokość logo witryny.
siteLogoWidth	siteLogoWidth		integer	Szerokość logo witryny.
siteStatus	siteStatus		integer	Kod stanu witryny.
applySiteTerms	applySiteTerms		integer	Wskazuje, czy są stosowane terminy witryny.
siteTerm	siteTerm		string	Warunki stosowane do witryny.
termType	termType		integer	Typ terminów zastosowanych do witryny.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Wskazuje, czy warunki witryny są wymagane podczas następnego logowania.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Wskazuje, czy są włączone domyślne terminy witryny.
advancedQAPermission	advancedQAPermission		integer	Zaawansowany poziom uprawnień kontroli jakości dla witryny.
isInternal (Wewnętrzny)	isInternal		integer	Wskazuje, czy lokacja jest wewnętrzna.
Psm	psm		integer	Identyfikator menedżera usług produktu.
siteLabelDisplay	siteLabelDisplay		string	Etykieta wyświetlana witryny.
allowSiteAdministration	allowSiteAdministration		integer	Wskazuje, czy administrowanie witryną jest dozwolone.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Aby włączyć ochronę haseł na poziomie lokacji.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Aby włączyć ochronę kodu dostępu na poziomie lokacji.
kod dostępuUsingAuthApp	passcodeUsingAuthApp		integer	Wskazuje, czy uwierzytelnianie kodu dostępu używa aplikacji uwierzytelniania.
sitePassword	sitePassword		string	Hasło skojarzone z witryną.
ipRestrictionEnable	ipRestrictionEnable		integer	Aby włączyć ograniczenia adresów IP dla dostępu do witryny.
availableIP	availableIP		string	Rozdzielona przecinkami lista adresów IP, które mogą uzyskiwać dostęp do witryny.
highqDrive	highqDrive		integer	Wskazuje, czy włączono integrację dysku HighQ.
applySiteHomePage	applySiteHomePage		integer	Aby zastosować niestandardową stronę główną witryny.
siteHomePage	siteHomePage		string	Adres URL niestandardowej strony głównej witryny.
siteHomePageType	siteHomePageType		integer	Typ strony głównej.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Aby ustawić następne logowanie do strony głównej witryny.
applyDisplayContent	applyDisplayContent		integer	Aby zastosować ustawienia zawartości wyświetlania.
displayContent	displayContent		string	Zawartość do wyświetlenia w witrynie.
rssSecurity	rssSecurity		integer	Poziom zabezpieczeń kanału informacyjnego RSS.
zaszyfrowane hasło	encryptedPassword		integer	Wskazuje, czy hasło witryny jest szyfrowane.
availableIPRangeCSV	availableIPRangeCSV		string	Rozdzielona przecinkami lista zakresów adresów IP, które mogą uzyskiwać dostęp do witryny.
siteModuleID	siteModuleID		integer	Identyfikator modułu lokacji.
icalSecurity	icalSecurity		integer	Poziom zabezpieczeń kanału informacyjnego iCal.
defaultDisplayContent	defaultDisplayContent		string	Domyślna zawartość do wyświetlenia w witrynie.
defaultEmailAlert	defaultEmailAlert		integer	Aby włączyć domyślne alerty e-mail.
excelReportFooter	excelReportFooter		integer	Zawiera stopkę w raportach programu Excel.
excelReportFooterText	excelReportFooterText		string	Tekst do wyświetlenia w stopce raportów programu Excel.
anonsMLJSON	announcementMLJSON		string	Anonsy w formacie JSON dla witryny.
templateType (typ szablonu)	templateType		integer	Typ szablonu używanego dla witryny.
templateLicence	templateLicence		integer	Typ licencji szablonu witryny.
openChannelAppID	openChannelAppID		string	Identyfikator aplikacji na potrzeby integracji z otwartym kanałem.
itemid	itemid		integer	Identyfikator elementu skojarzonego z witryną.
sitemetadatasheetid	sitemetadatasheetid		integer	Identyfikator arkusza metadanych skojarzonego z witryną.
moja witryna	mysite		boolean	Wskazuje, czy jest to witryna osobista użytkownika.
lastaccesseddate	lastaccesseddate		string	Data i godzina ostatniego uzyskania dostępu do witryny.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Domyślna karta metadanych przeglądarki witryn.
documentMetadataViewId	documentMetadataViewId		integer	metadane dokumentu dla identyfikatora widoku.
folderMetadataViewId	folderMetadataViewId		integer	metadane folderu dla identyfikatora widoku.
docSort	docSort		integer	Kolejność sortowania dokumentów.
folderSort	folderSort		integer	Kolejność sortowania folderów.
defaultFolderRenderView	defaultFolderRenderView		integer	Określa domyślny tryb wyświetlania folderów.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Domyślna lokalizacja załączników zadań.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Unikatowy identyfikator folderu wyznaczonego jako domyślna lokalizacja załączników zadań.
faworyt	favourite		string	status ulubionego.
enabledocumentredaction	enabledocumentredaction		boolean	Określa, czy dla witryny włączono redaction dokumentu.
grupy wzmianek	mentiongroups		integer	Wymienione grupy.
enablefilerelationships	enablefilerelationships		boolean	Wskazuje, czy relacje plików są włączone.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Poziom uprawnień wymagany do zarządzania relacjami plików.

Zwraca

Body: site

Pobieranie informacji o pliku

Identyfikator operacji:: getDocumentInfo

To wywołanie interfejsu API pobiera szczegółowe informacje dotyczące określonego pliku z platformy HighQ Collaborate.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	Określa wersję używanego interfejsu API.
Identyfikator pliku	fileid	True	string	Określa unikatowy identyfikator pliku.
Flaga informacji o najnowszej wersji usługi DMS	lastdmsinfo		boolean	Wskazuje, czy pobrać najnowsze informacje z systemu zarządzania dokumentami.
Typ folderu	foldertype		string	Określa typ folderu, jeśli ma to zastosowanie.
Uwzględnij informacje o stanie pliku	statusinfo		boolean	Wskazuje, czy należy uwzględnić dodatkowe informacje o stanie pliku, takie jak stan udostępniony, stan ulubionego, liczba zadań i stan polubienia. Wartość domyślna to fałsz.
Dołączanie metadanych wiadomości e-mail	emailmetadata		boolean	Wskazuje, czy należy uwzględnić metadane wiadomości e-mail, takie jak nadawca, adresaci i znaczniki czasu. Wartość domyślna to fałsz.

Zwraca

Body: DocumentDBO

Pobieranie kolumn iSheet

Identyfikator operacji:: getIsheetColumns

To wywołanie interfejsu API pobiera kolumny skojarzone z określonym arkuszem iSheet. Ta funkcja jest obsługiwana w interfejsie API w wersji 3 lub nowszej.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator arkusza iSheet	isheetid	True	integer	Określa unikatowy identyfikator arkusza iSheet, dla którego kolumny są wymagane.
Wersja interfejsu API	version	True	string	Określa wersję używanego interfejsu API.
Identyfikator widoku arkusza iSheet	sheetviewid		string	Określa identyfikator widoku iSheet. W przypadku pominięcia zwracane są wszystkie kolumny.
Uwzględnij usunięte kolumny iSheet	onlyForDeletedIsheet		boolean	Wskazuje, czy należy uwzględnić kolumny z usuniętego arkusza iSheet. Wartość domyślna to fałsz.

Zwraca

Body: columns

Pobieranie listy elementów iSheet

Identyfikator operacji:: getISheetItems

To wywołanie interfejsu API pobiera listę elementów zawartych w określonym arkuszu iSheet.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	Określa wersję używanego interfejsu API.
Identyfikator arkusza iSheet	isheetid	True	integer	Określa unikatowy identyfikator arkusza iSheet.
Identyfikator widoku arkusza iSheet	sheetviewid		integer	Określa identyfikator widoku iSheet. W przypadku pominięcia zostanie zwrócony widok domyślny.
Sortuj identyfikator kolumny	sortcolumnid		integer	Określa identyfikator kolumny używanej do sortowania wyników.
Kolejność sortowania	sortorder		integer	Określa kolejność sortowania. Na przykład użyj wartości 0 dla kolejności rosnącej lub innej wartości dla kolejności malejącej.
Limit rekordów	limit		integer	Określa maksymalną liczbę rekordów do zwrócenia; wartość domyślna to 100, jeśli nie zostanie określona.
Przesunięcie rekordu	offset		integer	Określa pozycję początkową pobierania rekordu; wartość domyślna to 0, jeśli nie zostanie określona.
Uwzględnij wszystkie kolumny	allColumnRequired		boolean	Flaga wskazująca, czy uwzględnić wszystkie dane kolumn niezależnie od bieżącego widoku.
Ignoruj ograniczenia widoku	isIgnoreView		boolean	Flaga wskazująca, czy ignorować ograniczenia wyświetlania podczas pobierania danych elementu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
isheet	isheet	array of object	Lista elementów iSheet.
identyfikator przedmiotu	isheet.itemId	string	Unikatowy identyfikator elementu.
dane	isheet.data	array of object	Szczegółowe dane elementu.
sekwencja	isheet.data.sequence	string	Numer sekwencji skojarzony z danymi.
columnDisplayName	isheet.data.columnDisplayName	string	Nazwa wyświetlana kolumny.
value	isheet.data.value	string	Wartość zawarta w kolumnie.

Pobieranie listy folderów

Identyfikator operacji:: getFolderList

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	Określa wersję używanego interfejsu API.
Identyfikator folderu	folderid	True	string	Określa unikatowy identyfikator folderu.
Limit elementów	limit		string	Określa maksymalną liczbę elementów do zwrócenia.
Przesunięcie elementów	offset		string	Określa pozycję początkową zwracanych elementów.
Kierunek sortowania	orderby		string	Określa kierunek kolejności sortowania elementów. Użyj "asc" dla kolejności rosnącej lub "desc" dla kolejności malejącej.
Kryterium sortowania	ordertype		string	Określa kryterium sortowania elementów, takich jak nazwa, autor lub data ostatniej modyfikacji.
Uwzględnij informacje o stanie folderu	statusinfo		boolean	Wskazuje, czy należy uwzględnić dodatkowe informacje o stanie folderu. Wartość domyślna to fałsz.
Dołączanie folderów inteligentnych	includesmartfolder		boolean	Wskazuje, czy mają być uwzględniane foldery inteligentne na zwracanej liście. Wartość domyślna to fałsz.

Zwraca

Nazwa	Ścieżka	Typ	Opis
folder	folder	array of object
items	folder	object

Pobieranie listy użytkowników

Identyfikator operacji:: getAllSystemUsers

Pobierz listę użytkowników Ten interfejs API pobiera listę użytkowników z systemu. ## Kluczowe funkcje — pobieranie szczegółów użytkownika z wieloma opcjami filtrowania — obsługuje stronicowanie przy `limit` użyciu parametrów i `offset` — Nowe parametry zapytania i pola wprowadzone w ostatnich wersjach — odpowiedź ze strukturą z rolami użytkownika i atrybutami ## Nowe parametry zapytania (Version-Specific) — Wprowadzone w wersji 12: - `systemAdminSearch`W przypadku ustawienia na `1`wartość , zwraca tylko użytkowników z rolą Administratora systemu. - Wprowadzone w wersji 18: - : `userid`akceptuje wartości rozdzielane przecinkami (CSV). ## Aktualizacje treści odpowiedzi — dodano nowe pola: — `emaildomain`, `orginvitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcode`, `publicprofiledateOfBirth`## Zmiana formatu adresu (z wersji 11) — `location` nazwa tagu została zmieniona na `address` w celu zapewnienia spójności. - Przykładowa odpowiedź: `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## Role użytkownika (wprowadzone w interfejsie API W wersji 11+) — przykładowa odpowiedź: `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Limity i przesunięcia — Zachowanie limitu: — ustawienie domyślne: `100` jeśli nie podano żadnej wartości. — Służy `-1` do zwracania wszystkich rekordów. - Jeśli wartość jest mniejsza niż `-1`, wartość domyślna to `100`. - Zachowanie przesunięcia: — ustawienie domyślne: `0` jeśli nie podano żadnej wartości. — Jeśli przesunięcie przekracza łączną liczbę rekordów, domyślnie przywraca wartość .`0` ## Wprowadzono nowe role — wersja 12: , `Basic UserAllow user to bypass XSS protection` - : `Allow user to manage Contract Express system groups`## Kody błędów | Podsumowanie | Kod ref (przed V4) | Kod odwołania (wersja 4) | |---------|----------------------|--------------| | Nieprawidłowe dane wejściowe stanu użytkownika (AKTYWNE, ZARCHIWIZOWANE, NIEAKTYWNE) | 147 | 147 | | Identyfikator organizacji jest nieprawidłowy | Nie dotyczy | 260 | | Nieprawidłowa `neverinvited` wartość (prawda/fałsz) | Nie dotyczy | 387 | | Nieprawidłowa `neverlogin` wartość (prawda/fałsz) | Nie dotyczy | 388 | | Nieprawidłowa `groupids` wartość | Nie dotyczy | 214 | | Nieprawidłowa `notingroup` wartość (prawda/fałsz) | Nie dotyczy | 389 | | Nieprawidłowe `ordertype` (obsługiwane: nazwa, organizacja, stan itp.) | Nie dotyczy | 289 | | Nieprawidłowe `orderby` (obsługiwane: asc, desc) | Nie dotyczy | 290 | | Nieprawidłowa `offset` wartość | 138 | 138 | Nieprawidłowa `limit` wartość | 137 | 137 | ## Uwagi — od wersji 13 nowszej ten interfejs API jest otwarty dla wszystkich użytkowników (wcześniej ograniczony do administratorów systemu). — Od wersji 18 do przodu pole wskazuje, `userregistered2FA` czy użytkownik zarejestrował się do 2FA. --- Ten opis jest zgodny z formatowaniem schematu programu Swagger 2.0 i powinien zostać umieszczony w polu opisu w schemacie łącznika niestandardowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	Wersja interfejsu API.
Stan użytkownika	status		string	Filtruj użytkowników według stanu: Aktywne, Zarchiwizowane, Nieaktywne lub Zablokowane.
Przesunięcie stronicowania	offset		string	Pozycja początkowa dla stronicowania.
Limit wyników	limit		string	Liczba elementów do zwrócenia na żądanie.
Identyfikator organizacji	orgid		string	Filtruj użytkowników według identyfikatora organizacji.
Nigdy nie zapraszani użytkownicy	neverinvited		string	Pobierz użytkowników, którzy nigdy nie zostali zaproszeni.
Nigdy nie zalogowano użytkowników	neverlogin		string	Pobierz użytkowników, którzy nigdy nie zalogowali się.
Identyfikator użytkownika	userid		string	Filtruj użytkowników według unikatowych identyfikatorów użytkowników.
Identyfikator grupy	groupid		string	Filtruj użytkowników według identyfikatorów grup.
Użytkownicy, którzy nie znajdują się w grupach	notingroup		string	Pobierz użytkowników, którzy nie należą do żadnej grupy.
Typ kolejności sortowania	ordertype		string	Sortuj użytkowników według określonego pola, takiego jak nazwa, organizacja lub stan.
Kolejność sortowania	orderby		string	Sortowanie wyników w kolejności rosnącej lub malejącej.
Tożsamość zewnętrzna	externalid		string	Filtruj użytkowników według identyfikatora zewnętrznego.
Imię	firstname		string	Filtruj użytkowników według imienia.
Nazwisko	lastname		string	Filtruj użytkowników według nazwiska.
Adres e-mail	email		string	Filtruj użytkowników według adresu e-mail.
Wyszukiwanie użytkowników	search		string	Wyszukaj użytkowników według różnych atrybutów, takich jak nazwa, adres e-mail i stanowisko.
Filtr alfabetu	alphabets		string	Filtruj użytkowników, których nazwisko zaczyna się od określonej litery.
Stanowisko	jobtitle		string	Filtruj użytkowników według stanowiska.
Lokalizacja	locations		string	Filtruj użytkowników według miasta.
Dział	departments		string	Filtruj użytkowników według działu.
Nazwa organizacji	organisations		string	Filtruj użytkowników według nazwy organizacji.
Specjały	specialities		string	Filtruj użytkowników według swoich produktów.
Wyszukiwanie administratorów systemu	systemAdminSearch		string	Pobieranie użytkowników z rolą administratora systemu.

Zwraca

Body: users

Przekazywanie pliku

Identyfikator operacji:: insertDocument

To wywołanie interfejsu API przekazuje plik do określonego folderu na platformie HighQ Collaborate. Obsługuje fragmentowane przekazywanie po podaniu nagłówka Content-Range.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	Określa wersję używanego interfejsu API.
Plik do przekazania	file	True	file	Określa plik do przekazania.
Identyfikator folderu nadrzędnego	parentfolderid	True	string	Określa unikatowy identyfikator folderu nadrzędnego, w którym zostanie przekazany plik.
Zastąpij zduplikowaną flagę	overrideduplicate		boolean	Wskazuje, czy należy przesłonić zduplikowane przekazywanie plików.
Nazwa dokumentu	filename	True	string	Określa nazwę dokumentu.
Uwaga dotycząca wersji	versionnote		string	Zawiera notatkę opisującą wersję pliku.
Klucz operacji progresywnej	progressiveoperkey		string	Określa klucz używany do wykonywania operacji progresywnych podczas przekazywania pliku.
Nazwa bazy danych usługi DMS	dmsdatabasename		string	Określa nazwę bazy danych systemu zarządzania dokumentami.
Data edycji usługi DMS	dmseditdate		string	Określa datę edycji zarejestrowaną w systemie zarządzania dokumentami.
Identyfikator folderu nadrzędnego usługi DMS	dmsparentfolderid		string	Określa unikatowy identyfikator folderu nadrzędnego w systemie zarządzania dokumentami.
Identyfikator dokumentu usługi DMS	dmsdocid		string	Określa unikatowy identyfikator dokumentu w systemie zarządzania dokumentami.
Wersja dokumentu usługi DMS	dmsversion		string	Określa wersję dokumentu zarejestrowanego w systemie zarządzania dokumentami.
Szczegóły powiadomienia	notification		string	Zawiera szczegółowe informacje dotyczące wszelkich powiadomień, które mają być wysyłane podczas przekazywania pliku.
Identyfikator partii	batchid		string	Określa unikatowy identyfikator operacji wsadowej.
Identyfikator folderu głównego	rootfolderid		string	Określa unikatowy identyfikator folderu głównego.

Przenoszenie dokumentów

Identyfikator operacji:: moveDocuments

Ten interfejs API przenosi wiele plików z jednego folderu do innego w tej samej witrynie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	Określa wersję interfejsu API.
Identyfikator folderu docelowego	targetfolder	True	string	Unikatowy identyfikator folderu docelowego, w którym zostaną przeniesione pliki.
fileidCSV	fileidCSV		string	Rozdzielona przecinkami lista identyfikatorów plików do przeniesienia.

Tworzenie folderu

Identyfikator operacji:: addFolder

Ten interfejs API tworzy nowy folder w określonej witrynie. Umożliwia podanie szczegółów folderu i zapewnienie, że folder zostanie utworzony w ramach danego folderu nadrzędnego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	Określa wersję interfejsu API.
Identyfikator partii	batchid		string	Unikatowy identyfikator operacji wsadowej.
Identyfikator folderu głównego	rootfolderid		string	Unikatowy identyfikator folderu głównego.
Identyfikator folderu nadrzędnego	parentfolderid	True	string	Unikatowy identyfikator folderu nadrzędnego, w którym zostanie utworzony nowy folder.
Zezwalaj na zduplikowany folder	allowduplicatefolder		boolean	Wskazuje, czy zduplikowane foldery są dozwolone w określonym folderze nadrzędnym.
nazwa	name	True	string	Nazwa folderu.
opis	description		string	Opis folderu.
accessInherited	accessInherited		integer	Wskazuje, czy dostęp do folderu jest dziedziczony.
batchID	batchID		string	Identyfikator partii dla operacji.
dmsfolderid	dmsfolderid		string	Identyfikator folderu DMS.
dmsParentFolderID	dmsParentFolderID		string	Identyfikator folderu nadrzędnego usługi DMS.
dmscreateddate	dmscreateddate		date-time	Data utworzenia folderu DMS.
dmsmodifiedBy	dmsmodifiedBy		string	Użytkownik, który ostatnio zmodyfikował folder DMS.
dmsdatabasename	dmsdatabasename		string	Nazwa bazy danych DMS.
dmslink	dmslink		boolean	Wskazuje, czy jest dostępny link DMS.
dmslinkby	dmslinkby		string	Użytkownik, który połączył folder DMS.
emailmetadata	emailmetadata		string	Metadane wiadomości e-mail skojarzone z folderem.

Zwraca

Body: FolderDBOV1

Uzyskiwanie informacji o folderze

Identyfikator operacji:: getFolderInfo

Metoda zawiera szczegóły folderu o podanym identyfikatorze folderu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Wersja interfejsu API	version	True	string	wersja interfejsu API
Identyfikator folderu	folderid	True	string	folderID
Informacje o stanie	statusinfo		boolean	Parametr statusinfo umożliwia dostęp do dodatkowych informacji o folderze. Dostępne informacje obejmują stan udostępniony, ulubiony stan dla zalogowanego użytkownika

Zwraca

Body: FolderDBOV2

Definicje

ErrorDBO

Nazwa	Ścieżka	Typ
podsumowanie	summary	string
ref	ref	string
łącze	link	string

DocumentDBO

Nazwa	Ścieżka	Typ	Opis
docid	docid	string	Identyfikator dokumentu.

columns

Nazwa	Ścieżka	Typ	Opis
kolumna	column	array of object
items	column	object

LokalizacjaDBO

Nazwa	Ścieżka	Typ	Opis
addressline1	addressline1	string	Pierwszy wiersz adresu.
addressline2	addressline2	string	Drugi wiersz adresu.
addressline3	addressline3	string	Trzeci wiersz adresu.
city	city	string	Miasto, w którym znajduje się adres.
stan	state	string	Stan adresu.
country	country	string	Kraj adresu.
Kodów pocztowych	postcode	string	Kod pocztowy adresu.

Nazwa użytkownika

Nazwa	Ścieżka	Typ	Opis
title	title	string	Tytuł użytkownika.
imię	firstname	string	Imię użytkownika.
nazwisko	lastname	string	Nazwisko użytkownika.
goesby	goesby	string	preferowana nazwa użytkownika.

MetadataListDBO

Nazwa	Ścieżka	Typ	Opis
nazwa metadanych	metadataname	array of string
metadatavalue	metadatavalue	array of string

NameValueLink

Nazwa	Ścieżka	Typ	Opis
id	id	string	Identyfikator łącza
nazwa	name	string	Nazwa łącza.
value	value	string	Wartość łącza.

Link

Nazwa	Ścieżka	Typ	Opis
łącze	link	array of NameValueLink

ŚrodowiskoDBO

Nazwa	Ścieżka	Typ	Opis
środowisko	experience	array of string

GroupsDBO

Nazwa	Ścieżka	Typ	Opis
grupa	group	array of string

użytkownik

Nazwa	Ścieżka	Typ	Opis
userid	userid	integer	Identyfikator użytkownika.
następujący	following	boolean	Następujący.
e-mail	email	string	Adres e-mail.
nazwa	name	UserName
userlink	userlink	string	Link użytkownika.
httplink	httplink	string	Łącze HTTP.
httpavatar	httpavatar	string	Awatar HTTP.
awatar	avatar	integer	Awatar użytkownika.
externalid	externalid	string	Identyfikator zewnętrzny.
dateofbirth	dateofbirth	string	Data urodzenia.
phone	phone	string	Numer.
jobtitle	jobtitle	string	Stanowisko.
mobilne	mobile	string	Numer telefonu komórkowego.
departament	department	string	Deparmentacja.
stan	status	string	Stan.
organizacja	org	string	Organizacja.
nazwa organizacji	orgName	string	Nazwa organizacji.
lokalizacja	location	LocationDBO
img	img	string	Obraz.
Doświadczenia	experiences	ExperiencesDBO
linki społecznościowe	sociallinks	Link
link niestandardowy	customlink	Link
messaginglink	messaginglink	Link
sekretarzname	secretaryname	string	Nazwisko sekretarza.
sekretarzmail	secretarymail	string	Sekretarz Poczty.
bio	bio	string	Biografia użytkownika.
typ źródła	sourcetype	string	Typ źródła.
Specjały	specialities	string	Specjały.
reportsto	reportsto	string	Użytkownik raportów bieżącego użytkownika.
metadane	metadata	MetadataListDBO
groups	groups	GroupsDBO
przyrostek	suffix	string	Sufiks nazwy użytkownika.
atomlink	atomlink	string	Link Atom skojarzony z użytkownikiem.
łącze	link	string	Łącze skojarzone z użytkownikiem.
loguserlike	loggeduserlike	integer	Liczba polubień od zalogowanego użytkownika.
userName	userName	string	Nazwa użytkownika.

users

Nazwa	Ścieżka	Typ	Opis
użytkownik	user	array of user

FolderDBOV1

Nazwa	Ścieżka	Typ	Opis
folderid	folderid	string	Unikatowy identyfikator utworzonego folderu.

DmsDBO

Nazwa	Ścieżka	Typ	Opis
dmsfolderid	dmsfolderid	string	Identyfikator folderu DMS.
dmsParentFolderID	dmsParentFolderID	string	Identyfikator folderu nadrzędnego usługi DMS.
dmscreateddate	dmscreateddate	date-time	Data utworzenia folderu DMS.
dmsmodifiedBy	dmsmodifiedBy	string	Użytkownik, który ostatnio zmodyfikował folder DMS.
dmsdatabasename	dmsdatabasename	string	Nazwa bazy danych DMS.
dmslink	dmslink	boolean	Wskazuje, czy jest dostępny link DMS.
dmslinkby	dmslinkby	string	Użytkownik, który połączył folder DMS.

grupa witryn

Nazwa	Ścieżka	Typ
nazwa	name	string
id	id	integer
copypermissionsfrom	copypermissionsfrom	string
komunikat	message	string
typeID	typeID	integer
typ	type	string
numberofusers	numberofusers	string
utworzone	created	string
modified	modified	string
systemGroupID	systemGroupID	integer
opis	description	string
basicusergroup	basicusergroup	integer

Address

Nazwa	Ścieżka	Typ	Opis
addressid	addressid	string	Unikatowy identyfikator adresu.
addressline1	addressline1	string	Pierwszy wiersz adresu.
addressline2	addressline2	string	Drugi wiersz adresu.
addressline3	addressline3	string	Trzeci wiersz adresu.
city	city	string	Miasto, w którym znajduje się adres.
stan	state	string	Stan adresu.
country	country	string	Kraj adresu.
Kodów pocztowych	postCode	string	Kod pocztowy adresu.
znane	knownas	string	Alternatywna nazwa lub pseudonim adresu.

IntegrationUserDBO

Nazwa	Ścieżka	Typ	Opis
indeks	index	integer	Unikatowy indeks dla użytkownika.
userid	userid	integer	Unikatowy identyfikator użytkownika.
imię	firstname	string	Imię użytkownika.
nazwisko	lastname	string	Nazwisko użytkownika.
grupa robocza	practicegroup	string	Grupa praktyk, do którego należy użytkownik.
langcode	langcode	string	Kod języka użytkownika.
identyfikator ustawień regionalnych	localeID	string	Identyfikator ustawień regionalnych użytkownika.
publicprofile	publicprofile	string	Profil publiczny użytkownika.
pwpid	pwpid	string	Identyfikator programu PWP użytkownika.
usertypeid	usertypeid	string	Identyfikator typu użytkownika.
systemuser	systemuser	string	Flaga użytkownika systemu.
e-mail	email	string	Email adres użytkownika.
phone	phone	string	Numer telefonu użytkownika.
mobilne	mobile	string	Numer telefonu komórkowego użytkownika.
departament	department	string	Dział użytkownika.
organizacja	org	string	Organizacja, do którego należy użytkownik.
lokalizacja	location	LocationDBO
address	address	Address
Doświadczenia	experiences	ExperiencesDBO
linki społecznościowe	sociallinks	Link
messaginglink	messaginglink	Link
link niestandardowy	customlink	Link
img	img	string
reportsto	reportsto	string
metadane	metadata	MetadataListDBO
groups	groups	GroupsDBO
externalid	externalid	string	Identyfikator zewnętrzny użytkownika.
jobtitle	jobtitle	string	Stanowisko użytkownika.
sekretarzname	secretaryname	string	Nazwa sekretarza użytkownika.
sekretarzmail	secretarymail	string	Adres e-mail sekretarza użytkownika.
Specjały	specialities	string	Kolekcje użytkownika.
title	title	string	Tytuł użytkownika.
goesby	goesby	string	preferowana nazwa użytkownika.
przyrostek	suffix	string	Sufiks nazwy użytkownika.
atomlink	atomlink	string	Link Atom skojarzony z użytkownikiem.
bio	bio	string	Biografia użytkownika.
dateOfBirth	dateOfBirth	string	Data urodzenia użytkownika.
łącze	link	string	Łącze skojarzone z użytkownikiem.
stan	status	string	Stan użytkownika.
statuscode	statuscode	string	Kod stanu użytkownika.
komunikat	message	string	Komunikat skojarzony z użytkownikiem.
typ źródła	sourcetype	string	Typ źródła użytkownika.
identyfikator orgid	orgid	string	Identyfikator organizacji.
ifpartner	ifpartner	string	Flaga partnera.
emaildomain	emaildomain	string	Domena poczty e-mail użytkownika.
zaproszenie	invitationsent	string	Flaga wysłanego zaproszenia.
utworzone przez	createdby	string	Użytkownik, który utworzył rekord.
data utworzenia	createddate	string	Data utworzenia rekordu.
zmodyfikowany przez	modifiedby	string	Użytkownik, który zmodyfikował rekord.
data modyfikacji	modifieddate	string	Data modyfikacji rekordu.
lastlogindate	lastlogindate	string	Data ostatniego logowania.
invalidlogins	invalidlogins	string	Liczba nieprawidłowych prób logowania.
publicwebsiteprofileid	publicwebsiteprofileid	string	Identyfikator profilu publicznej witryny internetowej.
resetpassworddate	resetpassworddate	string	Data zresetowania hasła.
awatar	avatar	string	Adres URL obrazu awatara.
następujące konto	followingcount	integer	Liczba obserwowanych użytkowników.
liczba obserwowanych	followercount	integer	Liczba obserwujących.
następujący	following	boolean	Następująca flaga.
rola	role	string	Rola użytkownika.
isbasicuser	isbasicuser	string	Flaga użytkownika podstawowego.
encryptedUserId	encryptedUserId	string	Zaszyfrowany identyfikator użytkownika.
selfregistered	selfregistered	integer	Flaga zarejestrowana samodzielnie.
registeredWith2FA	registeredWith2FA	string	Flaga rejestracji uwierzytelniania dwuskładnikowego.
isInternal (Wewnętrzny)	isInternal	integer	Wewnętrzna flaga użytkownika.
nazwa organizacji	orgName	string	Nazwa organizacji.

witryna

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Identyfikator witryny.
nazwa witryny	sitename	string	Nazwa witryny.
rola	role	string	Rola witryny.
opis witryny	sitedescription	string	Opis witryny.
enabledmodules	enabledmodules	string	Lista modułów z włączoną obsługą witryny.
sitefolderID	sitefolderID	string	Identyfikator folderu witryny.
sitefolderpermission	sitefolderpermission	string	Poziom uprawnień dla folderu witryny.
moduł	module	ModuleDBO
adminnote	adminnote	string	Uwagi administracyjne związane z witryną.
data rozpoczęcia	startdate	string	Data rozpoczęcia operacji lokacji.
enddate	enddate	string	Data zakończenia operacji lokacji.
data utworzenia	createddate	string	Data utworzenia witryny.
archiveddate	archiveddate	string	Data archiwizacji witryny.
clientno	clientno	string	Numer klienta skojarzony z lokacją.
matterno	matterno	string	Numer sprawy skojarzony z witryną.
strona docelowa	landingpage	string	Adres URL strony docelowej witryny.
łącze	link	string	Link powiązany z witryną.
stan	status	string	Bieżący stan witryny.
statusid	statusid	integer	Identyfikator stanu witryny.
size	size	string	Rozmiar witryny.
przypisy rozliczeniowe	billingnotes	string	Uwagi związane z rozliczeniami dla witryny.
billingnextinvoicedate	billingnextinvoicedate	string	Data następnej faktury dla witryny.
billinglastinvoicedate	billinglastinvoicedate	string	Data ostatniej faktury dla witryny.
filepagecount	filepagecount	string	Łączna liczba stron plików w witrynie.
maxpagecount	maxpagecount	string	Maksymalna dozwolona liczba stron dla plików w witrynie.
sitehttplink	sitehttplink	string	Link HTTP do witryny.
isSyncable	isSyncable	integer	Wskazuje, czy lokacja jest synchronizowana.
enforceusergroups	enforceusergroups	string	Grupy użytkowników wymuszane dla witryny.
csvSiteCategory	csvSiteCategory	string	Kategoria witryny w formacie CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage	string	Nazwa witryny w języku domyślnym.
widoczny	visible	integer	Wskazuje, czy witryna jest widoczna.
siteLogoName	siteLogoName	string	Nazwa pliku logo witryny.
siteLogoFileSize	siteLogoFileSize	integer	Rozmiar pliku logo witryny.
siteLogoHeight	siteLogoHeight	integer	Wysokość logo witryny.
siteLogoWidth	siteLogoWidth	integer	Szerokość logo witryny.
siteStatus	siteStatus	integer	Kod stanu witryny.
applySiteTerms	applySiteTerms	integer	Wskazuje, czy są stosowane terminy witryny.
siteTerm	siteTerm	string	Warunki stosowane do witryny.
termType	termType	integer	Typ terminów zastosowanych do witryny.
nextLoginSiteTerms	nextLoginSiteTerms	integer	Wskazuje, czy warunki witryny są wymagane podczas następnego logowania.
defaultSiteTermsEnable	defaultSiteTermsEnable	integer	Wskazuje, czy są włączone domyślne terminy witryny.
advancedQAPermission	advancedQAPermission	integer	Zaawansowany poziom uprawnień kontroli jakości dla witryny.
isInternal (Wewnętrzny)	isInternal	integer	Wskazuje, czy lokacja jest wewnętrzna.
Psm	psm	integer	Identyfikator menedżera usług produktu.
siteLabelDisplay	siteLabelDisplay	string	Etykieta wyświetlana witryny.
allowSiteAdministration	allowSiteAdministration	integer	Wskazuje, czy administrowanie witryną jest dozwolone.
siteLevelPasswordEnable	siteLevelPasswordEnable	integer	Aby włączyć ochronę haseł na poziomie lokacji.
siteLevelPasscodeEnable	siteLevelPasscodeEnable	integer	Aby włączyć ochronę kodu dostępu na poziomie lokacji.
kod dostępuUsingAuthApp	passcodeUsingAuthApp	integer	Wskazuje, czy uwierzytelnianie kodu dostępu używa aplikacji uwierzytelniania.
sitePassword	sitePassword	string	Hasło skojarzone z witryną.
ipRestrictionEnable	ipRestrictionEnable	integer	Aby włączyć ograniczenia adresów IP dla dostępu do witryny.
availableIP	availableIP	string	Rozdzielona przecinkami lista adresów IP, które mogą uzyskiwać dostęp do witryny.
highqDrive	highqDrive	integer	Wskazuje, czy włączono integrację dysku HighQ.
applySiteHomePage	applySiteHomePage	integer	Aby zastosować niestandardową stronę główną witryny.
siteHomePage	siteHomePage	string	Adres URL niestandardowej strony głównej witryny.
siteHomePageType	siteHomePageType	integer	Typ strony głównej.
nextLoginSiteHomePage	nextLoginSiteHomePage	integer	Aby ustawić następne logowanie do strony głównej witryny.
applyDisplayContent	applyDisplayContent	integer	Aby zastosować ustawienia zawartości wyświetlania.
displayContent	displayContent	string	Zawartość do wyświetlenia w witrynie.
rssSecurity	rssSecurity	integer	Poziom zabezpieczeń kanału informacyjnego RSS.
zaszyfrowane hasło	encryptedPassword	integer	Wskazuje, czy hasło witryny jest szyfrowane.
availableIPRangeCSV	availableIPRangeCSV	string	Rozdzielona przecinkami lista zakresów adresów IP, które mogą uzyskiwać dostęp do witryny.
siteModuleID	siteModuleID	integer	Identyfikator modułu lokacji.
icalSecurity	icalSecurity	integer	Poziom zabezpieczeń kanału informacyjnego iCal.
defaultDisplayContent	defaultDisplayContent	string	Domyślna zawartość do wyświetlenia w witrynie.
defaultEmailAlert	defaultEmailAlert	integer	Aby włączyć domyślne alerty e-mail.
excelReportFooter	excelReportFooter	integer	Zawiera stopkę w raportach programu Excel.
excelReportFooterText	excelReportFooterText	string	Tekst do wyświetlenia w stopce raportów programu Excel.
anonsMLJSON	announcementMLJSON	string	Anonsy w formacie JSON dla witryny.
templateType (typ szablonu)	templateType	integer	Typ szablonu używanego dla witryny.
templateLicence	templateLicence	integer	Typ licencji szablonu witryny.
openChannelAppID	openChannelAppID	string	Identyfikator aplikacji na potrzeby integracji z otwartym kanałem.
itemid	itemid	integer	Identyfikator elementu skojarzonego z witryną.
sitemetadatasheetid	sitemetadatasheetid	integer	Identyfikator arkusza metadanych skojarzonego z witryną.
moja witryna	mysite	boolean	Wskazuje, czy jest to witryna osobista użytkownika.
lastaccesseddate	lastaccesseddate	string	Data i godzina ostatniego uzyskania dostępu do witryny.
defaultViewerMetaDataTab	defaultViewerMetaDataTab	integer	Domyślna karta metadanych przeglądarki witryn.
documentMetadataViewId	documentMetadataViewId	integer	metadane dokumentu dla identyfikatora widoku.
folderMetadataViewId	folderMetadataViewId	integer	metadane folderu dla identyfikatora widoku.
docSort	docSort	integer	Kolejność sortowania dokumentów.
folderSort	folderSort	integer	Kolejność sortowania folderów.
defaultFolderRenderView	defaultFolderRenderView	integer	Określa domyślny tryb wyświetlania folderów.
isTaskAttachmentDefault	isTaskAttachmentDefault	integer	Domyślna lokalizacja załączników zadań.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	Unikatowy identyfikator folderu wyznaczonego jako domyślna lokalizacja załączników zadań.
faworyt	favourite	string	status ulubionego.
enabledocumentredaction	enabledocumentredaction	boolean	Określa, czy dla witryny włączono redaction dokumentu.
grupy wzmianek	mentiongroups	integer	Wymienione grupy.
enablefilerelationships	enablefilerelationships	boolean	Wskazuje, czy relacje plików są włączone.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel	integer	Poziom uprawnień wymagany do zarządzania relacjami plików.

ModuleDBO

Nazwa	Ścieżka	Typ
dom	home	HomeDBO
działanie	activity	ActivityDBO
dokument	document	DocumentDBO
blog	blog	BlogDBO
wiki	wiki	WikiDBO
zadanie	task	TaskDBO
wydarzenie	event	EventDBO
isheet	isheet	ISheetDBO
Qa	qa	QaDBO
lud	people	PeopleDBO
contractexpress	contractexpress	ContractExpressDBO

HomeDBO

Nazwa	Ścieżka	Typ	Opis
włączyć	enable	string	Włącz stan homeDBO.

ActivityDBO

Nazwa	Ścieżka	Typ	Opis
włączyć	enable	string	Włącz stan activityDBO.
mikroblog	microblog	string	Zawartość mikroblogu skojarzona z elementem ActivityDBO.

BlogDBO

Nazwa	Ścieżka	Typ	Opis
blogTitle	blogTitle	string	Tytuł wpisu w blogu.
blogContent	blogContent	string	Zawartość wpisu w blogu.
showComment	showComment	integer	pokaż komentarz.
Lista tagów	tagList	array of string	Lista tagów skojarzonych z blogiem.
stan	status	integer	stan wpisu w blogu.
identyfikator witryny	siteID	integer	Identyfikator skojarzonej witryny.
autor	author	string	Autor bloga.
categoryList	categoryList	array of string	Kategorie przypisane do wpisu w blogu.
notificationTypeID	notificationTypeID	integer	Identyfikator typu powiadomienia.
komunikat	message	string	Zawartość wiadomości powiązana z blogem.
messageCode	messageCode	integer	Kod skojarzony z komunikatem.
zewnętrzny ID	externalID	string	Identyfikator zewnętrzny połączony z blogem.
data publikacji	publishDate	string	Data publikacji blogu.
typ procesu	processtype	string	Typ procesu skojarzony z blogiem.
włączyć	enable	string	Włącz stan blogDBO.

WikiDBO

Nazwa	Ścieżka	Typ	Opis
wikiid	wikiid	integer	Unikatowy identyfikator witryny typu wiki.
currentversionid	currentversionid	integer	Identyfikator bieżącej wersji witryny typu wiki
parentwikiid	parentwikiid	integer	Identyfikator nadrzędnej witryny typu wiki.
wikititle	wikititle	string	Tytuł strony typu wiki.
wikicontent	wikicontent	string	Zawartość witryny typu wiki.
showcomment	showcomment	integer	Wskazuje, czy komentarze są włączone.
data utworzenia	createddate	string	Data utworzenia witryny typu wiki.
data modyfikacji	modifieddate	string	Data ostatniej modyfikacji witryny typu wiki.
lista tagów	taglist	string	Rozdzielona przecinkami lista tagów skojarzonych ze witryną typu wiki.
wikipath	wikipath	string	Ścieżka dostępu do witryny typu wiki.
wikidraftid	wikidraftid	integer	Identyfikator wersji roboczej witryny typu wiki.
typ wersji roboczej	drafttype	string	Typ wersji roboczej skojarzonej z witryną typu wiki.
stan	status	integer	Bieżący stan strony typu wiki.
wikiversionid	wikiversionid	integer	Identyfikator wersji witryny typu wiki.

TaskDBO

Nazwa	Ścieżka	Typ	Opis
indeks	index	string	Indeks lub identyfikator zadania.
parenttaskid	parenttaskid	integer	Identyfikator zadania nadrzędnego.
identyfikator zadania	taskid	integer	Unikatowy identyfikator zadania.
title	title	string	Tytuł zadania.
opis	description	string	Szczegółowy opis zadania.
data ukończenia	duedate	string	Data ukończenia zadania.
data rozpoczęcia	startdate	string	Data rozpoczęcia, kiedy zadanie zostało zainicjowane.
mattermaptaskid	mattermaptaskid	string	Identyfikator łączący się z zadaniem mapy materii.
typ	type	string	Wpisz lub kategorię zadania.
zależny	dependenton	string	Zadania, od których zależy to zadanie.
daysfromdependent	daysfromdependent	string	Liczba dni od zadania zależnego.
ignoreweekend	ignoreweekend	integer	Wskazuje, czy weekendy są ignorowane w harmonogramie.
duration	duration	integer	Czas trwania zadania.
zasób	resource	string	Zasoby przydzielone do zadania.

EventDBO

Nazwa	Ścieżka	Typ	Opis
eventTitle	eventTitle	string	Tytuł wydarzenia.
eventContent	eventContent	string	Zawartość zdarzenia.
showComment	showComment	integer	Wskazuje, czy komentarze są włączone dla zdarzenia.
Lista tagów	tagList	array of string	Lista tagów skojarzonych ze zdarzeniem.
stan	status	integer	Bieżący stan zdarzenia.
identyfikator witryny	siteID	integer	Identyfikator witryny.
kontakt	contact	string	Informacje kontaktowe dotyczące zdarzenia.
categoryList	categoryList	array of string	Kategorie, w których jest wyświetlane zdarzenie.
notificationTypeID	notificationTypeID	integer	Typ powiadomienia związany ze zdarzeniem.
komunikat	message	string	Komunikat zdarzenia.
messageCode	messageCode	integer	Kod komunikatu zdarzenia.
zewnętrzny ID	externalID	string	Identyfikator zewnętrzny.
startDate	startDate	string	Data rozpoczęcia zdarzenia.
data zakończenia	endDate	string	Data zakończenia wydarzenia.
startTime	startTime	string	Godzina rozpoczęcia zdarzenia.
endTime	endTime	string	Godzina zakończenia zdarzenia.
lokalizacja	location	string	Lokalizacja zdarzenia.
autor	author	string	Autor wydarzenia.
typ procesu	processtype	string	Czas procesu zdarzenia.
włączyć	enable	string	Włącz zdarzenie.

ISheetDBO

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Unikatowy identyfikator arkusza iSheet.
title	title	string	Tytuł arkusza iSheet.
opis	description	string	Opis arkusza isheet.
stan	status	string	Stan arkusza isheet.
typ dostępu	accesstype	string	Typ dostępu arkusza isheet.
typ	type	string	Typ arkusza isheet.
viewlink	viewlink	string	Połącz, aby wyświetlić arkusz iSheet.
allowsections	allowsections	string	Czy sekcje są dozwolone.
allowlookup	allowlookup	string	Określa, czy pola odnośników są włączone.
displayisheet	displayisheet	string	Opcje wyświetlania dla arkusza iSheet.
searchasdefaultview	searchasdefaultview	string	Wskazuje, czy wyszukiwanie jest widokiem domyślnym.
enableversion	enableversion	string	Flaga z włączoną obsługą wersji.
enablesheetalerter	enablesheetalerter	string	Flaga umożliwiająca włączenie alertów arkusza.
alertercondition	alertercondition	string	Warunki wyzwalania alertów.
overrideitemmodifieddate	overrideitemmodifieddate	string	Zastąpij flagę daty modyfikacji.
enablebulkinsertupdate	enablebulkinsertupdate	string	Włącz wstawianie/aktualizowanie zbiorcze.
opisy pól	fielddescriptions	string	Opisy pól dla arkusza iSheet.
enablerowlocking	enablerowlocking	string	Włącz blokowanie na poziomie wiersza.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	Obcinanie wielowierszowej flagi tekstowej.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	Limit znaków dla obcinania wielowierszowego.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse	string	Zezwalaj na ponowne użycie wartości listy wyboru.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	Zezwalaj na ponowne użycie wartości listy wyników.
allowIsheetComments	allowIsheetComments	string	Zezwalaj na komentarze w usłudze iSheet.
shareRecordsLimit	shareRecordsLimit	integer	Limit rekordów, które mogą być udostępniane.
shareRecordsLimitEnabled	shareRecordsLimitEnabled	integer	Włączony limit udziału rekordów.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	Włącz udostępnianie formularzy na potrzeby dodawania rekordów.
recordcount	recordcount	string	Bieżąca liczba rekordów.
sheettypeid	sheettypeid	integer	Identyfikator typu arkusza iSheet

QaDBO

Nazwa	Ścieżka	Typ	Opis
włączyć	enable	string	Włącz funkcję QA.

PeopleDBO

Nazwa	Ścieżka	Typ	Opis
osoba	person	array of PersonDBO

PersonDBO

Nazwa	Ścieżka	Typ	Opis
userid	userid	integer	Identyfikator użytkownika.
e-mail	email	string	adres e-mail.
httpavatar	httpavatar	string	Adres URL HTTP awatara.
awatar	avatar	string	Obraz awatara.
userlink	userlink	string	Połącz z profilem użytkownika.
httplink	httplink	string	Link HTTP do profilu użytkownika.
phone	phone	string	Numer.
mobilne	mobile	string	Numer telefonu komórkowego.
departament	department	string	Dział użytkownika.

ContractExpressDBO

Nazwa	Ścieżka	Typ	Opis
włączyć	enable	string	Włącz integrację kontraktu Express.

FolderDBOV2

Nazwa	Ścieżka	Typ	Opis
nazwa	name	string	Nazwa folderu.
opis	description	string	Opis folderu.
parentFolderID	parentFolderID	integer	Identyfikator folderu nadrzędnego.
accessInherited	accessInherited	integer	Uzyskaj dostęp do stanu dziedziczenia.
batchID	batchID	string	Identyfikator partii
DMS	dms	DmsDBO
id	id	integer	Identyfikator folderu.
łącze	link	string	Łącze folderu.
data utworzenia	createddate	string	Data utworzenia.
data modyfikacji	modifieddate	string	Data modyfikacji.
element podrzędny	child	integer	Foldery podrzędne.
filecount	filecount	integer	Liczba plików.
utworzone przez	createdby	UserDBO
zmodyfikowany przez	modifiedby	UserDBO
folderid	folderid	integer	Identyfikator folderu.
dmsfolderid	dmsfolderid	string	Identyfikator folderu DMS.
siteid	siteid	integer	Identyfikator lokalizacji
lokalizacja	location	string	Lokalizacja folderu.
uprawnienie	permission	PermissionDBO
contentstatus	contentstatus	integer	Stan zawartości.
autonumerowanie	autonumbering	string	Konfiguracja automatycznego numerowania.
foldersize	foldersize	string	Rozmiar folderu.
sharedstatus	sharedstatus	integer	Stan udostępniania.
favoritestatus	favouritestatus	integer	Status ulubionego.
typ folderu	foldertype	string	Typ folderu.
identyfikator przedmiotu	itemId	integer	Identyfikator elementu.
folderMetadataSheetId	folderMetadataSheetId	integer	Metadane folderu identyfikatora arkusza.

UserDBO

Nazwa	Ścieżka	Typ	Opis
imię	firstname	string	Imię.
nazwisko	lastname	string	Nazwisko.
e-mail	email	string	Adres e-mail.
userid	userid	integer	Identyfikator użytkownika.

PermissionDBO

Nazwa	Ścieżka	Typ	Opis
widok	view	integer	Wyświetl uprawnienie.
edycja	edit	integer	Edytuj uprawnienie.
usunąć	delete	integer	Usuń uprawnienie.
addEditAllFiles	addEditAllFiles	integer	Dodaj/edytuj uprawnienie do wszystkich plików.
administrator	admin	integer	Uprawnienia administratora.
viewAllFiles	viewAllFiles	integer	Wyświetl wszystkie pliki Uprawnienie.
disableZapisz	disableSave	integer	wyłącz uprawnienie zapisywania.
uploadFile	uploadFile	integer	przekaż plik Uprawnienie.
updateFile	updateFile	integer	uprawnienie do aktualizacji pliku.
deleteFile	deleteFile	integer	Usuń uprawnienie do pliku.

ProgressiveKeyDBO

Nazwa	Ścieżka	Typ	Opis
progressivekey	progressivekey	string	Klucz do wykonywania operacji progresywnych.
siteid	siteid	integer	Identyfikator witryny.
progressivekeystatus	progressivekeystatus	string	Stan klucza progresywnego.
userid	userid	integer	Identyfikator użytkownika.
treść odpowiedzi	responsebody	string	Treść odpowiedzi.
komunikat	message	string	Zawartość komunikatu.
kod komunikatu	messagecode	string	Kod skojarzony z komunikatem.
integrationResponseDBO	integrationResponseDBO	IntegrationResponseDBO
columns	columns	ColumnErrorsDBO
items	items	ItemErrorsDBO
importisheettemplate	importisheettemplate	importISheetTemplateDBO
błąd	error	ErrorDBO
typ treści	contentType	string	Typ zawartości.
failedEntities	failedEntities	integer	Liczba jednostek zakończonych niepowodzeniem.
downloadlink	downloadlink	string	Łącze do pobierania zawartości.
załącznik	attachment	Attachment
łącze	link	string	Skojarzony link.
documentid	documentid	integer	Identyfikator dokumentu.
progresskey	progresskey	string	Klucz postępu do śledzenia.
progresskeystatus	progresskeystatus	string	Stan klucza postępu.

IntegrationResponseDBO

Nazwa	Ścieżka	Typ	Opis
integrationResponseUserseObject	integrationResponseUsersObject	IntegrationResponseUsersObject
failedEntities	failedEntities	integer	Liczba jednostek, które zakończyły się niepowodzeniem przetwarzania.
successEntities	successEntities	integer	Liczba jednostek, które zostały pomyślnie przetworzone.

IntegrationResponseUsersObject

Nazwa	Ścieżka	Typ	Opis
użytkownik	user	array of IntegrationUserDBO

ColumnErrorsDBO

Nazwa	Ścieżka	Typ	Opis
kolumna	column	array of ColumnErrorDBO
failedEntities	failedEntities	integer	Liczba jednostek, które nie powiodły się z powodu błędów kolumn.
successEntities	successEntities	integer	Liczba jednostek, które zostały pomyślnie przetworzone.

ColumnErrorDBO

Nazwa	Ścieżka	Typ	Opis
indeks	index	integer	Pozycja indeksu kolumny z błędem.
columnid	columnid	integer	Unikatowy identyfikator kolumny z błędem.
nazwa	name	string	Nazwa kolumny z błędem.
stan	status	string	Stan wskazujący warunek błędu.
statuscode	statuscode	string	Kod reprezentujący stan błędu.
komunikat	message	string	Szczegółowy komunikat o błędzie.

ItemErrorsDBO

Nazwa	Ścieżka	Typ	Opis
element	item	array of ItemErrorDBO
failedEntities	failedEntities	integer	Liczba jednostek, które nie powiodły się z powodu błędów elementu.
successEntities	successEntities	integer	Liczba jednostek, które zostały pomyślnie przetworzone pomimo błędów elementów.

ItemErrorDBO

Nazwa	Ścieżka	Typ	Opis
indeks	index	integer	Pozycja indeksu elementu z błędem.
columns	columns	ColumnErrorsDBO
itemid	itemid	string	Unikatowy identyfikator elementu z błędem.
externalid	externalid	string	Identyfikator zewnętrzny skojarzony z elementem.
id	id	string	Wewnętrzny identyfikator elementu.
nazwa	name	string	Nazwa elementu z błędem.
stan	status	string	Stan wskazujący warunek błędu.
statuscode	statuscode	string	Kod reprezentujący stan błędu.
komunikat	message	string	Szczegółowy komunikat o błędzie.
successdeletedcount	successdeletedcount	integer	Liczba pomyślnie usuniętych jednostek.
liczba niepowodzeń	failurecount	integer	Liczba jednostek, które zakończyły się niepowodzeniem przetwarzania.
failedEntities	failedEntities	integer	Liczba jednostek, które nie powiodły się z powodu błędów elementu.
successEntities	successEntities	integer	Liczba jednostek, które zostały pomyślnie przetworzone.

importISheetTemplateDBO

Nazwa	Ścieżka	Typ	Opis
linkedtemplateid	linkedtemplateid	integer	Identyfikator połączonego szablonu.
aliasname	aliasname	string	Nazwa aliasu szablonu.
linkedisheet	linkedisheet	string	Identyfikator połączonego arkusza danych wejściowych.
importdata	importdata	string	Dane do zaimportowania z szablonu.
appendisheetname	appendisheetname	string	Nazwa arkusza, do których mają być dołączane dane.
templateparametergroups	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
Identyfikator szablonu	templateId	integer	Identyfikator szablonu.
templateTitle	templateTitle	string	Tytuł szablonu.
identyfikatory widoków	viewIDs	string	Rozdzielona przecinkami lista identyfikatorów widoków.

ISheetTemplateParameterGroups

Nazwa	Ścieżka	Typ	Opis
templateparametergroup	templateparametergroup	array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Nazwa	Ścieżka	Typ	Opis
templateruleid	templateruleid	integer	Grupa parametrów szablonu Isheet.
templateparameter	templateparameter	array of ISheetTemplateParameter

ISheetTemplateParameter

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Identyfikator parametru szablonu isheet.
nazwa	name	string	Nazwa parametru szablonu isheet.
dane	data	string	dane parametru szablonu isheet.

Attachment

Nazwa	Ścieżka	Typ	Opis
plik	file	string	Zawartość pliku.
nazwa	name	string	Nazwa załącznika.
porządek	order	string	Kolejność załącznika.
id	id	integer	Unikatowy identyfikator załącznika.
rozszerzenie	extension	string	Formatem.
parentfolderid	parentfolderid	integer	Identyfikator folderu nadrzędnego.
filehttplink	filehttplink	string	Link HTTP w celu uzyskania dostępu do pliku.
ścieżka folderu	folderpath	string	Ścieżka do folderu zawierającego plik.
folderhttplink	folderhttplink	string	Link HTTP do folderu.
filesize	filesize	integer	Rozmiar pliku w bajtach.
redactionStatus	redactionStatus	boolean	Wskazuje, czy plik został zredagowany.
displayname	displayname	string	Nazwa wyświetlana załącznika.
siteid	siteid	integer	Identyfikator witryny skojarzonej z załącznikiem.

Udostępnij przez

HighQ (wersja zapoznawcza)

HighQ

Przegląd

Authentication

Operacje łącznika

Moduł ISheet

Interfejsy API zasobów dokumentów

Interfejs API administratora ISheet

Operacje użytkownika

Zarządzanie dokumentami i lokacjami

Wprowadzenie

Parametry i ustawienia

Rozwiązywanie problemów i ograniczenia

Dodatkowe zasoby

Licencjonowanie i pomoc techniczna

Limity ograniczania

Akcje

Aby utworzyć element iSheet

Parametry

Zwraca

Aktualizowanie grupy witryn

Parametry

Zwraca

Aktualizowanie witryny

Parametry

Archiwizowanie użytkownika

Parametry

Dodaj użytkownika

Parametry

Zwraca

Dodawanie istniejącej grupy do witryny

Parametry

Zwraca

Dodawanie witryny

Parametry

Zwraca

Pobieranie informacji o pliku

Parametry

Zwraca

Pobieranie kolumn iSheet

Parametry

Zwraca

Pobieranie listy elementów iSheet

Parametry

Zwraca

Pobieranie listy folderów

Parametry

Zwraca

Pobieranie listy użytkowników

Parametry

Zwraca

Przekazywanie pliku

Parametry

Przenoszenie dokumentów

Parametry

Tworzenie folderu

Parametry

Zwraca

Uzyskiwanie informacji o folderze

Parametry

Zwraca

Definicje

ErrorDBO

DocumentDBO

columns

LokalizacjaDBO

Nazwa użytkownika

MetadataListDBO

NameValueLink

Link

ŚrodowiskoDBO

GroupsDBO

użytkownik

users

FolderDBOV1

DmsDBO

grupa witryn

Address

IntegrationUserDBO