IManage Work
Łącznik iManage Work umożliwia użytkownikom automatyzowanie powtarzających się zadań i procesów zatwierdzania, jednocześnie zachowując bezpieczeństwo wszystkich plików w środowisku iManage Work.
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 - narzędzie do automatyzacji procesów | 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 | iManage LLC |
| adres URL | https://docs.imanage.com |
| cloudsupport@imanage.com |
| Metadane łącznika | |
|---|---|
| Publisher | IManage Power Platform Connector |
| Witryna internetowa | https://imanage.com |
| Zasady ochrony prywatności | https://imanage.com/about/privacy-notice/ |
| Kategorie | Zawartość i pliki; Produktywność |
IManage Work
iManage jest wiodącym w branży dostawcą rozwiązań do zarządzania dokumentami i pocztą e-mail dla pracowników wiedzy. Platforma iManage organizuje i zabezpiecza informacje w dokumentach i wiadomościach e-mail, dzięki czemu specjaliści mogą wyszukiwać potrzebne elementy, podejmować na nich działania i efektywniej współpracować. Łącznik iManage Work umożliwia użytkownikom automatyzowanie powtarzających się zadań i procesów zatwierdzania, jednocześnie zachowując bezpieczeństwo wszystkich plików w środowisku iManage Work.
Wymagania wstępne
Łącznik jest dostępny dla wszystkich klientów iManage Work łączących się z cloudimanage.com. Najpierw aplikacja Power Automate musi być włączona przez administratora środowiska iManage Work. Po włączeniu będzie potrzebny określony adres URL środowiska oraz konto logowania i hasło, w ramach którego łącznik może wykonywać akcje. Aby uzyskać więcej informacji, zobacz często zadawane pytania.
Jak uzyskać poświadczenia
Jeśli jesteś istniejącym użytkownikiem aplikacji iManage Work, podaj poświadczenia aplikacji iManage Work, aby się zalogować. W przeciwnym razie skontaktuj się z administratorem systemu, aby uzyskać pomoc.
Wprowadzenie do łącznika iManage Work
Wykonaj następujące kroki, aby rozpocząć pracę z łącznikiem iManage Work:
- Utwórz przepływ natychmiastowej chmury i wybierz pozycję + Nowy krok.
- Wyszukaj pozycję iManage Work , aby wyświetlić wszystkie dostępne akcje iManage Work.
- Wybierz żądaną akcję iManage Work.
- Jeśli jeszcze nie zalogowano się do aplikacji iManage Work, zostanie wyświetlony monit o zalogowanie.
- Wybierz Zaloguj.
- Wprowadź adres URL używany do nawiązywania połączenia z programem iManage Work, na przykład cloudimanage.com.
- Wprowadź identyfikator użytkownika służbowego iManage.
- Wprowadź hasło wybranego konta i wybierz pozycję Zaloguj. Od tego momentu wszystkie przepływy korzystające z akcji iManage Work łączą się przy użyciu tych poświadczeń użytkownika. Możesz użyć innego konta użytkownika iManage, dodając nowe połączenie w obszarze Moje połączenia i przełączając się do niego.
Znane problemy i ograniczenia
Aby uzyskać listę znanych problemów i ograniczeń, odwiedź stronę https://docs.imanage.com/power-automate/index.html.
Typowe błędy i środki zaradcze
Aby uzyskać listę typowych błędów i środków zaradczych, odwiedź stronę https://docs.imanage.com/power-automate/index.html.
Często zadawane pytania
Aby uzyskać listę często zadawanych pytań, odwiedź stronę https://docs.imanage.com/power-automate/index.html.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie bieżącej lub tworzenie nowej wersji dokumentu |
Aktualizuje określoną wersję dokumentu lub tworzy nową wersję. Ta akcja może zaktualizować profil i zawartość dokumentu. Jeśli zostanie określona opcja "Aktualizuj bieżącą wersję", dokument zostanie zastąpiony nowym, a profil poprzedniego dokumentu zostanie zachowany. Jeśli zostanie określona wartość "Utwórz nową wersję", zostanie utworzona nowa wersja dokumentu, która dziedziczy profil folderu. Po pomyślnym wykonaniu operacji zwracany jest profil dokumentu. |
| Aktualizowanie domyślnych zabezpieczeń |
Aktualizuje domyślne zabezpieczenia dokumentu, folderu lub obszaru roboczego. |
| Aktualizowanie obszaru roboczego |
Aktualizuje informacje o określonym obszarze roboczym. Aby usunąć istniejącą wartość pola ciągu, ustaw wartość pola na pusty ciąg owinięty w cudzysłów pojedynczych lub podwójnych. |
| Aktualizowanie profilu dokumentu |
Wykonuje aktualizacje w profilu dokumentu. Dokument nie może być używany podczas aktualizowania profilu i nie można zaktualizować profilu dokumentu wyewidencjonowany. Zwraca zaktualizowany profil dokumentu po operacji. |
| Aktualizowanie stanu przepływu pracy |
Aktualizuje stan przebiegu przepływu pracy. Tej akcji można użyć tylko w utworzonym przepływie pracy, aby rozpocząć od wyzwalacza dostarczonego przez funkcję iManage. |
| Aktualizowanie uprawnień |
Aktualizuje uprawnienia obiektu. |
| Dodawanie odwołania do dokumentu |
Dodaje odwołanie do dokumentu lub skrót do dokumentu w innym folderze. |
| Dodawanie wpisu historii dokumentów |
Dodaje wpis jako zdarzenie w historii dokumentu. |
| Edytowanie par nazwa-wartość |
Tworzy, aktualizuje lub usuwa właściwości pary nazwa-wartość dokumentu, folderu lub obszaru roboczego. Aby usunąć parę name-value, ustaw wartość klucza na pusty ciąg owinięty w cudzysłów pojedynczych lub podwójnych. |
| Kopiowanie dokumentu |
Kopiuje dokument do określonego folderu. |
| Pobieranie bibliotek |
Pobiera listę bibliotek, do których użytkownik ma dostęp. |
| Pobieranie członków grupy |
Uzyskaj szczegółowe informacje o użytkownikach należących do określonej grupy i spełniających określone kryteria. |
| Pobieranie dokumentu |
Pobiera wersję określonego dokumentu na podstawie identyfikatora dokumentu. Jeśli najnowsza wersja jest prawdziwa, zostanie pobrana najnowsza wersja tego dokumentu. Pobieranie jest strumieniem i nie jest zapisywane lokalnie. |
| Pobieranie klas |
Pobiera listę klas dokumentów dostępnych w bibliotece zgodnej z określonymi kryteriami. |
| Pobieranie podklas |
Pobiera wszystkie podklasy biblioteki spełniające określone kryteria. |
| Pobieranie podstawowych właściwości rozszerzonych metadanych dokumentu |
Pobiera podstawowe właściwości rozszerzonych metadanych dokumentu. |
| Pobieranie profilu dokumentu |
Pobiera właściwości dokumentu skojarzone z określonym identyfikatorem dokumentu. |
| Pobieranie profilu obszaru roboczego |
Pobiera profil obszaru roboczego i opcjonalnie listę dozwolonych operacji dla obszaru roboczego. |
| Pobieranie szablonów obszarów roboczych |
Pobiera listę szablonów dostępnych w bibliotece. Szablon obszaru roboczego to wstępnie zdefiniowany obszar roboczy, którego struktura jest kopiowana dla nowego obszaru roboczego. |
| Pobieranie szczegółów użytkownika |
Pobiera informacje o użytkowniku z określonej biblioteki. |
| Pobieranie wersji dokumentów |
Pobiera profile dla wszystkich wersji, do których bieżący użytkownik ma dostęp dla określonego dokumentu. |
| Podwyższanie poziomu wersji dokumentu |
Promuje istniejącą wersję dokumentu do najnowszej wersji. Nowa wersja jest tworzona na podstawie określonego identyfikatora dziennika lub wersji, a następnie awansowana do najnowszej wersji. Należy określić identyfikator dziennika lub wersję, ale nie obie. |
| Przekazywanie dokumentu |
Przekazuje plik jako nowy dokument do określonego folderu. |
| Przenoszenie dokumentu |
Przenosi dokument do określonego folderu. |
| Tworzenie obszaru roboczego |
Tworzy nowy obszar roboczy na podstawie wybranego szablonu. Szablon obszaru roboczego to wstępnie zdefiniowany obszar roboczy, którego struktura jest kopiowana do nowego obszaru roboczego. Ograniczenia szablonu obszaru roboczego są wymuszane automatycznie podczas tworzenia nowego obszaru roboczego. |
| Tworzenie relacji dokumentu |
Tworzy relację między określonymi dokumentami w bibliotece. |
| Uprawnienia do kopiowania |
Kopiuje uprawnienia dostępu i opcjonalnie domyślne zabezpieczenia z jednego obiektu iManage Work do innego. Opcja "Kopiuj typ" umożliwia obsługę kombinacji uprawnień źródłowych i docelowych. Polecenie "Zastąp" aktualizuje użytkowników, grupy i poziomy uprawnień obiektu docelowego, aby dokładnie pasować do obiektów źródłowych. Polecenie "Merge" przechowuje wszystkich użytkowników i grupy w obiekcie docelowym i łączy je ze źródłem, ale w przypadku konfliktu poziomu uprawnień dla pojedynczej osoby lub grupy: "Scalanie (pesymistyczne)" przyjmuje mniejsze uprawnienie, podczas gdy "Scalanie (optymistyczne)" przyjmuje wyższe uprawnienie dla sprzecznego użytkownika lub grupy. |
| Ustawianie podstawowych właściwości rozszerzonych metadanych w dokumencie |
Ustawia podstawowe właściwości rozszerzonych metadanych w dokumencie. |
| Usuwanie dokumentu |
Usuwa określony dokument. |
| Usuń odwołanie do dokumentu |
Usuwa odwołanie do dokumentu z określonego folderu. |
| Usuń relację dokumentu |
Usuwa relację między określonymi dokumentami w bibliotece. |
| Uzyskiwanie powierniczych |
Pobiera listę zaufanych z określonymi uprawnieniami dla dokumentu, folderu lub obszaru roboczego. Powiernik może być użytkownikiem lub grupą. |
| Uzyskiwanie uprawnień |
Pobiera właściwości uprawnień dostępu użytkownika lub grupy dokumentu, folderu lub obszaru roboczego. Właściwości odpowiedzi mogą się różnić w zależności od uprawnień użytkownika lub grupy. |
| Wyszukaj podstawowe wartości węzłów taksonomii rozszerzonych metadanych |
Wyszukuje podstawowe wartości taksonomii rozszerzonych metadanych pasujących do określonych kryteriów wyszukiwania. |
| Wyszukiwanie folderów |
Wyszukaj foldery. |
| Wyszukiwanie obszarów roboczych |
Wyszukaj obszary robocze. |
| Wyszukiwanie użytkowników |
Wyszukuje użytkowników aplikacji iManage Work spełniających określone kryteria wyszukiwania. |
Aktualizowanie bieżącej lub tworzenie nowej wersji dokumentu
Aktualizuje określoną wersję dokumentu lub tworzy nową wersję. Ta akcja może zaktualizować profil i zawartość dokumentu. Jeśli zostanie określona opcja "Aktualizuj bieżącą wersję", dokument zostanie zastąpiony nowym, a profil poprzedniego dokumentu zostanie zachowany. Jeśli zostanie określona wartość "Utwórz nową wersję", zostanie utworzona nowa wersja dokumentu, która dziedziczy profil folderu. Po pomyślnym wykonaniu operacji zwracany jest profil dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Aktualizowanie lub tworzenie nowej wersji
|
updateOrCreate | True | string |
Określa, aby zaktualizować bieżącą wersję dokumentu lub utworzyć nową wersję. |
|
Istniejący identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator istniejącego dokumentu. Na przykład "ACTIVE_US!556.1". |
|
Zachowaj blokadę
|
keep_locked | boolean |
Określa, czy blokada dokumentu jest przechowywana po przekazaniu. |
|
|
Comment
|
comment | string |
Określa dodatkowe informacje o aktualizacji. |
|
|
Nazwa dokumentu
|
name | string |
Określa nazwę dokumentu. |
|
|
Author
|
author | string |
Określa identyfikator iManage Work użytkownika, który utworzył dokument. |
|
|
Operator
|
operator | string |
Określa identyfikator użytkownika, który ma wyewidencjonowany dokument lub aktualnie edytuje profil dokumentu. Na przykład "JSMITH". |
|
|
Class
|
class | string |
Określa klasę do identyfikowania i różnicowania dokumentu. Klasa dokumentów jest kategoryzowana według gatunku, działu, regionu itd. |
|
|
Podklasa
|
subclass | string |
Określa podklasę do identyfikowania i różnicowania dokumentu. Podklasa dokumentów jest klasyfikowana według gatunku, działu, regionu itd. |
|
|
Domyślne zabezpieczenia
|
default_security | string |
Określa domyślny poziom dostępu do zabezpieczeń. Możliwe wartości to "inherit", "private", "view", "public". |
|
|
Jest HIPAA
|
is_hipaa | boolean |
Określa, czy dokument ma być zaszyfrowany. |
|
|
Zachowaj dni
|
retain_days | integer |
Określa liczbę dni, przez które dokument musi być nieaktywny przed oznaczeniem go do archiwizacji. |
|
|
Zawartość pliku
|
file | True | file |
Określa zawartość pliku. |
|
Data utworzenia pliku
|
file_create_date | date-time |
Określa datę i godzinę (w formacie ISO 8601), który został utworzony. Plik mógł zostać utworzony poza systemem iManage Work. Ta data może być inna niż "create_date". Create_date to data utworzenia lub zaimportowania pliku przez system iManage Work. |
|
|
Data edycji pliku
|
file_edit_date | date-time |
Określa datę i godzinę (w formacie ISO 8601) najnowszej zmiany pliku. Plik mógł zostać zmieniony przed przekazaniem do systemu iManage Work. |
|
|
Niestandardowy1
|
custom1 | string |
Określa wartość parametru custom1. |
|
|
Niestandardowy 2
|
custom2 | string |
Określa wartość parametru custom2. Aby określić wartość parametru custom2, należy również określić wartość dla parametru custom1 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
|
|
Niestandardowe 3
|
custom3 | string |
Określa wartość parametru custom3. |
|
|
Niestandardowe4
|
custom4 | string |
Określa wartość parametru custom4. |
|
|
Niestandardowy5
|
custom5 | string |
Określa wartość parametru custom5. |
|
|
Niestandardowa 6
|
custom6 | string |
Określa wartość dla parametru custom6. |
|
|
Niestandardowy7
|
custom7 | string |
Określa wartość dla elementu custom7. |
|
|
Niestandardowe8
|
custom8 | string |
Określa wartość dla parametru custom8. |
|
|
Niestandardowa 9
|
custom9 | string |
Określa wartość dla parametru custom9. |
|
|
Niestandardowa 10
|
custom10 | string |
Określa wartość parametru custom10. |
|
|
Niestandardowa 11
|
custom11 | string |
Określa wartość parametru custom11. |
|
|
Niestandardowy 12
|
custom12 | string |
Określa wartość parametru custom12. |
|
|
Niestandardowa 13
|
custom13 | string |
Określa wartość parametru custom13. |
|
|
Niestandardowe 14
|
custom14 | string |
Określa wartość parametru custom14. |
|
|
Niestandardowy 15
|
custom15 | string |
Określa wartość parametru custom15. |
|
|
Niestandardowa 16
|
custom16 | string |
Określa wartość dla elementu custom16. |
|
|
Niestandardowa 17
|
custom17 | double |
Określa wartość parametru custom17. |
|
|
Niestandardowy18
|
custom18 | double |
Określa wartość parametru custom18. |
|
|
Niestandardowa 19
|
custom19 | double |
Określa wartość parametru custom19. |
|
|
Niestandardowe 20
|
custom20 | double |
Określa wartość parametru custom20. |
|
|
Niestandardowy 21
|
custom21 | string |
Określa wartość parametru custom21 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 22
|
custom22 | string |
Określa wartość custom22 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 23
|
custom23 | string |
Określa wartość parametru custom23 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 24
|
custom24 | string |
Określa wartość parametru custom24 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 25
|
custom25 | boolean |
Określa wartość parametru custom25. |
|
|
Niestandardowe 26
|
custom26 | boolean |
Określa wartość parametru custom26. |
|
|
Niestandardowe 27
|
custom27 | boolean |
Określa wartość parametru custom27. |
|
|
Niestandardowe 28
|
custom28 | boolean |
Określa wartość parametru custom28. |
|
|
Niestandardowy 29
|
custom29 | string |
Określa wartość parametru custom29. |
|
|
Niestandardowa 30
|
custom30 | string |
Określa wartość parametru custom30. Aby określić wartość parametru custom30, należy również określić wartość dla parametru custom29 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
Aktualizowanie domyślnych zabezpieczeń
Aktualizuje domyślne zabezpieczenia dokumentu, folderu lub obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ obiektu
|
objectType | True | string |
Określa typ obiektu. |
|
Identyfikator obiektu
|
objectId | True | string |
Określa identyfikator dokumentu, folderu lub obszaru roboczego. Przykładem identyfikatora dokumentu jest "ACTIVE_US!453.1". Przykładem folderu lub identyfikatora obszaru roboczego jest "ACTIVE_US!123". |
|
Domyślne zabezpieczenia
|
default_security | True | string |
Określa domyślne zabezpieczenia obiektu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Domyślne zabezpieczenia
|
data.default_security | string |
Wskazuje domyślne zabezpieczenia obiektu. Możliwe wartości to "dziedzicz", "publiczny", "widok" lub "prywatny". |
|
Uprawnienia dostępu
|
data.acl | AccessPermissions |
Wskazuje kolekcję uprawnień dostępu dla co najmniej jednego użytkownika i/lub grup. |
Aktualizowanie obszaru roboczego
Aktualizuje informacje o określonym obszarze roboczym. Aby usunąć istniejącą wartość pola ciągu, ustaw wartość pola na pusty ciąg owinięty w cudzysłów pojedynczych lub podwójnych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator obszaru roboczego
|
id | True | string |
Określa identyfikator obszaru roboczego do zaktualizowania. Na przykład "ACTIVE_US!427". |
|
Name
|
name | string |
Określa nazwę obszaru roboczego. |
|
|
Właściciel obszaru roboczego
|
owner | string |
Określa właściciela obszaru roboczego. |
|
|
Niestandardowy1
|
custom1 | string |
Określa wartość custom1. |
|
|
Niestandardowy 2
|
custom2 | string |
Określa wartość custom2. Aby określić wartość parametru custom2, należy również określić wartość dla parametru custom1 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
|
|
Niestandardowe 3
|
custom3 | string |
Określa wartość custom3. |
|
|
Niestandardowe4
|
custom4 | string |
Określa wartość custom4. |
|
|
Niestandardowy5
|
custom5 | string |
Określa wartość custom5. |
|
|
Niestandardowa 6
|
custom6 | string |
Określa wartość custom6. |
|
|
Niestandardowy7
|
custom7 | string |
Określa wartość custom7. |
|
|
Niestandardowe8
|
custom8 | string |
Określa wartość custom8. |
|
|
Niestandardowa 9
|
custom9 | string |
Określa wartość custom9. |
|
|
Niestandardowa 10
|
custom10 | string |
Określa wartość custom10. |
|
|
Niestandardowa 11
|
custom11 | string |
Określa wartość custom11. |
|
|
Niestandardowy 12
|
custom12 | string |
Określa wartość custom12. |
|
|
Niestandardowa 13
|
custom13 | string |
Określa wartość custom13. |
|
|
Niestandardowe 14
|
custom14 | string |
Określa wartość custom14. |
|
|
Niestandardowy 15
|
custom15 | string |
Określa wartość custom15. |
|
|
Niestandardowa 16
|
custom16 | string |
Określa wartość custom16. |
|
|
Niestandardowa 17
|
custom17 | double |
Określa wartość custom17. |
|
|
Niestandardowy18
|
custom18 | double |
Określa wartość custom18. |
|
|
Niestandardowa 19
|
custom19 | double |
Określa wartość custom19. |
|
|
Niestandardowe 20
|
custom20 | double |
Określa wartość custom20. |
|
|
Niestandardowy 21
|
custom21 | string |
Określa wartość custom21 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 22
|
custom22 | string |
Określa wartość custom22 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 23
|
custom23 | string |
Określa wartość custom23 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 24
|
custom24 | string |
Określa wartość custom24 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 25
|
custom25 | boolean |
Określa wartość custom25. |
|
|
Niestandardowe 26
|
custom26 | boolean |
Określa wartość custom26. |
|
|
Niestandardowe 27
|
custom27 | boolean |
Określa wartość custom27. |
|
|
Niestandardowe 28
|
custom28 | boolean |
Określa wartość custom28. |
|
|
Niestandardowy 29
|
custom29 | string |
Określa wartość custom29. |
|
|
Niestandardowa 30
|
custom30 | string |
Określa wartość custom30. Aby określić wartość parametru custom30, należy również określić wartość dla parametru custom29 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
|
|
Domyślne zabezpieczenia
|
default_security | string |
Określa domyślny poziom dostępu do zabezpieczeń. |
|
|
Description
|
description | string |
Określa dodatkowe informacje o obszarze roboczym. |
|
|
Jest zewnętrzny w normalny sposób
|
is_external_as_normal | boolean |
Określa, czy obszar roboczy może być traktowany jako publiczny obszar roboczy. Jeśli ustawiono wartość "true", a wartość "default_security" nie jest ustawiona na wartość "private", wartość "is_external" ma wartość "true". |
|
|
Projekt niestandardowy1
|
project_custom1 | string |
Określa dodatkowe informacje o obszarze roboczym. To pole różni się od pola niestandardowego metadanych skojarzonego z elementami zawartości, takimi jak dokumenty, obszary robocze lub foldery. Jest to tekst opisowy, który nie musi być sformatowany i nie jest weryfikowany. |
|
|
Projekt niestandardowy 2
|
project_custom2 | string |
Określa dodatkowe informacje o obszarze roboczym. To pole różni się od pola niestandardowego metadanych skojarzonego z elementami zawartości, takimi jak dokumenty, obszary robocze lub foldery. Jest to tekst opisowy, który nie musi być sformatowany i nie jest weryfikowany. |
|
|
Projekt niestandardowy3
|
project_custom3 | string |
Określa dodatkowe informacje o obszarze roboczym. To pole różni się od pola niestandardowego metadanych skojarzonego z elementami zawartości, takimi jak dokumenty, obszary robocze lub foldery. Jest to tekst opisowy, który nie musi być sformatowany i nie jest weryfikowany. |
|
|
Podklasa obszaru roboczego
|
subclass | string |
Określa podklasę obszaru roboczego na podstawie podklasy dokumentu, który zawiera. |
Aktualizowanie profilu dokumentu
Wykonuje aktualizacje w profilu dokumentu. Dokument nie może być używany podczas aktualizowania profilu i nie można zaktualizować profilu dokumentu wyewidencjonowany. Zwraca zaktualizowany profil dokumentu po operacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pseudonim
|
alias | string |
Określa alias tego dokumentu. |
|
|
Author
|
author | string |
Określa identyfikator użytkownika, który utworzył dokument. Na przykład "JSMITH". |
|
|
Comment
|
comment | string |
Określa dodatkowe informacje o dokumencie. |
|
|
Zabezpieczenia domyślne dokumentu
|
default_security | string |
Określa domyślny poziom dostępu do zabezpieczeń. |
|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Jest zadeklarowany
|
is_declared | boolean |
Określa, czy dokument ma być zadeklarowany jako rekord. Nie można edytować ani usuwać dokumentu zadeklarowanego jako rekord, z wyjątkiem administratora systemu pracy iManage. |
|
|
Jest HIPAA
|
is_hipaa | boolean |
Określa, czy dokument ma być zaszyfrowany. |
|
|
Komentarz inspekcji
|
audit_comment | string |
Określa dodatkowe informacje o aktualizacji profilu dokumentu. |
|
|
Klasa dokumentu
|
class | string |
Określa klasę dokumentu. |
|
|
Nazwa dokumentu
|
name | string |
Określa nazwę pliku dokumentu. |
|
|
Operator
|
operator | string |
Określa identyfikator użytkownika ma wyewidencjonowany dokument lub obecnie edytuje profil dokumentu. Na przykład "JSMITH". |
|
|
Zachowaj dni
|
retain_days | integer |
Określa liczbę dni, po których dokument nieaktywny kwalifikuje się do archiwizacji. |
|
|
Podklasa
|
subclass | string |
Określa podklasę dokumentu. |
|
|
Niestandardowy1
|
custom1 | string |
Określa wartość custom1. |
|
|
Niestandardowy 2
|
custom2 | string |
Określa wartość custom2. Aby określić wartość parametru custom2, należy również określić wartość dla parametru custom1 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
|
|
Niestandardowe 3
|
custom3 | string |
Określa wartość custom3. |
|
|
Niestandardowe4
|
custom4 | string |
Określa wartość custom4. |
|
|
Niestandardowy5
|
custom5 | string |
Określa wartość custom5. |
|
|
Niestandardowa 6
|
custom6 | string |
Określa wartość custom6. |
|
|
Niestandardowy7
|
custom7 | string |
Określa wartość custom7. |
|
|
Niestandardowe8
|
custom8 | string |
Określa wartość custom8. |
|
|
Niestandardowa 9
|
custom9 | string |
Określa wartość custom9. |
|
|
Niestandardowa 10
|
custom10 | string |
Określa wartość custom10. |
|
|
Niestandardowa 11
|
custom11 | string |
Określa wartość custom11. |
|
|
Niestandardowy 12
|
custom12 | string |
Określa wartość custom12. |
|
|
Niestandardowa 13
|
custom13 | string |
Określa wartość custom13. |
|
|
Niestandardowe 14
|
custom14 | string |
Określa wartość custom14. |
|
|
Niestandardowy 15
|
custom15 | string |
Określa wartość custom15. |
|
|
Niestandardowa 16
|
custom16 | string |
Określa wartość custom16. |
|
|
Niestandardowa 17
|
custom17 | double |
Określa wartość custom17. |
|
|
Niestandardowy18
|
custom18 | double |
Określa wartość custom18. |
|
|
Niestandardowa 19
|
custom19 | double |
Określa wartość custom19. |
|
|
Niestandardowe 20
|
custom20 | double |
Określa wartość custom20. |
|
|
Niestandardowy 21
|
custom21 | string |
Określa wartość właściwości custom21 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 22
|
custom22 | string |
Określa wartość właściwości custom22 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 23
|
custom23 | string |
Określa wartość właściwości custom23 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 24
|
custom24 | string |
Określa wartość właściwości custom24 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 25
|
custom25 | boolean |
Określa wartość custom25. |
|
|
Niestandardowe 26
|
custom26 | boolean |
Określa wartość custom26. |
|
|
Niestandardowe 27
|
custom27 | boolean |
Określa wartość custom27. |
|
|
Niestandardowe 28
|
custom28 | boolean |
Określa wartość custom28. |
|
|
Niestandardowy 29
|
custom29 | string |
Określa wartość custom29. |
|
|
Niestandardowa 30
|
custom30 | string |
Określa wartość custom30. Aby określić wartość parametru custom30, należy również określić wartość dla parametru custom29 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
Aktualizowanie stanu przepływu pracy
Aktualizuje stan przebiegu przepływu pracy. Tej akcji można użyć tylko w utworzonym przepływie pracy, aby rozpocząć od wyzwalacza dostarczonego przez funkcję iManage.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki, dla której zdefiniowano przepływ pracy. |
|
State
|
state | True | string |
Określa bieżący stan przebiegu przepływu pracy. |
|
Status
|
status | string |
Określa bieżący stan przebiegu przepływu pracy. Maksymalna długość to 128 znaków. |
|
|
Komunikat o stanie
|
statusMessage | string |
Określa dostosowany komunikat dla bieżącego stanu przebiegu przepływu pracy. Maksymalna długość to 256 znaków. |
Zwraca
- response
- object
Aktualizowanie uprawnień
Aktualizuje uprawnienia obiektu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ obiektu
|
objectType | True | string |
Określa typ obiektu. |
|
Identyfikator obiektu
|
objectId | True | string |
Określa identyfikator dokumentu, folderu lub obszaru roboczego. Przykładem identyfikatora dokumentu jest "ACTIVE_US!453.1". Przykładem folderu lub identyfikatora obszaru roboczego jest "ACTIVE_US!123". |
|
Poziom dostępu
|
access_level | True | string |
Określa poziom dostępu. |
|
Użytkownicy
|
users | string |
Określa co najmniej jednego użytkownika, aby ustawić poziom dostępu oddzielony średnikiem. |
|
|
Groups
|
groups | string |
Określa co najmniej jedną grupę, aby ustawić poziom dostępu oddzielony średnikiem. |
Zwraca
Dodawanie odwołania do dokumentu
Dodaje odwołanie do dokumentu lub skrót do dokumentu w innym folderze.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Identyfikator folderu
|
folderId | True | string |
Określa identyfikator folderu. Na przykład "ACTIVE_US!773". |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator odwołania do dokumentu
|
data.id | string |
Wskazuje odwołanie do dokumentu i document_shortcut. |
|
Wstype
|
data.wstype | string |
Wskazuje typ pracy iManage obiektu. Możliwe wartości to "document", "document_shortcut", "email". |
Dodawanie wpisu historii dokumentów
Dodaje wpis jako zdarzenie w historii dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Activity
|
activity_code | True | integer |
Określa typ działania wykonywanego w dokumencie. |
|
Comments
|
comments | string |
Określa wszelkie dodatkowe informacje o działaniu. |
|
|
Czas trwania
|
duration | integer |
Określa liczbę sekund, przez które użytkownik pracował nad dokumentem. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | object |
Edytowanie par nazwa-wartość
Tworzy, aktualizuje lub usuwa właściwości pary nazwa-wartość dokumentu, folderu lub obszaru roboczego. Aby usunąć parę name-value, ustaw wartość klucza na pusty ciąg owinięty w cudzysłów pojedynczych lub podwójnych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ obiektu
|
objectType | True | string |
Określa typ obiektu. Możliwe wartości to "document", "folder", "workspace". |
|
Identyfikator obiektu
|
objectId | True | string |
Określa identyfikator dokumentu, folderu lub obszaru roboczego. Przykładem identyfikatora dokumentu jest "ACTIVE_US!453.1". Przykładem folderu lub identyfikatora obszaru roboczego jest "ACTIVE_US!123". |
|
Pary nazwa-wartość
|
nameValuePairs | object |
Określa pary nazw i wartości dowolnych dla tego dokumentu. |
Kopiowanie dokumentu
Kopiuje dokument do określonego folderu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Identyfikator folderu docelowego
|
folderId | True | string |
Określa identyfikator folderu docelowego, do którego ma zostać skopiowany dokument. Na przykład "ACTIVE_US!987". |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dostęp do dokumentów
|
data.access | string |
Wskazuje zestaw uprawnień na poziomie dostępu dla dokumentu lub kontenera. Poziom dostępu jest ustawiany przez autora lub użytkownika z pełnym dostępem do elementu. Możliwe wartości to "no_access", "read", "read_write", "full_access". |
|
Pseudonim
|
data.alias | string |
Wskazuje alias tego dokumentu. |
|
Author
|
data.author | string |
Wskazuje identyfikator użytkownika, który utworzył dokument. Na przykład "JSMITH". |
|
Opis autora
|
data.author_description | string |
Wskazuje dodatkowe informacje o autorze dokumentu. |
|
DW
|
data.cc | string |
Wskazuje adresatów, do których jest kopiowana wiadomość e-mail. Dotyczy tylko wiadomości e-mail. |
|
Klasa dokumentu
|
data.class | string |
Wskazuje klasę dokumentu. |
|
Opis klasy dokumentu
|
data.class_description | string |
Wskazuje dodatkowe informacje o klasie dokumentów. |
|
Typ zawartości
|
data.content_type | string |
Wskazuje typ zawartości dokumentu. |
|
Data utworzenia dokumentu
|
data.create_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601), który dokument został zaimportowany do systemu iManage Work. Ta data może być inna niż "file_create_date". |
|
Baza danych
|
data.database | string |
Wskazuje bibliotekę, w której jest przechowywany dokument. |
|
Zabezpieczenia domyślne dokumentu
|
data.default_security | string |
Wskazuje domyślny poziom dostępu do zabezpieczeń. Możliwe wartości to "inherit", "private", "view", "public". |
|
Numer dokumentu
|
data.document_number | integer |
Wskazuje numer dokumentu. |
|
Adres URL dokumentu
|
data.document_url | string |
Wskazuje link do udostępniania dokumentu. |
|
Data edycji dokumentu
|
data.edit_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) najnowszej zmiany dokumentu. |
|
Data edycji profilu
|
data.edit_profile_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) najnowszej zmiany profilu dokumentu. |
|
Rozszerzenie dokumentu
|
data.extension | string |
Wskazuje rozszerzenie nazwy pliku, nazywane również rozszerzeniem aplikacji dokumentu. |
|
Data utworzenia pliku
|
data.file_create_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601), który został utworzony. Plik mógł zostać utworzony poza systemem iManage Work. Ta data może być inna niż "create_date". |
|
Data edycji pliku
|
data.file_edit_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) najnowszej zmiany pliku. Plik mógł zostać zmieniony przed przekazaniem do systemu iManage Work. |
|
Źródło
|
data.from | string |
Wskazuje nadawcę wiadomości e-mail. Dotyczy tylko wiadomości e-mail. |
|
Pełna nazwa pliku
|
data.full_file_name | string |
Wskazuje pełną nazwę pliku dokumentu. Zawiera rozszerzenie nazwy pliku. |
|
Ma załącznik
|
data.has_attachment | boolean |
Wskazuje, czy wiadomość e-mail ma załączniki. Dotyczy tylko wiadomości e-mail. |
|
Podstawowe właściwości dokumentu
|
data.basic_properties | string |
Wskazuje osadzony element "", który zawiera podstawowe właściwości dokumentu. |
|
Identyfikator dokumentu
|
data.id | string |
Wskazuje identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Jest indeksowalny
|
data.indexable | boolean |
Wskazuje, czy dokument jest indeksowany przez system. |
|
Jest wyewidencjonowany
|
data.is_checked_out | boolean |
Wskazuje, czy dokument jest wyewidencjonowany. |
|
Jest zadeklarowany
|
data.is_declared | boolean |
Wskazuje, czy dokument jest zadeklarowany jako rekord. Nie można edytować ani usuwać dokumentu zadeklarowanego jako rekord, z wyjątkiem administratora systemu pracy iManage. |
|
Jest zewnętrzny
|
data.is_external | boolean |
Wskazuje, czy dokument jest udostępniany użytkownikom zewnętrznym. |
|
Jest zewnętrzny w normalny sposób
|
data.is_external_as_normal | boolean |
Wskazuje, czy dokument jest zewnętrzny w normalny sposób. |
|
Jest HIPAA
|
data.is_hipaa | boolean |
Wskazuje, czy dokument jest zaszyfrowany. |
|
Jest w użyciu
|
data.is_in_use | boolean |
Wskazuje, czy dokument jest używany. |
|
Łącze dokumentu
|
data.iwl | string |
Wskazuje link iManage Work Link (iWL) dla dokumentu. Biblioteka iWL służy do otwierania dokumentu w trybie widoku chronionego przez użytkownika, który ma "read_write" lub "full_access". |
|
Ostatni użytkownik
|
data.last_user | string |
Wskazuje identyfikator użytkownika, który ostatnio edytował dokument. Na przykład "JSMITH". |
|
Opis ostatniego użytkownika
|
data.last_user_description | string |
Wskazuje dodatkowe informacje o ostatnim użytkowniku, który ostatnio edytował dokument. |
|
Nazwa dokumentu
|
data.name | string |
Wskazuje nazwę pliku dokumentu. |
|
Operator
|
data.operator | string |
Wskazuje identyfikator użytkownika, który ma wyewidencjonowany dokument lub obecnie edytuje swój profil. Na przykład "JSMITH". |
|
Opis operatora
|
data.operator_description | string |
Wskazuje dodatkowe informacje o operatorze. |
|
Data odebrania
|
data.received_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) odebraną wiadomość e-mail. Dotyczy tylko wiadomości e-mail. |
|
Zachowaj dni
|
data.retain_days | integer |
Wskazuje liczbę dni, po których dokument kwalifikuje się do archiwizacji. Dotyczy tylko nieaktywnych dokumentów. |
|
Data wysłania
|
data.sent_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) wysłano wiadomość e-mail. Dotyczy tylko wiadomości e-mail. |
|
Rozmiar dokumentu
|
data.size | integer |
Wskazuje rozmiar dokumentu w bajtach. |
|
Podklasa
|
data.subclass | string |
Wskazuje podklasę dokumentu. |
|
Opis podklasy
|
data.subclass_description | string |
Wskazuje dodatkowe informacje o podklasie dokumentu. |
|
Do
|
data.to | string |
Wskazuje adresata wiadomości e-mail. Dotyczy tylko wiadomości e-mail. |
|
Typ
|
data.type | string |
Wskazuje typ dokumentu. Na przykład WORD dla programu Microsoft Word. Aby uzyskać bieżącą listę typów, skontaktuj się z administratorem systemu pracy iManage. |
|
Opis typu
|
data.type_description | string |
Wskazuje dodatkowe informacje o typie dokumentu. |
|
Wersja dokumentu
|
data.version | integer |
Wskazuje numer wersji dokumentu. |
|
Identyfikator obszaru roboczego
|
data.workspace_id | string |
Wskazuje identyfikator obszaru roboczego dokumentu. Na przykład "ACTIVE_US!427". |
|
Nazwa obszaru roboczego
|
data.workspace_name | string |
Wskazuje nazwę obszaru roboczego dokumentu. |
|
Wstype
|
data.wstype | string |
Wskazuje typ pracy iManage obiektu. Możliwe wartości to "document", "folder", "workspace", "email", "document_shortcut", "folder_shortcut", "workspace_shortcut", "user". |
|
Niestandardowa 13
|
data.custom13 | string |
Wskazuje wartość parametru custom13. |
|
Niestandardowe 14
|
data.custom14 | string |
Wskazuje wartość custom14. |
|
Niestandardowy 15
|
data.custom15 | string |
Wskazuje wartość custom15. |
|
Niestandardowa 16
|
data.custom16 | string |
Wskazuje wartość custom16. |
|
Niestandardowy 21
|
data.custom21 | string |
Wskazuje wartość właściwości custom21 w formacie daty/godziny ISO 8601. |
|
Niestandardowe 22
|
data.custom22 | string |
Wskazuje wartość właściwości custom22 w formacie daty/godziny ISO 8601. |
Pobieranie bibliotek
Pobiera listę bibliotek, do których użytkownik ma dostęp.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of object |
Wskazuje listę bibliotek, do których użytkownik ma dostęp. |
|
identyfikator
|
data.id | string |
Wskazuje nazwę biblioteki. |
|
Name
|
data.display_name | string |
Wskazuje nazwę wyświetlaną biblioteki. |
|
Typ
|
data.type | string |
Wskazuje typ biblioteki. Możliwe wartości to "worksite" lub "linksite". |
|
Jest ukryty
|
data.is_hidden | boolean |
Wskazuje, czy biblioteka jest ukryta. |
Pobieranie członków grupy
Uzyskaj szczegółowe informacje o użytkownikach należących do określonej grupy i spełniających określone kryteria.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki grupy docelowej. |
|
Identyfikator grupy
|
groupId | True | string |
Określa identyfikator grupy. Na przykład "MARKETING". |
|
Stan logowania
|
logon_status | string |
Określa filtr dla użytkowników na podstawie bieżącej wartości właściwości "allow_logon" dla każdego użytkownika. |
|
|
Ograniczenie
|
limit | integer |
Określa maksymalną liczbę elementów członkowskich do zwrócenia niezależnie od całkowitej liczby członków w grupie. |
|
|
Preferowana biblioteka
|
preferred_library | string |
Określa, że zwracana jest tylko użytkownicy, których preferowana biblioteka jest zgodna z podaną wartością. |
|
|
Lokalizacja
|
location | string |
Określa lokalizację, która ma być używana do znajdowania użytkowników na podstawie ich lokalizacji geograficznej. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) nie jest obsługiwany. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of UserProfileInArray |
Wskazuje listę użytkowników należących do określonej grupy i spełniających określone kryteria. |
Pobieranie dokumentu
Pobiera wersję określonego dokumentu na podstawie identyfikatora dokumentu. Jeśli najnowsza wersja jest prawdziwa, zostanie pobrana najnowsza wersja tego dokumentu. Pobieranie jest strumieniem i nie jest zapisywane lokalnie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_USE!453.1". |
|
Pobierz najnowszą wersję
|
latest | boolean |
Określa, aby pobrać najnowszą wersję dokumentu. |
Zwraca
Wskazuje zawartość pliku.
- Zawartość pliku
- binary
Pobieranie klas
Pobiera listę klas dokumentów dostępnych w bibliotece zgodnej z określonymi kryteriami.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki klasy docelowej. |
|
Identyfikator klasy
|
alias | string |
Określa identyfikator klasy lub klas do wyszukania. Może być listą rozdzielaną przecinkami. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania są obsługiwane. |
|
|
Domyślne zabezpieczenia
|
default_security | string |
Określa domyślny poziom dostępu do zabezpieczeń. |
|
|
Description
|
description | string |
Określa tekst, który ma być zgodny w polu opisu. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) jest obsługiwany. Częściowe dopasowania nie są obsługiwane. |
|
|
Echo
|
echo | boolean |
Określa, czy dokumenty tej klasy mogą powtarzać dokumenty. |
|
|
HIPAA
|
hipaa | boolean |
Określa, czy dokumenty tej klasy używają zgodnego szyfrowania HIPAA. |
|
|
Indeksowalny
|
indexable | boolean |
Określa, czy dokumenty tej klasy są indeksowane przez indeksator pełnotekstowy systemu. |
|
|
Query
|
query | string |
Określa tekst zgodny z polami identyfikatora lub opisu. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania są obsługiwane. |
|
|
Wymagana podklasa
|
subclass_required | boolean |
Określa, czy klasa ma wymaganą podklasę. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Najwyższy identyfikator pasującej klasy
|
data.topMatchingId | string |
Wskazuje identyfikator najwyższej pasującej klasy. Na przykład "PETYCJA". |
|
Opis najwyższej klasy dopasowania
|
data.topMatchingDescription | string |
Wskazuje opis najwyższej pasującej klasy. |
|
results
|
data.results | array of object |
Wskazuje listę klas dostępnych w bibliotece zgodnej z określonymi kryteriami. |
|
Description
|
data.results.description | string |
Wskazuje dodatkowe informacje o klasie. |
|
Jest HIPAA
|
data.results.hipaa | boolean |
Wskazuje, czy dokument jest zaszyfrowany. |
|
identyfikator
|
data.results.id | string |
Wskazuje identyfikator klasy. Na przykład "PETYCJA". |
|
Jest indeksowalny
|
data.results.indexable | boolean |
Wskazuje, czy dokument jest indeksowany przez system. |
|
Domyślne zabezpieczenia
|
data.results.default_security | string |
Wskazuje domyślny poziom dostępu do zabezpieczeń. Możliwe wartości to "public", "view", "private". |
|
Retain
|
data.results.retain | integer |
Wskazuje liczbę dni przed oznaczeniem nieaktywnych dokumentów tej klasy jako wygasłych. |
|
Wymagane pola
|
data.results.required_fields | array of string |
Wskazuje obowiązkowe właściwości niestandardowe, które mają zostać wprowadzone podczas tworzenia lub aktualizowania dokumentu tej klasy. |
|
Jest w tle
|
data.results.shadow | boolean |
Wskazuje, czy dokument tej klasy jest w tle (zachowywany) na komputerze lokalnym użytkownika po zaewidencjonowaniu go. |
|
Czy wymagana jest podklasa
|
data.results.subclass_required | boolean |
Wskazuje, czy dla tej klasy jest wymagana podklasa. |
Pobieranie podklas
Pobiera wszystkie podklasy biblioteki spełniające określone kryteria.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki docelowej podklasy. |
|
Identyfikator klasy
|
classId | True | string |
Określa identyfikator klasy, która jest elementem nadrzędnym tej podklasy. Na przykład "PETYCJA". |
|
Identyfikator podklasy
|
alias | string |
Określa identyfikator podklas do wyszukania. Może być listą rozdzielaną przecinkami. Symbol wieloznaczny (*) jest obsługiwany. Częściowe dopasowania są obsługiwane, gdy jest używany znak wieloznaczny. |
|
|
Domyślne zabezpieczenia
|
default_security | string |
Określa domyślny poziom dostępu do zabezpieczeń. |
|
|
Description
|
description | string |
Określa tekst, który ma być zgodny w polu opisu. Symbol wieloznaczny (*) jest obsługiwany. Częściowe dopasowania są obsługiwane, gdy jest używany znak wieloznaczny. |
|
|
Echo
|
echo | boolean |
Określa, czy podklasy mogą być echo do lokalnego dysku twardego użytkownika. Ułatwia to pracę w trybie offline. |
|
|
HIPAA
|
hipaa | boolean |
Określa, czy mają być zwracane zgodne podklasy HIPAA. |
|
|
Query
|
query | string |
Określa tekst zgodny z polami Identyfikator lub Opis podklasy. Symbol wieloznaczny (*) jest obsługiwany. Częściowe dopasowania są obsługiwane. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator głównej pasującej podklasy
|
data.topMatchingId | string |
Wskazuje identyfikator górnej pasującej podklasy. |
|
Opis głównej pasującej podklasy
|
data.topMatchingDescription | string |
Wskazuje opis najwyższej pasującej podklasy. |
|
results
|
data.results | array of object | |
|
Domyślne zabezpieczenia
|
data.results.default_security | string |
Wskazuje domyślny poziom dostępu do zabezpieczeń. Możliwe wartości to "public", "view", "private". |
|
Description
|
data.results.description | string |
Wskazuje dodatkowe informacje o podklasie. Maksymalna długość to 255 znaków. |
|
Jest HIPAA
|
data.results.hipaa | boolean |
Wskazuje, czy dokument jest zaszyfrowany. |
|
identyfikator
|
data.results.id | string |
Wskazuje identyfikator podklasy używanej do tworzenia lub modyfikowania informacji o profilu dokumentu. Na przykład "GUARDIANSHIP". |
|
Identyfikator nadrzędny
|
data.results.parent.id | string |
Wskazuje identyfikator klasy nadrzędnej podklasy. |
|
Wymagane pola
|
data.results.required_fields | array of string |
Wskazuje obowiązkowe właściwości niestandardowe, które mają zostać wprowadzone podczas tworzenia lub aktualizowania dokumentu tej podklasy. |
|
Retain
|
data.results.retain | integer |
Wskazuje liczbę dni przed oznaczeniem nieaktywnych dokumentów tej podklasy jako wygasłych. |
|
Jest w tle
|
data.results.shadow | boolean |
Wskazuje, czy dokument tej podklasy jest w tle (zachowywany) na komputerze lokalnym użytkownika po zaewidencjonowaniu go. |
Pobieranie podstawowych właściwości rozszerzonych metadanych dokumentu
Pobiera podstawowe właściwości rozszerzonych metadanych dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Latest
|
latest | boolean |
Określa, aby pobrać najnowszą wersję dokumentu. |
Pobieranie profilu dokumentu
Pobiera właściwości dokumentu skojarzone z określonym identyfikatorem dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Pobierz najnowszą wersję
|
latest | boolean |
Określa, aby pobrać najnowszą wersję dokumentu. |
Pobieranie profilu obszaru roboczego
Pobiera profil obszaru roboczego i opcjonalnie listę dozwolonych operacji dla obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator obszaru roboczego
|
workspaceId | True | string |
Określa identyfikator obszaru roboczego. Na przykład "ACTIVE_US!427". |
Pobieranie szablonów obszarów roboczych
Pobiera listę szablonów dostępnych w bibliotece. Szablon obszaru roboczego to wstępnie zdefiniowany obszar roboczy, którego struktura jest kopiowana dla nowego obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki docelowego obszaru roboczego. |
|
Niestandardowy1
|
custom1 | string |
Określa wartość zgodną z wartością custom1 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy 2
|
custom2 | string |
Określa wartość zgodną z wartością custom2 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowe 3
|
custom3 | string |
Określa wartość zgodną z wartością niestandardową3 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowe4
|
custom4 | string |
Określa wartość zgodną z wartością custom4 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy5
|
custom5 | string |
Określa wartość zgodną z wartością niestandardową5 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 6
|
custom6 | string |
Określa wartość, która ma być zgodna z wartością niestandardową skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy7
|
custom7 | string |
Określa wartość, która ma być zgodna z wartością niestandardową skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowe8
|
custom8 | string |
Określa wartość zgodną z wartością niestandardową8 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 9
|
custom9 | string |
Określa wartość zgodną z wartością custom9 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 10
|
custom10 | string |
Określa wartość zgodną z wartością niestandardową10 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 11
|
custom11 | string |
Określa wartość, która ma być zgodna z wartością custom11 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy 12
|
custom12 | string |
Określa wartość zgodną z wartością niestandardową12 skojarzona z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 17
|
custom17 | double |
Określa wartość parametru custom17. |
|
|
Niestandardowy18
|
custom18 | double |
Określa wartość parametru custom18. |
|
|
Niestandardowa 19
|
custom19 | double |
Określa wartość parametru custom19. |
|
|
Niestandardowe 20
|
custom20 | double |
Określa wartość parametru custom20. |
|
|
Niestandardowy 21
|
custom21 | string |
Określa wartość (w formacie daty/godziny ISO 8601), która ma być wyszukiwana w niestandardowym 21 skojarzonym z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Niestandardowe 22
|
custom22 | string |
Określa wartość (w formacie daty/godziny ISO 8601), która ma być wyszukiwana w niestandardowym22 skojarzonym z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Niestandardowe 23
|
custom23 | string |
Określa wartość (w formacie daty/godziny ISO 8601), która ma być wyszukiwana w niestandardowym23 skojarzonym z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Niestandardowe 24
|
custom24 | string |
Określa wartość (w formacie daty/godziny ISO 8601), która ma być wyszukiwana w niestandardowym 24 skojarzonym z szablonem obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Custom21 (dolny limit)
|
custom21_from | string |
Określa niższy limit custom21 (w formacie daty/godziny ISO 8601) do wyszukiwania. Ta właściwość nie jest zarezerwowana przez aplikację iManage Work i nie jest zweryfikowaną wartością. Ma zostać dostosowany do wymagań firmy. |
|
|
Custom21 (górny limit)
|
custom21_to | string |
Określa górny limit custom21 (w formacie daty/godziny ISO 8601) do wyszukiwania. Ta właściwość nie jest zarezerwowana przez aplikację iManage Work i nie jest zweryfikowaną wartością. Ma zostać dostosowany do wymagań firmy. |
|
|
Custom21 (względny)
|
custom21_relative | string |
Określa zakres dat do wyszukania względem bieżącej daty. Ten parametr ma format [begin]:[end][time units (d, m lub y)]. Na przykład -15:1d określa zakres dat z 15 dni przed bieżącą datą do jednego dnia po bieżącej dacie (jeden dzień w przyszłości). |
|
|
Custom22 (dolny limit)
|
custom22_from | string |
Określa niższy limit custom22 (w formacie daty/godziny ISO 8601) do wyszukiwania. Ta właściwość nie jest zarezerwowana przez aplikację iManage Work i nie jest zweryfikowaną wartością. Ma zostać dostosowany do wymagań firmy. |
|
|
Custom22 (górny limit)
|
custom22_to | string |
Określa górny limit custom22 (w formacie daty/godziny ISO 8601) do wyszukiwania. Ta właściwość nie jest zarezerwowana przez aplikację iManage Work i nie jest zweryfikowaną wartością. Ma zostać dostosowany do wymagań firmy. |
|
|
Custom22 (względny)
|
custom22_relative | string |
Określa zakres dat do wyszukania względem bieżącej daty. Ten parametr ma format [begin]:[end][time units (d, m lub y)]. Na przykład -15:1d określa zakres dat z 15 dni przed bieżącą datą do jednego dnia po bieżącej dacie (jeden dzień w przyszłości). |
|
|
Custom23 (dolny limit)
|
custom23_from | string |
Określa niższy limit custom23 (w formacie daty/godziny ISO 8601) do wyszukiwania. Ta właściwość nie jest zarezerwowana przez aplikację iManage Work i nie jest zweryfikowaną wartością. Ma zostać dostosowany do wymagań firmy. |
|
|
Custom23 (górny limit)
|
custom23_to | string |
Określa górny limit custom23 (w formacie daty/godziny ISO 8601) do wyszukiwania. Ta właściwość nie jest zarezerwowana przez aplikację iManage Work i nie jest zweryfikowaną wartością. Ma zostać dostosowany do wymagań firmy. |
|
|
Custom23 (względny)
|
custom23_relative | string |
Określa zakres dat do wyszukania względem bieżącej daty. Ten parametr ma format [begin]:[end][time units (d, m lub y)]. Na przykład -15:1d określa zakres dat z 15 dni przed bieżącą datą do jednego dnia po bieżącej dacie (jeden dzień w przyszłości). |
|
|
Custom24 (dolny limit)
|
custom24_from | string |
Określa niższy limit custom24 (w formacie daty/godziny ISO 8601) do wyszukiwania. Ta właściwość nie jest zarezerwowana przez aplikację iManage Work i nie jest zweryfikowaną wartością. Ma zostać dostosowany do wymagań firmy. |
|
|
Custom24 (górny limit)
|
custom24_to | string |
Określa górny limit custom24 (w formacie daty/godziny ISO 8601) do wyszukiwania. Ta właściwość nie jest zarezerwowana przez aplikację iManage Work i nie jest zweryfikowaną wartością. Ma zostać dostosowany do wymagań firmy. |
|
|
Niestandardowe24 (względne)
|
custom24_relative | string |
Określa zakres dat do wyszukania względem bieżącej daty. Ten parametr ma format [begin]:[end][time units (d, m lub y)]. Na przykład -15:1d określa zakres dat z 15 dni przed bieżącą datą do jednego dnia po bieżącej dacie (jeden dzień w przyszłości). |
|
|
Niestandardowe 25
|
custom25 | boolean |
Określa wartość niestandardową25 do wyszukania. |
|
|
Niestandardowe 26
|
custom26 | boolean |
Określa wartość niestandardową26 do wyszukania. |
|
|
Niestandardowe 27
|
custom27 | boolean |
Określa wartość niestandardową27 do wyszukania. |
|
|
Niestandardowe 28
|
custom28 | boolean |
Określa wartość niestandardową28 do wyszukania. |
|
|
Niestandardowy 29
|
custom29 | string |
Określa wartość, która ma być zgodna z parametrem custom29. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 30
|
custom30 | string |
Określa wartość, która ma być zgodna z parametrem custom30. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
Pobieranie szczegółów użytkownika
Pobiera informacje o użytkowniku z określonej biblioteki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki użytkownika docelowego. |
|
Identyfikator użytkownika
|
userId | True | string |
Określa identyfikator użytkownika, dla którego mają być dostępne szczegółowe informacje o profilu. Na przykład "JSMITH". |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | UserProfile |
Wskazuje informacje o użytkowniku. |
Pobieranie wersji dokumentów
Pobiera profile dla wszystkich wersji, do których bieżący użytkownik ma dostęp dla określonego dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Profile dokumentów
|
data | array of MinimalDocumentProfileInArray |
Podwyższanie poziomu wersji dokumentu
Promuje istniejącą wersję dokumentu do najnowszej wersji. Nowa wersja jest tworzona na podstawie określonego identyfikatora dziennika lub wersji, a następnie awansowana do najnowszej wersji. Należy określić identyfikator dziennika lub wersję, ale nie obie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
wersja
|
version | integer |
Określa numer wersji, który ma być używany jako podstawa dla nowej, promowanej wersji. |
|
|
Identyfikator dziennika
|
journalId | string |
Określa identyfikator dziennika, który ma być używany jako podstawa dla nowej, promowanej wersji. |
|
|
Comment
|
comment | string |
Określa dodatkowe informacje o dokumencie. |
|
|
Pseudonim
|
alias | string |
Określa alias tego dokumentu. |
|
|
Author
|
author | string |
Określa identyfikator użytkownika, który utworzył dokument. Na przykład "JSMITH". |
|
|
Klasa dokumentu
|
class | string |
Określa klasę dokumentu. |
|
|
Zabezpieczenia domyślne dokumentu
|
default_security | string |
Określa domyślny poziom dostępu do zabezpieczeń. |
|
|
Jest zadeklarowany
|
is_declared | boolean |
Określa, czy nowa wersja dokumentu ma być zadeklarowana jako rekord. Nie można edytować ani usuwać dokumentu zadeklarowanego jako rekord, z wyjątkiem administratora systemu pracy iManage. |
|
|
Jest HIPAA
|
is_hipaa | boolean |
Określa, czy nowa wersja dokumentu ma być zaszyfrowana. |
|
|
Nazwa dokumentu
|
name | string |
Określa nazwę pliku dokumentu. |
|
|
Operator
|
operator | string |
Określa identyfikator użytkownika, który ma wyewidencjonowany dokument lub aktualnie edytuje profil dokumentu. Na przykład "JSMITH". |
|
|
Zachowaj dni
|
retain_days | integer |
Określa liczbę dni, po których dokument nieaktywny kwalifikuje się do archiwizacji. |
|
|
Podklasa
|
subclass | string |
Określa podklasę dokumentu. |
|
|
Niestandardowy1
|
custom1 | string |
Określa wartość custom1. |
|
|
Niestandardowy 2
|
custom2 | string |
Określa wartość custom2. Aby określić wartość parametru custom2, należy również określić wartość dla parametru custom1 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
|
|
Niestandardowe 3
|
custom3 | string |
Określa wartość custom3. |
|
|
Niestandardowe4
|
custom4 | string |
Określa wartość custom4. |
|
|
Niestandardowy5
|
custom5 | string |
Określa wartość custom5. |
|
|
Niestandardowa 6
|
custom6 | string |
Określa wartość custom6. |
|
|
Niestandardowy7
|
custom7 | string |
Określa wartość custom7. |
|
|
Niestandardowe8
|
custom8 | string |
Określa wartość custom8. |
|
|
Niestandardowa 9
|
custom9 | string |
Określa wartość custom9. |
|
|
Niestandardowa 10
|
custom10 | string |
Określa wartość custom10. |
|
|
Niestandardowa 11
|
custom11 | string |
Określa wartość custom11. |
|
|
Niestandardowy 12
|
custom12 | string |
Określa wartość custom12. |
|
|
Niestandardowa 13
|
custom13 | string |
Określa wartość custom13. |
|
|
Niestandardowe 14
|
custom14 | string |
Określa wartość custom14. |
|
|
Niestandardowy 15
|
custom15 | string |
Określa wartość custom15. |
|
|
Niestandardowa 16
|
custom16 | string |
Określa wartość custom16. |
|
|
Niestandardowa 17
|
custom17 | double |
Określa wartość custom17. |
|
|
Niestandardowy18
|
custom18 | double |
Określa wartość custom18. |
|
|
Niestandardowa 19
|
custom19 | double |
Określa wartość custom19. |
|
|
Niestandardowe 20
|
custom20 | double |
Określa wartość custom20. |
|
|
Niestandardowy 21
|
custom21 | string |
Określa wartość właściwości custom21 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 22
|
custom22 | string |
Określa wartość właściwości custom22 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 23
|
custom23 | string |
Określa wartość właściwości custom23 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 24
|
custom24 | string |
Określa wartość właściwości custom24 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 25
|
custom25 | boolean |
Określa wartość custom25. |
|
|
Niestandardowe 26
|
custom26 | boolean |
Określa wartość custom26. |
|
|
Niestandardowe 27
|
custom27 | boolean |
Określa wartość custom27. |
|
|
Niestandardowe 28
|
custom28 | boolean |
Określa wartość custom28. |
|
|
Niestandardowy 29
|
custom29 | string |
Określa wartość custom29. |
|
|
Niestandardowa 30
|
custom30 | string |
Określa wartość custom30. Aby określić wartość parametru custom30, należy również określić wartość dla parametru custom29 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
Przekazywanie dokumentu
Przekazuje plik jako nowy dokument do określonego folderu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki docelowej. |
|
Identyfikator folderu
|
folderId | True | string |
Określa identyfikator folderu docelowego. Na przykład "ACTIVE_US!987". |
|
Dziedzicz profil folderu
|
inherit_profile_from_folder | True | boolean |
Określa, czy dane profilu są dziedziczone z folderu nadrzędnego. |
|
Zachowaj blokadę
|
keep_locked | boolean |
Określa, czy blokada dokumentu jest przechowywana po przekazaniu. |
|
|
Comment
|
comment | string |
Określa dodatkowe informacje o aktualizacji. |
|
|
Author
|
author | string |
Określa identyfikator iManage Work użytkownika, który utworzył dokument. |
|
|
Operator
|
operator | string |
Określa identyfikator użytkownika, który ma wyewidencjonowany dokument lub aktualnie edytuje profil dokumentu. Na przykład "JSMITH". |
|
|
Class
|
class | string |
Określa klasę do identyfikowania i różnicowania dokumentu. Klasa dokumentów jest kategoryzowana według gatunku, działu, regionu itd. |
|
|
Podklasa
|
subclass | string |
Określa podklasę do identyfikowania i różnicowania dokumentu. Podklasa dokumentów jest klasyfikowana według gatunku, działu, regionu itd. |
|
|
Domyślne zabezpieczenia
|
default_security | string |
Określa domyślny poziom dostępu do zabezpieczeń. Możliwe wartości to "inherit", "private", "view", "public". |
|
|
Jest HIPAA
|
is_hipaa | boolean |
Określa, czy dokument ma być zaszyfrowany. |
|
|
Zachowaj dni
|
retain_days | integer |
Określa liczbę dni, przez które dokument musi być nieaktywny przed oznaczeniem go do archiwizacji. |
|
|
Zawartość pliku
|
file | True | file |
Określa zawartość pliku. |
|
Data utworzenia pliku
|
file_create_date | date-time |
Określa datę i godzinę (w formacie ISO 8601), który został utworzony. Plik mógł zostać utworzony poza systemem iManage Work. Ta data może być inna niż "create_date". Create_date to data utworzenia lub zaimportowania pliku przez system iManage Work. |
|
|
Data edycji pliku
|
file_edit_date | date-time |
Określa datę i godzinę (w formacie ISO 8601) najnowszej zmiany pliku. Plik mógł zostać zmieniony przed przekazaniem do systemu iManage Work. |
|
|
Niestandardowy1
|
custom1 | string |
Określa wartość parametru custom1. |
|
|
Niestandardowy 2
|
custom2 | string |
Określa wartość parametru custom2. Aby określić wartość parametru custom2, należy również określić wartość dla parametru custom1 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
|
|
Niestandardowe 3
|
custom3 | string |
Określa wartość parametru custom3. |
|
|
Niestandardowe4
|
custom4 | string |
Określa wartość parametru custom4. |
|
|
Niestandardowy5
|
custom5 | string |
Określa wartość parametru custom5. |
|
|
Niestandardowa 6
|
custom6 | string |
Określa wartość dla parametru custom6. |
|
|
Niestandardowy7
|
custom7 | string |
Określa wartość dla elementu custom7. |
|
|
Niestandardowe8
|
custom8 | string |
Określa wartość dla parametru custom8. |
|
|
Niestandardowa 9
|
custom9 | string |
Określa wartość dla parametru custom9. |
|
|
Niestandardowa 10
|
custom10 | string |
Określa wartość parametru custom10. |
|
|
Niestandardowa 11
|
custom11 | string |
Określa wartość parametru custom11. |
|
|
Niestandardowy 12
|
custom12 | string |
Określa wartość parametru custom12. |
|
|
Niestandardowa 13
|
custom13 | string |
Określa wartość parametru custom13. |
|
|
Niestandardowe 14
|
custom14 | string |
Określa wartość parametru custom14. |
|
|
Niestandardowy 15
|
custom15 | string |
Określa wartość parametru custom15. |
|
|
Niestandardowa 16
|
custom16 | string |
Określa wartość dla elementu custom16. |
|
|
Niestandardowa 17
|
custom17 | double |
Określa wartość parametru custom17. |
|
|
Niestandardowy18
|
custom18 | double |
Określa wartość parametru custom18. |
|
|
Niestandardowa 19
|
custom19 | double |
Określa wartość parametru custom19. |
|
|
Niestandardowe 20
|
custom20 | double |
Określa wartość parametru custom20. |
|
|
Niestandardowy 21
|
custom21 | string |
Określa wartość parametru custom21 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 22
|
custom22 | string |
Określa wartość custom22 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 23
|
custom23 | string |
Określa wartość parametru custom23 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 24
|
custom24 | string |
Określa wartość parametru custom24 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 25
|
custom25 | boolean |
Określa wartość parametru custom25. |
|
|
Niestandardowe 26
|
custom26 | boolean |
Określa wartość parametru custom26. |
|
|
Niestandardowe 27
|
custom27 | boolean |
Określa wartość parametru custom27. |
|
|
Niestandardowe 28
|
custom28 | boolean |
Określa wartość parametru custom28. |
|
|
Niestandardowy 29
|
custom29 | string |
Określa wartość parametru custom29. |
|
|
Niestandardowa 30
|
custom30 | string |
Określa wartość parametru custom30. Aby określić wartość parametru custom30, należy również określić wartość dla parametru custom29 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
Przenoszenie dokumentu
Przenosi dokument do określonego folderu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator folderu nadrzędnego
|
folderId | True | string |
Określa identyfikator folderu nadrzędnego. Na przykład "ACTIVE_US!987". |
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Identyfikator folderu docelowego
|
destination_folder_id | True | string |
Określa identyfikator folderu docelowego, do którego ma zostać przeniesiony dokument. Na przykład "ACTIVE_US!987". |
|
Zastosuj profil docelowy
|
update_profile | boolean |
Określa, czy profil dokumentu ma zostać zaktualizowany przy użyciu profilu folderu docelowego. |
|
|
Stosowanie zabezpieczeń docelowych
|
update_security | boolean |
Określa, czy zabezpieczenia dokumentu mają zostać zaktualizowane przy użyciu zabezpieczeń folderu docelowego. Ten parametr ma zastosowanie tylko wtedy, gdy dla profilu aktualizacji ustawiono wartość true. |
|
|
Komentarze osi czasu
|
comments | string |
Określa dodatkowe informacje o operacji. Te komentarze są widoczne na osi czasu dokumentu. |
Tworzenie obszaru roboczego
Tworzy nowy obszar roboczy na podstawie wybranego szablonu. Szablon obszaru roboczego to wstępnie zdefiniowany obszar roboczy, którego struktura jest kopiowana do nowego obszaru roboczego. Ograniczenia szablonu obszaru roboczego są wymuszane automatycznie podczas tworzenia nowego obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki docelowego obszaru roboczego. |
|
Template
|
templateId | True | string |
Określa szablon obszaru roboczego, który ma być używany do tworzenia obszaru roboczego i jego elementów podrzędnych. |
|
Name
|
name | True | string |
Określa nazwę obszaru roboczego. |
|
Tworzenie elementów podrzędnych
|
createChildren | True | string |
Określa, aby utworzyć wszystkie foldery (opcjonalne i wymagane) lub tylko wymagane foldery. |
|
Właściciel obszaru roboczego
|
owner | string |
Określa właściciela obszaru roboczego. Aby ustawić właściciela obszaru roboczego, musisz być administratorem systemu roboczego iManage Work. |
|
|
Domyślne zabezpieczenia
|
default_security | string |
Określa domyślny poziom dostępu. Jeśli nie zostanie określony, zostanie użyty domyślny poziom dostępu wybranego szablonu. |
|
|
Description
|
description | string |
Określa dodatkowe informacje o obszarze roboczym. |
|
|
Niestandardowy1
|
custom1 | string |
Określa wartość custom1 do skojarzenia z nowo utworzonym obszarem roboczym. Ta wartość zastępuje wartość custom1 wybranego obszaru roboczego szablonu, jeśli jest obecna. Jeśli foldery podrzędne mają zestaw wartości custom1, wartość custom1 tych folderów podrzędnych nie zostanie zastąpiona. |
|
|
Niestandardowy 2
|
custom2 | string |
Określa wartość custom2 do skojarzenia z nowo utworzonym obszarem roboczym. Aby określić wartość parametru custom2, należy również określić wartość dla parametru custom1 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. Ta wartość zastępuje wartość custom2 wybranego obszaru roboczego szablonu, jeśli jest obecna. Jeśli foldery podrzędne mają zestaw wartości custom2, wartość custom2 tych folderów podrzędnych nie zostanie zastąpiona. |
|
|
Niestandardowe 3
|
custom3 | string |
Określa wartość custom3. |
|
|
Niestandardowe4
|
custom4 | string |
Określa wartość custom4. |
|
|
Niestandardowy5
|
custom5 | string |
Określa wartość custom5. |
|
|
Niestandardowa 6
|
custom6 | string |
Określa wartość custom6. |
|
|
Niestandardowy7
|
custom7 | string |
Określa wartość custom7. |
|
|
Niestandardowe8
|
custom8 | string |
Określa wartość custom8. |
|
|
Niestandardowa 9
|
custom9 | string |
Określa wartość custom9. |
|
|
Niestandardowa 10
|
custom10 | string |
Określa wartość custom10. |
|
|
Niestandardowa 11
|
custom11 | string |
Określa wartość custom11. |
|
|
Niestandardowy 12
|
custom12 | string |
Określa wartość custom12. |
|
|
Niestandardowa 13
|
custom13 | string |
Określa wartość custom13. |
|
|
Niestandardowe 14
|
custom14 | string |
Określa wartość custom14. |
|
|
Niestandardowy 15
|
custom15 | string |
Określa wartość custom15. |
|
|
Niestandardowa 16
|
custom16 | string |
Określa wartość custom16. |
|
|
Niestandardowa 17
|
custom17 | double |
Określa wartość custom17. |
|
|
Niestandardowy18
|
custom18 | double |
Określa wartość custom18. |
|
|
Niestandardowa 19
|
custom19 | double |
Określa wartość custom19. |
|
|
Niestandardowe 20
|
custom20 | double |
Określa wartość custom20. |
|
|
Niestandardowy 21
|
custom21 | string |
Określa wartość custom21 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 22
|
custom22 | string |
Określa wartość custom22 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 23
|
custom23 | string |
Określa wartość custom23 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 24
|
custom24 | string |
Określa wartość custom24 w formacie daty/godziny ISO 8601. |
|
|
Niestandardowe 25
|
custom25 | boolean |
Określa wartość custom25. |
|
|
Niestandardowe 26
|
custom26 | boolean |
Określa wartość custom26. |
|
|
Niestandardowe 27
|
custom27 | boolean |
Określa wartość custom27. |
|
|
Niestandardowe 28
|
custom28 | boolean |
Określa wartość custom28. |
|
|
Niestandardowy 29
|
custom29 | string |
Określa wartość custom29. |
|
|
Niestandardowa 30
|
custom30 | string |
Określa wartość custom30. Aby określić wartość parametru custom30, należy również określić wartość dla parametru custom29 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
|
|
Jest zewnętrzny w normalny sposób
|
is_external_as_normal | boolean |
Określa obszar roboczy może być traktowany jako publiczny obszar roboczy. Jeśli ustawiono wartość "true", a wartość "default_security" nie jest "prywatna", ustawia wartość "is_external" na wartość "true". |
|
|
Projekt niestandardowy1
|
project_custom1 | string |
Określa dodatkowe informacje o obszarze roboczym. To pole różni się od pola niestandardowego metadanych skojarzonego z elementami zawartości, takimi jak dokumenty, obszary robocze lub foldery. Jest to tekst opisowy, który nie musi być sformatowany i nie jest weryfikowany. |
|
|
Projekt niestandardowy 2
|
project_custom2 | string |
Określa dodatkowe informacje o obszarze roboczym. To pole różni się od pola niestandardowego metadanych skojarzonego z elementami zawartości, takimi jak dokumenty, obszary robocze lub foldery. Jest to tekst opisowy, który nie musi być sformatowany i nie jest weryfikowany. |
|
|
Projekt niestandardowy3
|
project_custom3 | string |
Określa dodatkowe informacje o obszarze roboczym. To pole różni się od pola niestandardowego metadanych skojarzonego z elementami zawartości, takimi jak dokumenty, obszary robocze lub foldery. Jest to tekst opisowy, który nie musi być sformatowany i nie jest weryfikowany. |
|
|
Podklasa obszaru roboczego
|
subclass | string |
Określa podklasę obszaru roboczego na podstawie podklasy dokumentu, który zawiera. |
Tworzenie relacji dokumentu
Tworzy relację między określonymi dokumentami w bibliotece.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu podstawowego
|
primaryDocumentId | True | string |
Określa identyfikator dokumentu podstawowego do powiązania. Na przykład "ACTIVE_US!453.1". |
|
Identyfikator powiązanego dokumentu
|
relatedDocumentId | True | string |
Określa identyfikator dokumentu, który ma być powiązany. Na przykład "ACTIVE_US!453.1". |
Zwraca
- response
- object
Uprawnienia do kopiowania
Kopiuje uprawnienia dostępu i opcjonalnie domyślne zabezpieczenia z jednego obiektu iManage Work do innego. Opcja "Kopiuj typ" umożliwia obsługę kombinacji uprawnień źródłowych i docelowych. Polecenie "Zastąp" aktualizuje użytkowników, grupy i poziomy uprawnień obiektu docelowego, aby dokładnie pasować do obiektów źródłowych. Polecenie "Merge" przechowuje wszystkich użytkowników i grupy w obiekcie docelowym i łączy je ze źródłem, ale w przypadku konfliktu poziomu uprawnień dla pojedynczej osoby lub grupy: "Scalanie (pesymistyczne)" przyjmuje mniejsze uprawnienie, podczas gdy "Scalanie (optymistyczne)" przyjmuje wyższe uprawnienie dla sprzecznego użytkownika lub grupy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ obiektu źródłowego
|
sourceObjectType | True | string |
Określa typ obiektu źródłowego. |
|
Identyfikator obiektu źródłowego
|
sourceObjectId | True | string |
Określa identyfikator obiektu, z którego są kopiowane uprawnienia. Przykładem identyfikatora dokumentu jest "ACTIVE_US!453.1". Przykładem folderu lub identyfikatora obszaru roboczego jest "ACTIVE_US!123". |
|
Typ obiektu docelowego
|
targetObjectType | True | string |
Określa typ obiektu docelowego. |
|
Identyfikator obiektu docelowego
|
targetObjectId | True | string |
Określa identyfikator obiektu, do którego są kopiowane uprawnienia. Przykładem identyfikatora dokumentu jest "ACTIVE_US!453.1". Przykładem folderu lub identyfikatora obszaru roboczego jest "ACTIVE_US!123". |
|
Typ kopiowania
|
copyType | True | string |
Określa, aby scalić uprawnienia obiektu źródłowego z uprawnieniami obiektu docelowego lub zastąpić uprawnienia obiektu docelowego z uprawnieniami źródłowymi. Aby uzyskać szczegółowe informacje, zobacz opis akcji. |
|
Kopiuj domyślne zabezpieczenia
|
copyDefaultSecurity | True | boolean |
Określa, aby skopiować domyślne zabezpieczenia obiektu źródłowego do obiektu docelowego. Jeśli domyślne zabezpieczenia obiektu źródłowego to "dziedzicz", dziedziczone zabezpieczenia domyślne są kopiowane ze źródła do obiektu docelowego. |
Zwraca
Ustawianie podstawowych właściwości rozszerzonych metadanych w dokumencie
Ustawia podstawowe właściwości rozszerzonych metadanych w dokumencie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Name
|
key | True | string |
Określa nazwę podstawowej właściwości rozszerzonych metadanych. |
|
Wartość
|
value | True | string |
Określa co najmniej jedną wartość, która ma być ustawiona dla podstawowej właściwości rozszerzonych metadanych oddzielonych średnikami. Aby usunąć ustawienie wartości, ustaw wartość klucza na pusty ciąg owinięty w cudzysłów pojedynczych lub podwójnych. |
Usuwanie dokumentu
Usuwa określony dokument.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Usuń wszystkie wersje
|
deleteAllVersions | True | boolean |
Określa, aby usunąć wszystkie wersje dokumentu. |
Usuń odwołanie do dokumentu
Usuwa odwołanie do dokumentu z określonego folderu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Określa identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Identyfikator folderu
|
folderId | True | string |
Określa identyfikator folderu. Na przykład "ACTIVE_US!773". |
Zwraca
- response
- object
Usuń relację dokumentu
Usuwa relację między określonymi dokumentami w bibliotece.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu podstawowego
|
primaryDocumentId | True | string |
Określa identyfikator dokumentu podstawowego. Na przykład "ACTIVE_US!453.1". |
|
Identyfikator powiązanego dokumentu
|
relatedDocumentId | True | string |
Określa identyfikator powiązanego dokumentu. Na przykład "ACTIVE_US!453.1". |
Zwraca
- response
- object
Uzyskiwanie powierniczych
Pobiera listę zaufanych z określonymi uprawnieniami dla dokumentu, folderu lub obszaru roboczego. Powiernik może być użytkownikiem lub grupą.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ obiektu
|
objectType | True | string |
Określa typ obiektu. |
|
Identyfikator obiektu
|
objectId | True | string |
Określa identyfikator dokumentu, folderu lub obszaru roboczego. Przykładem identyfikatora dokumentu jest "ACTIVE_US!453.1". Przykładem folderu lub identyfikatora obszaru roboczego jest "ACTIVE_US!123". |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of object |
Wskazuje listę zaufanych z określonymi uprawnieniami dla dokumentu, folderu lub obszaru roboczego. Powiernik może być użytkownikiem lub grupą. |
|
Pełna nazwa
|
data.full_name | string |
Wskazuje pełną nazwę zaufania. |
|
identyfikator
|
data.id | string |
Wskazuje identyfikator zaufania. Może to być identyfikator grupy lub identyfikator użytkownika. Na przykład "JSMITH" lub "MARKETING". |
|
SSID
|
data.ssid | string |
Wskazuje unikatowy, wygenerowany przez system identyfikator trustee. |
|
Typ
|
data.type | string |
Wskazuje typ zwróconej jednostki. Możliwe wartości to "użytkownik" lub "grupa". |
Uzyskiwanie uprawnień
Pobiera właściwości uprawnień dostępu użytkownika lub grupy dokumentu, folderu lub obszaru roboczego. Właściwości odpowiedzi mogą się różnić w zależności od uprawnień użytkownika lub grupy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ obiektu
|
objectType | True | string |
Określa typ obiektu. |
|
Identyfikator obiektu
|
objectId | True | string |
Określa identyfikator dokumentu, folderu lub obszaru roboczego. Przykładem identyfikatora dokumentu jest "ACTIVE_US!453.1". Przykładem folderu lub identyfikatora obszaru roboczego jest "ACTIVE_US!123". |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Domyślne zabezpieczenia
|
data.default_security | string |
Wskazuje domyślne zabezpieczenia obiektu. Możliwe wartości to "dziedzicz", "publiczny", "widok" lub "prywatny". |
|
Zabezpieczenia domyślne dziedziczone
|
data.inherited_default_security | string |
Wskazuje dziedziczone domyślne zabezpieczenia folderu, gdy domyślne zabezpieczenia są ustawione na "dziedziczone". Możliwe wartości to "public", "view" lub "private". |
|
Uprawnienia dostępu
|
data.acl | AccessPermissions |
Wskazuje kolekcję uprawnień dostępu dla co najmniej jednego użytkownika i/lub grup. |
|
Wszystkie identyfikatory użytkowników
|
data.all_user_ids | string |
Wskazuje listę wszystkich identyfikatorów użytkowników, połączonych jako ciąg i oddzielonych średnikami. |
|
Wszystkie identyfikatory grup
|
data.all_group_ids | string |
Wskazuje listę wszystkich identyfikatorów grup, połączonych jako ciąg i rozdzielonych średnikami. |
Wyszukaj podstawowe wartości węzłów taksonomii rozszerzonych metadanych
Wyszukuje podstawowe wartości taksonomii rozszerzonych metadanych pasujących do określonych kryteriów wyszukiwania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki, na której ma być wykonywane wyszukiwanie. |
|
Właściwość taksonomii
|
taxonomyProperty | True | string |
Określa właściwość taksonomii, dla której mają być wyszukiwane wartości węzłów. |
|
identyfikator
|
id | string |
Określa identyfikator wyświetlania wartości węzła taksonomii. To wyszukiwanie nie uwzględnia wielkości liter. Częściowe dopasowania nie są obsługiwane. |
|
|
Query
|
query | string |
Określa zapytanie dotyczące pasujących wartości węzłów taksonomii przy użyciu symbolu wieloznakowego (*) wyszukiwania, udostępniając częściowe dopasowania identyfikatora wyświetlania lub opisu. |
|
|
Stan węzła
|
enabled_state | string |
Określa, aby zwrócić tylko wartości węzłów taksonomii, które są włączone lub wyłączone lub oba. |
|
|
Dołącz ścieżkę
|
include_path | boolean |
Określa, aby zwrócić pełną ścieżkę do pasującej wartości węzła. Ścieżka to uporządkowana lista rozpoczynająca się od węzła najwyższego poziomu w taksonomii, a następnie wszystkich węzłów do bezpośredniego nadrzędnego węzła pasującego. |
|
|
Identyfikator SSID węzła przodka
|
children_of_ssid | string |
Określa unikatowy, wygenerowany przez system identyfikator węzła taksonomii przodków, aby ograniczyć wyszukiwanie do. |
|
|
Tylko bezpośrednie elementy podrzędne
|
immediate_children_only | boolean |
Określa, aby ograniczyć wyniki wyszukiwania do bezpośrednich elementów podrzędnych węzła taksonomii określonego przez identyfikator SSID węzła Ancestor. Wyszukiwanie może być ograniczone do poziomu głównego taksonomii, określając pusty ciąg "Ancestor Node SSID" opakowany w pojedyncze lub podwójne cudzysłowy. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
SSID
|
data.topMatchingResult.created_by.ssid | string |
Wskazuje unikatowy, wygenerowany przez system identyfikator użytkownika, który utworzył najwyższą zgodną wartość węzła. |
|
Data utworzenia
|
data.topMatchingResult.create_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) utworzono najwyższą zgodną wartość węzła. |
|
Description
|
data.topMatchingResult.description | string |
Wskazuje opis najwyższej zgodnej wartości węzła. |
|
SSID
|
data.topMatchingResult.edited_by.ssid | string |
Wskazuje unikatowy identyfikator wygenerowany przez system dla użytkownika, który ostatnio edytował najwyższą zgodną wartość węzła. |
|
Edytuj datę
|
data.topMatchingResult.edit_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) ostatnio edytowaną wartość pasującego węzła. |
|
Jest włączona
|
data.topMatchingResult.enabled | boolean |
Wskazuje, czy jest włączona górna zgodna wartość węzła. |
|
identyfikator
|
data.topMatchingResult.id | string |
Wskazuje identyfikator wyświetlania dla najwyższej zgodnej wartości węzła. |
|
SSID
|
data.topMatchingResult.parent.ssid | string |
Wskazuje unikatowy, wygenerowany przez system identyfikator natychmiastowego węzła nadrzędnego najwyższej zgodnej wartości węzła. |
|
SSID
|
data.topMatchingResult.ssid | string |
Wskazuje unikatowy identyfikator wygenerowany przez system dla najwyższej zgodnej wartości węzła. |
|
Ścieżka
|
data.topMatchingResult.path | array of object |
Wskazuje pełną ścieżkę do najwyższej zgodnej wartości węzła. Ścieżka to uporządkowana lista rozpoczynająca się od węzła najwyższego poziomu w taksonomii, a następnie wszystkich węzłów do bezpośredniego nadrzędnego węzła pasującego. |
|
Każdy identyfikator
|
data.topMatchingResult.path.id | string |
Wskazuje identyfikator wyświetlania wartości węzła w ścieżce górnego pasującego węzła. |
|
Każdy identyfikator SSID
|
data.topMatchingResult.path.ssid | string |
Wskazuje unikatowy identyfikator wygenerowany przez system dla wartości węzła w ścieżce najwyższego pasującego węzła. |
|
Podstawowe wyniki wyszukiwania taksonomii rozszerzonych metadanych
|
data.results | array of TaxonomyNodeValue |
Wskazuje co najmniej jedną podstawową wartość węzła taksonomii rozszerzonych metadanych pasujących do wyszukiwania. |
|
Wszystkie identyfikatory SID węzła taksonomii
|
data.all_taxonomy_ssids | string |
Wskazuje listę wszystkich identyfikatorów SID węzłów taksonomii, połączonych jako ciąg i oddzielonych średnikami. |
Wyszukiwanie folderów
Wyszukaj foldery.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki folderu docelowego. |
|
Identyfikator kontenera
|
container_id | string |
Określa identyfikator obszaru roboczego lub folderu, z którego mają być zwracane foldery. Na przykład "ACTIVE_US!987". Jeśli ten parametr zostanie podany, zwraca foldery tylko z określonego obszaru roboczego lub folderu. |
|
|
Opis folderu
|
description | string |
Określa wartość, która ma zostać znaleziona we właściwości description folderu. To wyszukiwanie nie uwzględnia wielkości liter. Częściowe dopasowania są obsługiwane. |
|
|
Adres e-mail folderu
|
string |
Określa adres e-mail zgodny z adresem e-mail folderu. Na przykład 'email1234@ajubalaw.com'. |
||
|
Nazwa folderu
|
name | string |
Określa wartość, która ma zostać znaleziona we właściwości name folderu. To wyszukiwanie nie uwzględnia wielkości liter. Częściowe dopasowania są obsługiwane. |
|
|
Właściciel folderu
|
owner | string |
Określa ciąg, który ma być zgodny z właścicielem skojarzonym z folderem. To wyszukiwanie nie uwzględnia wielkości liter. Częściowe dopasowania są obsługiwane. |
|
|
Nazwa obszaru roboczego
|
workspace_name | string |
Określa nazwę nadrzędnego obszaru roboczego, do którego należy folder. To wyszukiwanie nie uwzględnia wielkości liter. Częściowe dopasowania są obsługiwane. |
Wyszukiwanie obszarów roboczych
Wyszukaj obszary robocze.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki docelowego obszaru roboczego. |
|
Title
|
name | string |
Określa ciąg do wyszukania we właściwości name obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. |
|
|
Właściciel
|
owner | string |
Określa ciąg, który ma być zgodny z właścicielem skojarzonym z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. |
|
|
Keyword
|
anywhere | string |
Określa tekst, który ma być wyszukiwany w dowolnym miejscu w profilu obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. |
|
|
Description
|
description | string |
Określa tekst do wyszukania we właściwości description obszaru roboczego. To wyszukiwanie nie uwzględnia wielkości liter. |
|
|
Podklasa
|
subclass | string |
Określa wartość zgodną z wartością podklasy skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. |
|
|
Niestandardowy1
|
custom1 | string |
Określa wartość zgodną z wartością custom1 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy 2
|
custom2 | string |
Określa wartość, która ma być zgodna z wartością custom2 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowe 3
|
custom3 | string |
Określa wartość zgodną z wartością custom3 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowe4
|
custom4 | string |
Określa wartość, która ma być zgodna z wartością custom4 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy5
|
custom5 | string |
Określa wartość zgodną z wartością niestandardową5 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 6
|
custom6 | string |
Określa wartość, która ma być zgodna z wartością niestandardową skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy7
|
custom7 | string |
Określa wartość zgodną z wartością niestandardową7 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowe8
|
custom8 | string |
Określa wartość zgodną z wartością niestandardową8 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 9
|
custom9 | string |
Określa wartość zgodną z wartością custom9 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 10
|
custom10 | string |
Określa wartość zgodną z wartością niestandardową10 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 11
|
custom11 | string |
Określa wartość zgodną z wartością custom11 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy 12
|
custom12 | string |
Określa wartość zgodną z wartością niestandardową12 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 13
|
custom13 | string |
Określa wartość zgodną z wartością niestandardową13 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania są obsługiwane. |
|
|
Niestandardowe 14
|
custom14 | string |
Określa wartość zgodną z wartością niestandardową14 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania są obsługiwane. |
|
|
Niestandardowy 15
|
custom15 | string |
Określa wartość zgodną z wartością niestandardową15 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania są obsługiwane. |
|
|
Niestandardowa 16
|
custom16 | string |
Określa wartość zgodną z wartością niestandardową16 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania są obsługiwane. |
|
|
Niestandardowa 17
|
custom17 | string |
Określa wartość, która ma być zgodna z wartością niestandardową17 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowy18
|
custom18 | string |
Określa wartość zgodną z wartością niestandardową18 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 19
|
custom19 | string |
Określa wartość zgodną z wartością niestandardową19 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowe 20
|
custom20 | string |
Określa wartość zgodną z wartością niestandardową20 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Custom21 (dolny limit)
|
custom21_from | string |
Określa niższy limit (w formacie daty/godziny ISO 8601) do wyszukiwania we właściwości custom21 skojarzonej z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Custom21 (górny limit)
|
custom21_to | string |
Określa górny limit (w formacie daty/godziny ISO 8601) do wyszukiwania w właściwości custom21 skojarzonej z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Custom22 (dolny limit)
|
custom22_from | string |
Określa niższy limit (w formacie daty/godziny ISO 8601) do wyszukiwania we właściwości custom22 skojarzonej z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Custom22 (górny limit)
|
custom22_to | string |
Określa górny limit (w formacie daty/godziny ISO 8601) do wyszukiwania we właściwości custom22 skojarzonej z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Custom23 (dolny limit)
|
custom23_from | string |
Określa niższy limit (w formacie daty/godziny ISO 8601) do wyszukiwania we właściwości custom23 skojarzonej z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Custom23 (górny limit)
|
custom23_to | string |
Określa górny limit (w formacie daty/godziny ISO 8601) do wyszukiwania we właściwości custom23 skojarzonej z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Custom24 (dolny limit)
|
custom24_from | string |
Określa niższy limit (w formacie daty/godziny ISO 8601) do wyszukiwania we właściwości custom24 skojarzonej z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Custom24 (górny limit)
|
custom24_to | string |
Określa górny limit (w formacie daty/godziny ISO 8601) do wyszukiwania we właściwości custom24 skojarzonej z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. W przypadku obszarów roboczych użycie tej właściwości jest dostosowane do instalacji aplikacji iManage Work. |
|
|
Niestandardowe 25
|
custom25 | boolean |
Określa wartość zgodną z wartością niestandardową25 skojarzona z obszarem roboczym. |
|
|
Niestandardowe 26
|
custom26 | boolean |
Określa wartość zgodną z wartością niestandardową26 skojarzona z obszarem roboczym. |
|
|
Niestandardowe 27
|
custom27 | boolean |
Określa wartość, która ma być zgodna z wartością niestandardową27 skojarzona z obszarem roboczym. |
|
|
Niestandardowe 28
|
custom28 | boolean |
Określa wartość zgodną z wartością niestandardową28 skojarzona z obszarem roboczym. |
|
|
Niestandardowy 29
|
custom29 | string |
Określa wartość zgodną z wartością niestandardową29 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. |
|
|
Niestandardowa 30
|
custom30 | string |
Określa wartość, która ma być zgodna z wartością custom30 skojarzona z obszarem roboczym. To wyszukiwanie nie uwzględnia wielkości liter. Symbol wieloznaczny (*) i częściowe dopasowania nie są obsługiwane. Aby określić wartość parametru custom30, należy również określić wartość dla parametru custom29 w tym samym żądaniu, co jest spowodowane relacją nadrzędny-podrzędny. |
Wyszukiwanie użytkowników
Wyszukuje użytkowników aplikacji iManage Work spełniających określone kryteria wyszukiwania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wiadomości e-mail
|
string |
Określa identyfikator e-mail do wyszukania. Na przykład 'JSMITH@XYZ.COM'. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Zezwalaj na logowanie
|
data.topMatchingUser.allow_logon | boolean |
Wskazuje, czy użytkownik może się zalogować. |
|
Niestandardowy1
|
data.topMatchingUser.custom1 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Niestandardowy 2
|
data.topMatchingUser.custom2 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Niestandardowe 3
|
data.topMatchingUser.custom3 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Identyfikator katalogu
|
data.topMatchingUser.directory_id | string |
Wskazuje identyfikator z katalogu zewnętrznego (takiego jak ADFS), który jest używany do synchronizacji profilu użytkownika. |
|
Nazwa wyróżniająca
|
data.topMatchingUser.distinguished_name | string |
Wskazuje nazwę obiektu, który reprezentuje w pełni kwalifikowaną ścieżkę nazw, które śledzą wpis z powrotem do katalogu głównego drzewa LDAP. |
|
Edytuj datę
|
data.topMatchingUser.edit_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) najnowszej zmiany profilu użytkownika. |
|
Email
|
data.topMatchingUser.email | string |
Wskazuje identyfikator e-mail użytkownika. |
|
Adres URL automatycznego odnajdywania programu Exchange
|
data.topMatchingUser.exch_autodiscover | string |
Wskazuje szczegóły serwera wymiany użytkownika. |
|
Extension
|
data.topMatchingUser.extension | string |
Wskazuje rozszerzenie numeru telefonu użytkownika. |
|
Nieudane próby logowania
|
data.topMatchingUser.failed_logins | integer |
Wskazuje bieżącą liczbę nieudanych prób logowania użytkownika. |
|
Faks
|
data.topMatchingUser.fax | string |
Wskazuje numer faksu użytkownika. |
|
Wymuś zmianę hasła
|
data.topMatchingUser.force_password_change | boolean |
Wskazuje, że użytkownik musi zmienić swoje hasło podczas następnego logowania. Dotyczy tylko użytkowników wirtualnych wskazanych przez wartość "user_nos" "2". |
|
Pełna nazwa
|
data.topMatchingUser.full_name | string |
Wskazuje pełną nazwę użytkownika. |
|
General
|
data.topMatchingUser.general | string |
Wskazuje ogólne informacje o użytkowniku. |
|
identyfikator
|
data.topMatchingUser.id | string |
Wskazuje identyfikator użytkownika. Na przykład "JSMITH". |
|
Jest zewnętrzny
|
data.topMatchingUser.is_external | boolean |
Wskazuje użytkownika zewnętrznego. Użytkownik zewnętrzny ma ograniczony dostęp i jest często używany dla tymczasowych członków zespołu, konsultantów lub osób zewnętrznych w organizacji. |
|
Czas ostatniej synchronizacji
|
data.topMatchingUser.last_sync_ts | string |
Wskazuje czas ostatniej synchronizacji (w formacie DATY/godziny ISO 8601) profilu użytkownika z katalogiem zewnętrznym, takim jak LDAP lub Microsoft Active Directory (ADFS). |
|
Lokalizacja
|
data.topMatchingUser.location | string |
Wskazuje lokalizację geograficzną użytkownika. |
|
Hasło nigdy nie wygasa
|
data.topMatchingUser.password_never_expire | boolean |
Wskazuje, czy hasło użytkownika nigdy nie wygasa. |
|
Numer telefonu
|
data.topMatchingUser.phone | string |
Wskazuje numer telefonu użytkownika. |
|
Preferowana biblioteka
|
data.topMatchingUser.preferred_library | string |
Wskazuje preferowaną bibliotekę. Preferowaną biblioteką jest domyślna biblioteka użytkownika. Każdy użytkownik musi mieć jedną preferowaną bibliotekę. |
|
Czas zmiany hasła
|
data.topMatchingUser.pwd_changed_ts | string |
Wskazuje godzinę (w formacie daty/godziny iso 8601), kiedy hasło użytkownika zostało ostatnio zmienione. Dotyczy to tylko użytkowników wirtualnych (których użytkownik NOS ma wartość 2). |
|
SSID
|
data.topMatchingUser.ssid | string |
Wskazuje unikatowy identyfikator wygenerowany przez system dla użytkownika. |
|
Domena
|
data.topMatchingUser.user_domain | string |
Wskazuje w pełni kwalifikowaną nazwę domeny dla usługi katalogowej użytkownika. |
|
Identyfikator rozszerzony
|
data.topMatchingUser.user_id_ex | string |
Wskazuje oryginalną wartość identyfikatora użytkownika otrzymanego z katalogu zewnętrznego, takiego jak Microsoft Active Directory (ADFS). |
|
NOS
|
data.topMatchingUser.user_nos | integer |
Wskazuje typ systemu operacyjnego, z którego jest synchronizowany użytkownik. Możliwe wartości to 2 (użytkownik wirtualny) i 6 (użytkownik przedsiębiorstwa). Aby uzyskać więcej informacji, skontaktuj się z administratorem systemu roboczego iManage. |
|
Number
|
data.topMatchingUser.user_num | integer |
Wskazuje numeryczny identyfikator systemu użytkownika. |
|
results
|
data.results | array of UserProfileInArray |
Wyzwalaczy
| Dla wybranego dokumentu |
Ten wyzwalacz umożliwia uruchomienie przepływu pracy dla wybranego dokumentu w bibliotece iManage Work. Podaj nazwę wyświetlaną, która będzie wyświetlana użytkownikom w aplikacjach iManage Work. Jeśli ustawienie "Oczekiwanie na ukończenie" ma wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy" w przepływie pracy. W przeciwnym razie aplikacje w końcu upłynął limit czasu bez wskazania stanu ukończenia użytkownikowi. |
| Dla wybranego obszaru roboczego |
Ten wyzwalacz umożliwia uruchomienie przepływu pracy dla wybranego obszaru roboczego w bibliotece iManage Work. Podaj nazwę wyświetlaną, która będzie wyświetlana użytkownikom w aplikacjach iManage Work. Jeśli ustawienie "Oczekiwanie na ukończenie" ma wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy" w przepływie pracy. W przeciwnym razie aplikacje w końcu upłynął limit czasu bez wskazania stanu ukończenia użytkownikowi. |
| W przypadku wielu wybranych dokumentów |
Ten wyzwalacz umożliwia uruchomienie przepływu pracy dla co najmniej jednego wybranego dokumentu w aplikacji iManage Work. Podaj nazwę wyświetlaną, która będzie wyświetlana użytkownikom w aplikacjach iManage Work. Jeśli ustawienie "Oczekiwanie na ukończenie" ma wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy" w przepływie pracy. W przeciwnym razie aplikacje w końcu upłynął limit czasu bez wskazania stanu ukończenia użytkownikowi. |
| W przypadku wielu wybranych obszarów roboczych |
Ten wyzwalacz umożliwia uruchomienie przepływu pracy dla co najmniej jednego wybranego obszaru roboczego w aplikacji iManage Work. Podaj nazwę wyświetlaną, która będzie wyświetlana użytkownikom w aplikacjach iManage Work. Jeśli ustawienie "Oczekiwanie na ukończenie" ma wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy" w przepływie pracy. W przeciwnym razie aplikacje w końcu upłynął limit czasu bez wskazania stanu ukończenia użytkownikowi. (Dostępne tylko dla Power Automate.) |
Dla wybranego dokumentu
Ten wyzwalacz umożliwia uruchomienie przepływu pracy dla wybranego dokumentu w bibliotece iManage Work. Podaj nazwę wyświetlaną, która będzie wyświetlana użytkownikom w aplikacjach iManage Work. Jeśli ustawienie "Oczekiwanie na ukończenie" ma wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy" w przepływie pracy. W przeciwnym razie aplikacje w końcu upłynął limit czasu bez wskazania stanu ukończenia użytkownikowi.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa wyświetlana przepływu pracy
|
workflowName | True | string |
Określa nazwę wyświetlaną przepływu pracy, który będzie widoczny dla użytkowników aplikacji iManage Work. |
|
Description
|
description | True | string |
Określa opis przepływu pracy. |
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki, w której jest dostępny przepływ pracy. |
|
Identyfikator formularza
|
formId | True | string |
Określa identyfikator formularza, który jest prezentowany użytkownikowi w celu zbierania danych wejściowych używanych przez przepływ pracy. |
|
Identyfikator folderu powrotnego
|
inferFolderId | True | boolean |
Określa, czy identyfikator folderu dokumentu jest wymagany przez przepływ pracy. |
|
Dostępne dla użytkowników
|
users | string |
Określa co najmniej jeden identyfikator użytkownika oddzielony średnikami, do których jest dostępny przepływ pracy. |
|
|
Dostępne dla grup
|
groups | string |
Określa co najmniej jeden identyfikator grupy oddzielony średnikami, do których jest dostępny przepływ pracy. |
|
|
Dostępne w obszarach roboczych
|
workspaces | string |
Określa co najmniej jeden identyfikator obszaru roboczego oddzielony średnikami, w którym jest dostępny przepływ pracy. |
|
|
Klasy dokumentów
|
classes | string |
Określa co najmniej jeden identyfikator klasy dokumentu oddzielony średnikami, dla których jest dostępny przepływ pracy. |
|
|
Poczekaj na ukończenie
|
waitForCompletion | boolean |
Określa, czy aplikacje oczekują na ukończenie wykonywania przepływu pracy. Jeśli ustawiono wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy". |
Zwraca
Dla wybranego obszaru roboczego
Ten wyzwalacz umożliwia uruchomienie przepływu pracy dla wybranego obszaru roboczego w bibliotece iManage Work. Podaj nazwę wyświetlaną, która będzie wyświetlana użytkownikom w aplikacjach iManage Work. Jeśli ustawienie "Oczekiwanie na ukończenie" ma wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy" w przepływie pracy. W przeciwnym razie aplikacje w końcu upłynął limit czasu bez wskazania stanu ukończenia użytkownikowi.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa wyświetlana przepływu pracy
|
workflowName | True | string |
Określa nazwę wyświetlaną przepływu pracy, który będzie widoczny dla użytkowników aplikacji iManage Work. |
|
Description
|
description | True | string |
Określa opis przepływu pracy. |
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki, w której jest dostępny przepływ pracy. |
|
Identyfikator formularza
|
formId | True | string |
Określa identyfikator formularza, który jest prezentowany użytkownikowi w celu zbierania danych wejściowych używanych przez przepływ pracy. |
|
Dostępne dla użytkowników
|
users | string |
Określa co najmniej jeden identyfikator użytkownika oddzielony średnikami, do których jest dostępny przepływ pracy. |
|
|
Dostępne dla grup
|
groups | string |
Określa co najmniej jeden identyfikator grupy oddzielony średnikami, do których jest dostępny przepływ pracy. |
|
|
Poczekaj na ukończenie
|
waitForCompletion | boolean |
Określa, czy aplikacje oczekują na ukończenie wykonywania przepływu pracy. Jeśli ustawiono wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy". |
Zwraca
W przypadku wielu wybranych dokumentów
Ten wyzwalacz umożliwia uruchomienie przepływu pracy dla co najmniej jednego wybranego dokumentu w aplikacji iManage Work. Podaj nazwę wyświetlaną, która będzie wyświetlana użytkownikom w aplikacjach iManage Work. Jeśli ustawienie "Oczekiwanie na ukończenie" ma wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy" w przepływie pracy. W przeciwnym razie aplikacje w końcu upłynął limit czasu bez wskazania stanu ukończenia użytkownikowi.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa wyświetlana przepływu pracy
|
workflowName | True | string |
Określa nazwę wyświetlaną przepływu pracy, który będzie widoczny dla użytkowników aplikacji iManage Work. |
|
Description
|
description | True | string |
Określa opis przepływu pracy. |
|
Identyfikator biblioteki
|
libraryId | True | string |
Określa identyfikator biblioteki, w której jest dostępny przepływ pracy. |
|
Identyfikator formularza
|
formId | True | string |
Określa identyfikator formularza, który jest prezentowany użytkownikowi w celu zbierania danych wejściowych używanych przez przepływ pracy. |
|
Identyfikator folderu powrotnego
|
inferFolderId | True | boolean |
Określa, czy identyfikator folderu dokumentu jest wymagany przez przepływ pracy. |
|
Dostępne dla użytkowników
|
users | string |
Określa co najmniej jeden identyfikator użytkownika oddzielony średnikami, do których jest dostępny przepływ pracy. |
|
|
Dostępne dla grup
|
groups | string |
Określa co najmniej jeden identyfikator grupy oddzielony średnikami, do których jest dostępny przepływ pracy. |
|
|
Poczekaj na ukończenie
|
waitForCompletion | boolean |
Określa, czy aplikacje oczekują na ukończenie wykonywania przepływu pracy. Jeśli ustawiono wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy". |
Zwraca
W przypadku wielu wybranych obszarów roboczych
Ten wyzwalacz umożliwia uruchomienie przepływu pracy dla co najmniej jednego wybranego obszaru roboczego w aplikacji iManage Work. Podaj nazwę wyświetlaną, która będzie wyświetlana użytkownikom w aplikacjach iManage Work. Jeśli ustawienie "Oczekiwanie na ukończenie" ma wartość "Tak", musisz użyć akcji "Aktualizuj stan przepływu pracy" w przepływie pracy. W przeciwnym razie aplikacje w końcu upłynął limit czasu bez wskazania stanu ukończenia użytkownikowi. (Dostępne tylko dla Power Automate.)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | object |
Definicje
MinimalDocumentProfileInArray
Wskazuje profil każdej wersji dokumentu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Author
|
author | string |
Wskazuje identyfikator użytkownika, który utworzył dokument. Na przykład "JSMITH". |
|
Opis autora
|
author_description | string |
Wskazuje dodatkowe informacje o autorze dokumentu. |
|
Podstawowe właściwości dokumentu
|
basic_properties | string |
Wskazuje osadzony element "", który zawiera podstawowe właściwości dokumentu. |
|
Klasa dokumentu
|
class | string |
Wskazuje klasę dokumentu. |
|
Comment
|
comment | string |
Wskazuje dodatkowe informacje o dokumencie. |
|
Typ zawartości
|
content_type | string |
Wskazuje typ zawartości dokumentu. |
|
Data utworzenia dokumentu
|
create_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601), który dokument został zaimportowany do systemu iManage Work. Ta data może być inna niż "file_create_date". |
|
Niestandardowy1
|
custom1 | string |
Wskazuje wartość custom1. |
|
Opis niestandardowy1
|
custom1_description | string |
Wskazuje dodatkowe informacje o właściwości custom1. |
|
Niestandardowy 2
|
custom2 | string |
Wskazuje wartość custom2. |
|
Opis niestandardowy2
|
custom2_description | string |
Wskazuje dodatkowe informacje o właściwości custom2. |
|
Niestandardowe 3
|
custom3 | string |
Wskazuje wartość custom3. |
|
Opis niestandardowy3
|
custom3_description | string |
Wskazuje dodatkowe informacje o właściwości custom3. |
|
Niestandardowe4
|
custom4 | string |
Wskazuje wartość custom4. |
|
Opis niestandardowy4
|
custom4_description | string |
Wskazuje dodatkowe informacje o właściwości custom4. |
|
Niestandardowy5
|
custom5 | string |
Wskazuje wartość custom5. |
|
Opis niestandardowy5
|
custom5_description | string |
Wskazuje dodatkowe informacje o właściwości custom5. |
|
Niestandardowa 6
|
custom6 | string |
Wskazuje wartość custom6. |
|
Opis niestandardowy6
|
custom6_description | string |
Wskazuje dodatkowe informacje o właściwości custom6. |
|
Niestandardowy7
|
custom7 | string |
Wskazuje wartość custom7. |
|
Opis niestandardowy7
|
custom7_description | string |
Wskazuje dodatkowe informacje o właściwości custom7. |
|
Niestandardowe8
|
custom8 | string |
Wskazuje wartość custom8. |
|
Opis niestandardowy8
|
custom8_description | string |
Wskazuje dodatkowe informacje o właściwości custom8. |
|
Niestandardowa 9
|
custom9 | string |
Wskazuje wartość custom9. |
|
Opis niestandardowy9
|
custom9_description | string |
Wskazuje dodatkowe informacje o właściwości custom9. |
|
Niestandardowa 10
|
custom10 | string |
Wskazuje wartość custom10. |
|
Opis niestandardowy10
|
custom10_description | string |
Wskazuje dodatkowe informacje o właściwości custom10. |
|
Niestandardowa 11
|
custom11 | string |
Wskazuje wartość custom11. |
|
Opis niestandardowy11
|
custom11_description | string |
Wskazuje dodatkowe informacje o właściwości custom11. |
|
Niestandardowy 12
|
custom12 | string |
Wskazuje wartość custom12. |
|
Opis niestandardowy12
|
custom12_description | string |
Wskazuje dodatkowe informacje o właściwości custom12. |
|
Niestandardowa 13
|
custom13 | string |
Wskazuje wartość parametru custom13. |
|
Niestandardowe 14
|
custom14 | string |
Wskazuje wartość custom14. |
|
Niestandardowy 15
|
custom15 | string |
Wskazuje wartość custom15. |
|
Niestandardowa 16
|
custom16 | string |
Wskazuje wartość custom16. |
|
Niestandardowa 17
|
custom17 | double |
Wskazuje wartość custom17. |
|
Niestandardowy18
|
custom18 | double |
Wskazuje wartość custom18. |
|
Niestandardowa 19
|
custom19 | double |
Wskazuje wartość custom19. |
|
Niestandardowe 20
|
custom20 | double |
Wskazuje wartość custom20. |
|
Niestandardowy 21
|
custom21 | string |
Wskazuje wartość właściwości custom21 w formacie daty/godziny ISO 8601. |
|
Niestandardowe 22
|
custom22 | string |
Wskazuje wartość właściwości custom22 w formacie daty/godziny ISO 8601. |
|
Niestandardowe 23
|
custom23 | string |
Wskazuje wartość właściwości custom23 w formacie daty/godziny ISO 8601. |
|
Niestandardowe 24
|
custom24 | string |
Wskazuje wartość właściwości custom24 w formacie daty/godziny ISO 8601. |
|
Niestandardowe 25
|
custom25 | boolean |
Wskazuje wartość custom25. |
|
Niestandardowe 26
|
custom26 | boolean |
Wskazuje wartość custom26. |
|
Niestandardowe 27
|
custom27 | boolean |
Wskazuje wartość custom27. |
|
Niestandardowe 28
|
custom28 | boolean |
Wskazuje wartość custom28. |
|
Niestandardowy 29
|
custom29 | string |
Wskazuje wartość custom29. |
|
Opis niestandardowy29
|
custom29_description | string |
Wskazuje dodatkowe informacje o właściwości custom29. |
|
Niestandardowa 30
|
custom30 | string |
Wskazuje wartość custom30. |
|
Opis niestandardowy30
|
custom30_description | string |
Wskazuje dodatkowe informacje o właściwości custom30. |
|
Baza danych
|
database | string |
Wskazuje bibliotekę, w której jest przechowywany dokument. |
|
Zabezpieczenia domyślne dokumentu
|
default_security | string |
Wskazuje domyślny poziom dostępu do zabezpieczeń. Możliwe wartości to "inherit", "private", "view", "public". |
|
Numer dokumentu
|
document_number | integer |
Wskazuje numer dokumentu. |
|
Adres URL dokumentu
|
document_url | string |
Wskazuje link do udostępniania dokumentu. |
|
Data edycji dokumentu
|
edit_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) najnowszej zmiany dokumentu. |
|
Data edycji profilu
|
edit_profile_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) najnowszej zmiany profilu dokumentu. |
|
Rozszerzenie dokumentu
|
extension | string |
Wskazuje rozszerzenie nazwy pliku, nazywane również rozszerzeniem aplikacji dokumentu. |
|
Pełna nazwa pliku
|
full_file_name | string |
Wskazuje pełną nazwę pliku dokumentu. Zawiera rozszerzenie nazwy pliku. |
|
Identyfikator dokumentu
|
id | string |
Wskazuje identyfikator dokumentu. Na przykład "ACTIVE_US!453.1". |
|
Jest indeksowalny
|
indexable | boolean |
Wskazuje, czy dokument jest indeksowany przez system. |
|
Jest wyewidencjonowany
|
is_checked_out | boolean |
Wskazuje, czy dokument jest wyewidencjonowany. |
|
Jest zadeklarowany
|
is_declared | boolean |
Wskazuje, czy dokument jest zadeklarowany jako rekord. Nie można edytować ani usuwać dokumentu zadeklarowanego jako rekord, z wyjątkiem administratora systemu pracy iManage. |
|
Jest zewnętrzny
|
is_external | boolean |
Wskazuje, czy dokument jest udostępniany użytkownikom zewnętrznym. |
|
Jest HIPAA
|
is_hipaa | boolean |
Wskazuje, czy dokument jest zaszyfrowany. |
|
Jest w użyciu
|
is_in_use | boolean |
Wskazuje, czy dokument jest używany. |
|
Łącze dokumentu
|
iwl | string |
Wskazuje link iManage Work Link (iWL) dla dokumentu. Biblioteka iWL służy do otwierania dokumentu w trybie widoku chronionego przez użytkownika, który ma "read_write" lub "full_access". |
|
Ostatni użytkownik
|
last_user | string |
Wskazuje identyfikator użytkownika, który ostatnio edytował dokument. Na przykład "JSMITH". |
|
Opis ostatniego użytkownika
|
last_user_description | string |
Wskazuje dodatkowe informacje o ostatnim użytkowniku, który ostatnio edytował dokument. |
|
Nazwa dokumentu
|
name | string |
Wskazuje nazwę pliku dokumentu. |
|
Operator
|
operator | string |
Wskazuje identyfikator użytkownika, który ma wyewidencjonowany dokument lub obecnie edytuje swój profil. Na przykład "JSMITH". |
|
Opis operatora
|
operator_description | string |
Wskazuje dodatkowe informacje o operatorze. |
|
Jest powiązany
|
is_related | boolean |
Wskazuje, czy dokument jest powiązany z innym dokumentem. |
|
Rozmiar dokumentu
|
size | integer |
Wskazuje rozmiar dokumentu w bajtach. |
|
Typ
|
type | string |
Wskazuje typ dokumentu. Na przykład WORD dla programu Microsoft Word. Aby uzyskać bieżącą listę typów, skontaktuj się z administratorem systemu pracy iManage. |
|
Wersja dokumentu
|
version | integer |
Wskazuje numer wersji dokumentu. |
|
Wstype
|
wstype | string |
Wskazuje typ pracy iManage obiektu. Możliwe wartości to "document", "folder", "workspace", "email", "document_shortcut", "folder_shortcut", "workspace_shortcut", "user". |
Profil użytkownika
Wskazuje informacje o użytkowniku.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Zezwalaj na logowanie
|
allow_logon | boolean |
Wskazuje, czy użytkownik może się zalogować. |
|
Niestandardowy1
|
custom1 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Niestandardowy 2
|
custom2 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Niestandardowe 3
|
custom3 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Identyfikator katalogu
|
directory_id | string |
Wskazuje identyfikator z katalogu zewnętrznego (takiego jak ADFS), który jest używany do synchronizacji profilu użytkownika. |
|
Nazwa wyróżniająca
|
distinguished_name | string |
Wskazuje nazwę obiektu, który reprezentuje w pełni kwalifikowaną ścieżkę nazw, które śledzą wpis z powrotem do katalogu głównego drzewa LDAP. |
|
Edytuj datę
|
edit_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) najnowszej zmiany profilu użytkownika. |
|
Email
|
string |
Wskazuje identyfikator e-mail użytkownika. |
|
|
Adres URL automatycznego odnajdywania programu Exchange
|
exch_autodiscover | string |
Wskazuje szczegóły serwera wymiany użytkownika. |
|
Extension
|
extension | string |
Wskazuje rozszerzenie numeru telefonu użytkownika. |
|
Nieudane próby logowania
|
failed_logins | integer |
Wskazuje bieżącą liczbę nieudanych prób logowania użytkownika. |
|
Faks
|
fax | string |
Wskazuje numer faksu użytkownika. |
|
Wymuś zmianę hasła
|
force_password_change | boolean |
Wskazuje, że użytkownik musi zmienić swoje hasło podczas następnego logowania. Dotyczy tylko użytkowników wirtualnych wskazanych przez wartość "user_nos" "2". |
|
Pełna nazwa
|
full_name | string |
Wskazuje pełną nazwę użytkownika. |
|
General
|
general | string |
Wskazuje ogólne informacje o użytkowniku. |
|
Identyfikator użytkownika
|
id | string |
Wskazuje identyfikator użytkownika. Na przykład "JSMITH". |
|
Jest użytkownikiem zewnętrznym
|
is_external | boolean |
Wskazuje użytkownika zewnętrznego. Użytkownik zewnętrzny ma ograniczony dostęp i jest często używany dla tymczasowych członków zespołu, konsultantów lub osób zewnętrznych w organizacji. |
|
Czas ostatniej synchronizacji
|
last_sync_ts | string |
Wskazuje czas ostatniej synchronizacji (w formacie DATY/godziny ISO 8601) profilu użytkownika z katalogiem zewnętrznym, takim jak LDAP lub Microsoft Active Directory (ADFS). |
|
Lokalizacja
|
location | string |
Wskazuje lokalizację geograficzną użytkownika. |
|
Hasło nigdy nie wygasa
|
password_never_expire | boolean |
Wskazuje, czy hasło użytkownika nigdy nie wygasa. |
|
Numer telefonu
|
phone | string |
Wskazuje numer telefonu użytkownika. |
|
Preferowana biblioteka
|
preferred_library | string |
Wskazuje preferowaną bibliotekę. Preferowaną biblioteką jest domyślna biblioteka użytkownika. Każdy użytkownik musi mieć jedną preferowaną bibliotekę. |
|
Czas zmiany hasła
|
pwd_changed_ts | string |
Wskazuje godzinę (w formacie daty/godziny iso 8601), kiedy hasło użytkownika zostało ostatnio zmienione. Dotyczy to tylko użytkowników wirtualnych (których użytkownik NOS ma wartość 2). |
|
SSID
|
ssid | string |
Wskazuje unikatowy identyfikator wygenerowany przez system dla użytkownika. |
|
Domena użytkownika
|
user_domain | string |
Wskazuje w pełni kwalifikowaną nazwę domeny dla usługi katalogowej użytkownika. |
|
Rozszerzony identyfikator użytkownika
|
user_id_ex | string |
Wskazuje oryginalną wartość identyfikatora użytkownika otrzymanego z katalogu zewnętrznego, takiego jak Microsoft Active Directory (ADFS). |
|
Użytkownik NOS
|
user_nos | integer |
Wskazuje typ systemu operacyjnego, z którego jest synchronizowany użytkownik. Możliwe wartości to 2 (użytkownik wirtualny) i 6 (użytkownik przedsiębiorstwa). Aby uzyskać więcej informacji, skontaktuj się z administratorem systemu roboczego iManage. |
|
Numer użytkownika
|
user_num | integer |
Wskazuje numeryczny identyfikator systemu użytkownika. |
UserProfileInArray
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Zezwalaj na logowanie
|
allow_logon | boolean |
Wskazuje, czy użytkownik może się zalogować. |
|
Niestandardowy1
|
custom1 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Niestandardowy 2
|
custom2 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Niestandardowe 3
|
custom3 | string |
Wskazuje dodatkowe informacje o użytkowniku. |
|
Identyfikator katalogu
|
directory_id | string |
Wskazuje identyfikator z katalogu zewnętrznego (takiego jak ADFS), który jest używany do synchronizacji profilu użytkownika. |
|
Nazwa wyróżniająca
|
distinguished_name | string |
Wskazuje nazwę obiektu, który reprezentuje w pełni kwalifikowaną ścieżkę nazw, które śledzą wpis z powrotem do katalogu głównego drzewa LDAP. |
|
Edytuj datę
|
edit_date | string |
Wskazuje datę i godzinę (w formacie ISO 8601) najnowszej zmiany profilu użytkownika. |
|
Email
|
string |
Wskazuje identyfikator e-mail użytkownika. |
|
|
Adres URL automatycznego odnajdywania programu Exchange
|
exch_autodiscover | string |
Wskazuje szczegóły serwera wymiany użytkownika. |
|
Extension
|
extension | string |
Wskazuje rozszerzenie numeru telefonu użytkownika. |
|
Nieudane próby logowania
|
failed_logins | integer |
Wskazuje bieżącą liczbę nieudanych prób logowania użytkownika. |
|
Faks
|
fax | string |
Wskazuje numer faksu użytkownika. |
|
Wymuś zmianę hasła
|
force_password_change | boolean |
Wskazuje, że użytkownik musi zmienić swoje hasło podczas następnego logowania. Dotyczy tylko użytkowników wirtualnych wskazanych przez wartość "user_nos" "2". |
|
Pełna nazwa
|
full_name | string |
Wskazuje pełną nazwę użytkownika. |
|
General
|
general | string |
Wskazuje ogólne informacje o użytkowniku. |
|
identyfikator
|
id | string |
Wskazuje identyfikator użytkownika. Na przykład "JSMITH". |
|
Jest użytkownikiem zewnętrznym
|
is_external | boolean |
Wskazuje użytkownika zewnętrznego. Użytkownik zewnętrzny ma ograniczony dostęp i jest często używany dla tymczasowych członków zespołu, konsultantów lub osób zewnętrznych w organizacji. |
|
Czas ostatniej synchronizacji
|
last_sync_ts | string |
Wskazuje czas ostatniej synchronizacji (w formacie DATY/godziny ISO 8601) profilu użytkownika z katalogiem zewnętrznym, takim jak LDAP lub Microsoft Active Directory (ADFS). |
|
Lokalizacja
|
location | string |
Wskazuje lokalizację geograficzną użytkownika. |
|
Hasło nigdy nie wygasa
|
password_never_expire | boolean |
Wskazuje, czy hasło użytkownika nigdy nie wygasa. |
|
Numer telefonu
|
phone | string |
Wskazuje numer telefonu użytkownika. |
|
Preferowana biblioteka
|
preferred_library | string |
Wskazuje preferowaną bibliotekę. Preferowaną biblioteką jest domyślna biblioteka użytkownika. Każdy użytkownik musi mieć jedną preferowaną bibliotekę. |
|
Czas zmiany hasła
|
pwd_changed_ts | string |
Wskazuje godzinę (w formacie daty/godziny iso 8601), kiedy hasło użytkownika zostało ostatnio zmienione. Dotyczy to tylko użytkowników wirtualnych (których użytkownik NOS ma wartość 2). |
|
SSID
|
ssid | string |
Wskazuje unikatowy identyfikator wygenerowany przez system dla użytkownika. |
|
Domena
|
user_domain | string |
Wskazuje w pełni kwalifikowaną nazwę domeny dla usługi katalogowej użytkownika. |
|
Rozszerzony identyfikator użytkownika
|
user_id_ex | string |
Wskazuje oryginalną wartość identyfikatora użytkownika otrzymanego z katalogu zewnętrznego, takiego jak Microsoft Active Directory (ADFS). |
|
NOS
|
user_nos | integer |
Wskazuje typ systemu operacyjnego, z którego jest synchronizowany użytkownik. Możliwe wartości to 2 (użytkownik wirtualny) i 6 (użytkownik przedsiębiorstwa). Aby uzyskać więcej informacji, skontaktuj się z administratorem systemu roboczego iManage. |
|
Number
|
user_num | integer |
Wskazuje numeryczny identyfikator systemu użytkownika. |
TaksonomiaNodeValue
Wskazuje każdą wartość węzła taksonomii.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
SSID
|
created_by.ssid | string |
Wskazuje unikatowy, wygenerowany przez system identyfikator użytkownika, który utworzył wartość węzła. |
|
Data utworzenia
|
create_date | date-time |
Wskazuje datę i godzinę (w formacie ISO 8601) utworzoną wartość węzła. |
|
Description
|
description | string |
Wskazuje opis wartości węzła. |
|
SSID
|
edited_by.ssid | string |
Wskazuje unikatowy, wygenerowany przez system identyfikator użytkownika, który ostatnio edytował wartość węzła. |
|
Edytuj datę
|
edit_date | date-time |
Wskazuje datę i godzinę (w formacie ISO 8601) ostatnio edytowaną wartość węzła. |
|
Jest włączona
|
enabled | boolean |
Wskazuje, czy wartość węzła jest włączona. |
|
identyfikator
|
id | string |
Wskazuje identyfikator wyświetlania wartości węzła. |
|
SSID
|
parent.ssid | string |
Wskazuje unikatowy identyfikator generowany przez system dla natychmiastowego węzła nadrzędnego. |
|
SSID
|
ssid | string |
Wskazuje unikatowy identyfikator wygenerowany przez system dla wartości węzła. |
|
Ścieżka
|
path | array of object |
Wskazuje pełną ścieżkę do wartości węzła. Ścieżka to uporządkowana lista rozpoczynająca się od węzła najwyższego poziomu w taksonomii, a następnie wszystkich węzłów do bezpośredniego nadrzędnego węzła pasującego. |
|
Każdy identyfikator
|
path.id | string |
Wskazuje identyfikator wyświetlania wartości węzła w ścieżce. |
|
Każdy identyfikator SSID
|
path.ssid | string |
Wskazuje unikatowy identyfikator wygenerowany przez system dla wartości węzła w ścieżce. |
UpdatePermissionsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Domyślne zabezpieczenia
|
data.default_security | string |
Wskazuje domyślne zabezpieczenia obiektu. Możliwe wartości to "dziedzicz", "publiczny", "widok" lub "prywatny". |
|
Uprawnienia dostępu
|
data.acl | AccessPermissions |
Wskazuje kolekcję uprawnień dostępu dla co najmniej jednego użytkownika i/lub grup. |
|
Wszystkie identyfikatory użytkowników
|
data.all_user_ids | string |
Wskazuje listę wszystkich identyfikatorów użytkowników, połączonych jako ciąg i oddzielonych średnikami. |
|
Wszystkie identyfikatory grup
|
data.all_group_ids | string |
Wskazuje listę wszystkich identyfikatorów grup, połączonych jako ciąg i rozdzielonych średnikami. |
AccessPermissions
Wskazuje kolekcję uprawnień dostępu dla co najmniej jednego użytkownika i/lub grup.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa trustee
|
name | string |
Wskazuje nazwę zaufania. |
|
Identyfikator zaufania
|
id | string |
Wskazuje identyfikator zaufania. Może to być identyfikator użytkownika lub identyfikator grupy. |
|
Identyfikator SID zaufania
|
sid | string |
Wskazuje identyfikator zabezpieczeń użytkownika lub grupy. |
|
Typ zaufania
|
type | string |
Wskazuje zwracany typ zaufania. Możliwe wartości to "użytkownik" lub "grupa". |
|
Poziom dostępu
|
access_level | string |
Wskazuje uprawnienie dostępu, które użytkownik lub grupa ma w obiekcie. Możliwe wartości to "no_access", "read", "read_write" lub "full_access". |
|
Nazwa wyświetlana na poziomie dostępu
|
access_level_display_name | string |
Wskazuje nazwę wyświetlaną na poziomie dostępu czytelnym dla człowieka przypisaną do użytkownika lub grupy dla tego obiektu. Możliwe wartości to "Brak dostępu", "Tylko do odczytu", "Odczyt/zapis" lub "Pełny dostęp". |
|
Access
|
access | integer |
Wskazuje wartość liczbową uprawnienia dostępu, które użytkownik lub grupa ma w obiekcie. Możliwe wartości to 0 (no_access), 1 (odczyt), 2 (read_write) lub 3 (full_access). |
|
Jest zewnętrzny
|
is_external | boolean |
Wskazuje, czy użytkownik jest użytkownikiem zewnętrznym, czy też grupa jest ograniczona do użytkowników zewnętrznych. |
|
Zezwalaj na logowanie
|
allow_logon | boolean |
Wskazuje, czy użytkownik może się zalogować. Nie dotyczy grup. |
|
Jest włączona
|
enabled | boolean |
Wskazuje, czy grupa jest włączona. Nie dotyczy użytkowników. |
|
Ma ograniczony element członkowski
|
has_restricted_member | boolean |
Wskazuje, czy grupa ma co najmniej jednego użytkownika z dostępem do tego obiektu odrzuconego przez menedżera zasad zabezpieczeń iManage. |
obiekt
Jest to typ 'obiekt'.
binarny
Jest to podstawowy typ danych "binary".