DocuWare
Uzyskaj dostęp do typowych funkcji oprogramowania DocuWare z poziomu przepływów.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | DocuWare GmbH |
| adres URL | https://support.docuware.com |
| support@docuware.com |
| Metadane łącznika | |
|---|---|
| Publisher | DocuWare |
| Witryna internetowa | https://start.docuware.com |
| Zasady ochrony prywatności | https://start.docuware.com/data-privacy |
| Kategorie | Zawartość i pliki; Produktywność |
Oprogramowanie DocuWare udostępnia zaawansowany i rozbudowany interfejs API REST. Dzięki łącznikowi usługi Power Automate oprogramowania DocuWare użytkownicy mogą teraz korzystać z wielu najczęściej używanych funkcji interfejsu API REST oprogramowania DocuWare w usłudze Power Automate. Dzięki bezproblemowej integracji z aplikacją DocuWare użytkownik może tworzyć przepływy, które w pełni zaspokajają ich potrzeby biznesowe.
Wymagania wstępne
Aby kontynuować, musisz wykonać następujące czynności:
- Subskrypcja usługi DocuWare Cloud
- Konto usługi Microsoft Power Apps lub Power Automate
Jak uzyskać poświadczenia
Tworzenie nowego klucza interfejsu API jest łatwe i można je wykonać z poziomu oprogramowania DocuWare.
Wykonaj następujące kroki, aby utworzyć nowy klucz interfejsu API w usłudze DocuWare:
- Zaloguj się do konta usługi DocuWare, którego chcesz używać z usługą Power Automate
- W menu głównym przejdź do pozycji "Konfiguracje"
- Na stronie "Konfiguracje" przejdź do sekcji "Integracje" i kliknij ikonę "Klucze interfejsu API usługi Power Automate"
- Jeśli nie widzisz ikony "Klucze interfejsu API usługi Power Automate", możliwe, że użytkownik nie ma odpowiednich uprawnień. Skontaktuj się z administratorem aplikacji DocuWare, aby rozwiązać ten problem.
- Kliknij przycisk "Utwórz klucz interfejsu API"
- Wypełnij wartości "Name" i "Description" (opcjonalnie), a następnie kliknij pozycję "Utwórz"
- Po naciśnięciu "Utwórz" może wystąpić niewielkie opóźnienie, ponieważ proces konfiguracji tworzy klucz.
- Pamiętaj również, aby zapisać klucz interfejsu API. Będzie to jedyna okazja do wyświetlenia pełnego klucza interfejsu API. Jeśli utracisz ten klucz, musisz utworzyć inny klucz.
W tym momencie masz teraz prawidłowy klucz interfejsu API, którego można użyć w usłudze Power Automate do utworzenia połączenia z oprogramowaniem DocuWare. To połączenie może być następnie używane z łącznikiem Usługi Power Automate programu DocuWare.
Wprowadzenie do łącznika
Tworzenie połączenia w usłudze Power Automate jest łatwe i można to zrobić podczas tworzenia przepływów.
Wykonaj następujące kroki, aby utworzyć nowe połączenie w usłudze Power Automate:
- Logowanie do usługi Power Automate
- Tworzenie nowego przepływu lub otwieranie istniejącego przepływu
- Dodawanie działania z łącznika DocuWare Power Automate do przepływu
- Kliknij pozycję "+ Nowy krok", aby dodać nowy krok do przepływu
- Po wyświetleniu polecenia "Wybierz operację" wybierz pozycję "Wszystkie" z zaznaczenia kategorii, a następnie wpisz "DocuWare" w polu wyszukiwania.
- Wybierz łącznik "DocuWare", a następnie wybierz z listy dostępnych akcji.
- Po dodaniu akcji do przepływu zostanie wyświetlony monit o utworzenie nowego połączenia.
- Wprowadź nazwę połączenia ("Nazwa połączenia") i klucz interfejsu API ("Klucz interfejsu API") otrzymany z oprogramowania DocuWare w poprzedniej sekcji i kliknij przycisk "Utwórz".
Od tego momentu wszystkie działania dodane z łącznika docuWare będą używać tego połączenia. Możesz utworzyć dodatkowe połączenia, klikając przycisk "..." w prawym górnym rogu działania, a następnie kliknij pozycję "+ Dodaj nowe połączenie" w dolnej części wyświetlonego menu.
Znane problemy i ograniczenia
Obecnie łącznik usługi Power Automate programu DocuWare nie jest obsługiwany w nowym projektancie usługi Power Automate Flow.
Typowe błędy i środki zaradcze
Kody błędów HTTP:
- 400: Upewnij się, że wszystkie wymagane pola zostały wypełnione w działaniu. Niektóre pola są wymagane i muszą zostać wypełnione przed uruchomieniem działania.
- 401: Upewnij się, że wprowadzono prawidłowy klucz interfejsu API. Stan klucza interfejsu API można również sprawdzić na stronie "Konfiguracje" w obszarze "Integracje" —> "Klucze interfejsu API usługi Power Automate".
- 404: Upewnij się, że określony dokument i/lub plik cabinet istnieją i czy masz do nich dostęp. Jeśli dokument lub szafa plików nie istnieją lub nie masz do nich dostępu, zostanie wyświetlony błąd 404.
- 500: Jest to ogólny błąd, który może być spowodowany przez wiele różnych problemów. Jeśli wystąpi ten błąd, skontaktuj się z pomocą techniczną oprogramowania DocuWare, aby uzyskać pomoc.
Często zadawane pytania
Najlepsze praktyki
Poniżej przedstawiono niektóre z najlepszych rozwiązań, które zalecamy w przypadku korzystania z łącznika DocuWare Power Automate:
- Zawsze używaj dedykowanego użytkownika oprogramowania DocuWare do uwierzytelniania za pomocą łącznika usługi DocuWare Power Automate. Umożliwi to łatwe śledzenie akcji wykonywanych przez łącznik i zarządzanie nimi.
- Zacznij od przetestowania przepływu za pomocą działania "Pobierz organizację". Jest to najbardziej podstawowa akcja podana w łączniku usługi Power Automate oprogramowania DocuWare i umożliwi sprawdzenie, czy połączenie działa prawidłowo.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| klucz interfejsu API | securestring | Klucz interfejsu API do uzyskiwania dostępu do oprogramowania DocuWare | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie pól indeksu |
Aktualizuje pola indeksu dokumentu. |
| Dołączanie pliku |
Dołącza plik/sekcję do istniejącego dokumentu. |
| Importowanie do zasobnika dokumentu |
Zaimportuj nowy dokument do zasobnika dokumentu. |
| Pobieranie dokumentu |
Pobiera dokument z szafy plików lub zasobnika dokumentu. |
| Pobieranie informacji o dokumencie |
Pobiera informacje o dokumencie. |
| Pobieranie okien dialogowych |
Pobiera listę okien dialogowych dla szafki plików lub zasobnika dokumentu. |
| Pobieranie pliku |
Pobiera plik/sekcję dokumentu przechowywanego w szafie plików lub zasobniku dokumentów. |
| Pobieranie pól okna dialogowego |
Pobiera pola dla okna dialogowego |
| Pobieranie pól pliku cabinet |
Pobiera listę pól dla pliku cabinet. |
| Pobieranie pól sygnatury |
Pobiera listę pól dla sygnatury. |
| Pobieranie sygnatur |
Pobiera listę sygnatur dla szafki plików lub zasobnika dokumentów. |
| Pobieranie szaf plików i zasobników dokumentów |
Pobiera listę szaf plików i/lub zasobników dokumentów. |
| Przechowywanie w szafie plików |
Przechowuje nowy dokument w szafie plików. |
| Przenoszenie dokumentów |
Przenosi jeden lub więcej dokumentów z jednego zasobnika pliku/dokumentu do innego. |
| Umieszczanie sygnatury |
Umieszcza sygnaturę w dokumencie. |
| Usuwanie dokumentu |
Usuwa dokument z szafy plików lub zasobnika dokumentu. |
| Usuwanie pliku |
Usuwa plik/sekcję z istniejącego dokumentu. |
| Uzyskiwanie organizacji |
Pobierz nazwę organizacji. |
| Wyszukiwanie w pliku cabinet |
Wyszukaj plik cabinet pod kątem dokumentów spełniających określone kryteria. |
| Wyświetlanie listy dokumentów w zasobniku dokumentów |
Wyświetl listę dokumentów z określonego zasobnika dokumentu. |
| Zastępowanie pliku |
Zastępuje plik/sekcję w istniejącym dokumencie. |
Aktualizowanie pól indeksu
Aktualizuje pola indeksu dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Plik Cabinet
|
FileCabinetID | True | string |
Wybierz plik Cabinet z dokumentem, aby go zaktualizować. |
|
Identyfikator dokumentu
|
DocumentID | True | integer |
Określ identyfikator dokumentu do zaktualizowania. |
|
Name
|
Name | string |
Wybierz lub określ pole indeksu. |
|
|
Wartość
|
Value | string |
Określ wartość indeksu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sekcje
|
Sections | array of object |
Sekcje |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
Identyfikator sekcji
|
Sections.SectionId | string |
Identyfikator sekcji |
|
Typ zawartości
|
Sections.ContentType | string |
Typ zawartości |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Rozmiar pliku
|
Sections.FileSize | integer |
Rozmiar pliku |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ZawartośćModyfikowana
|
Sections.ContentModified | string |
ZawartośćModyfikowana |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AdnotacjePrzegląd
|
Sections.AnnotationsPreview | boolean |
AdnotacjePrzegląd |
|
Identyfikator dokumentu
|
DocumentId | integer |
Identyfikator dokumentu |
|
Pola indeksu
|
IndexFields | object |
Pola indeksu |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Rozmiar pliku
|
FileSize | integer |
Rozmiar pliku |
|
Typ zawartości
|
ContentType | string |
Typ zawartości |
|
VersionStatus
|
VersionStatus | string |
VersionStatus |
|
isCold
|
DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
DocumentFlags.isEmail | boolean |
isEmail |
Dołączanie pliku
Dołącza plik/sekcję do istniejącego dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinet | True | string |
Wybierz pozycję File Cabinet lub Document Tray z dokumentem. |
|
Identyfikator dokumentu
|
DocID | True | string |
Określ identyfikator dokumentu do dołączenia. |
|
Zawartość pliku
|
file | file |
Określ zawartość pliku do przechowywania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
SignatureStatus
|
SignatureStatus | array of string |
SignatureStatus |
|
Identyfikator sekcji
|
SectionId | string |
Identyfikator sekcji |
|
Typ zawartości
|
ContentType | string |
Typ zawartości |
|
HaveMorePages
|
HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
PageCount | integer |
PageCount |
|
Rozmiar pliku
|
FileSize | integer |
Rozmiar pliku |
|
OriginalFileName
|
OriginalFileName | string |
OriginalFileName |
|
ZawartośćModyfikowana
|
ContentModified | string |
ZawartośćModyfikowana |
|
HasTextAnnotation
|
HasTextAnnotation | boolean |
HasTextAnnotation |
|
AdnotacjePrzegląd
|
AnnotationsPreview | boolean |
AdnotacjePrzegląd |
Importowanie do zasobnika dokumentu
Zaimportuj nowy dokument do zasobnika dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pasek dokumentów
|
DocumentTray | True | string |
Wybierz zasobnik dokumentu do zaimportowania. |
|
Okno dialogowe Sklep
|
StoreDialogId | string |
Wybierz okno dialogowe sklepu, które ma być używane podczas importowania. |
|
|
Indeksowanie danych
|
index | string |
Określ dane indeksu dla dokumentu. |
|
|
Zawartość pliku
|
file | file |
Określ zawartość pliku do zaimportowania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sekcje
|
Sections | array of object |
Sekcje |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
Identyfikator sekcji
|
Sections.SectionId | string |
Identyfikator sekcji |
|
Typ zawartości
|
Sections.ContentType | string |
Typ zawartości |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Rozmiar pliku
|
Sections.FileSize | integer |
Rozmiar pliku |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ZawartośćModyfikowana
|
Sections.ContentModified | string |
ZawartośćModyfikowana |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AdnotacjePrzegląd
|
Sections.AnnotationsPreview | boolean |
AdnotacjePrzegląd |
|
Identyfikator dokumentu
|
DocumentId | integer |
Identyfikator dokumentu |
|
Pola indeksu
|
IndexFields | object |
Pola indeksu |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Rozmiar pliku
|
FileSize | integer |
Rozmiar pliku |
|
Typ zawartości
|
ContentType | string |
Typ zawartości |
|
VersionStatus
|
VersionStatus | string |
VersionStatus |
|
isCold
|
DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
DocumentFlags.isEmail | boolean |
isEmail |
Pobieranie dokumentu
Pobiera dokument z szafy plików lub zasobnika dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinetID | True | string |
Wybierz pozycję File Cabinet lub Document Tray z dokumentem. |
|
Identyfikator dokumentu
|
DocumentId | True | integer |
Określ identyfikator dokumentu, który chcesz pobrać. |
|
Format dokumentu
|
DocumentFormat | True | string |
Wybierz format pobranego dokumentu. |
Zwraca
Body
- Body
- binary
Pobieranie informacji o dokumencie
Pobiera informacje o dokumencie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinetID | True | string |
Wybierz pozycję File Cabinet lub Document Tray z dokumentem. |
|
Identyfikator dokumentu
|
DocumentID | True | integer |
Określ identyfikator dokumentu, dla którego chcesz uzyskać informacje. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sekcje
|
Sections | array of object |
Sekcje |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
Identyfikator sekcji
|
Sections.SectionId | string |
Identyfikator sekcji |
|
Typ zawartości
|
Sections.ContentType | string |
Typ zawartości |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Rozmiar pliku
|
Sections.FileSize | integer |
Rozmiar pliku |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ZawartośćModyfikowana
|
Sections.ContentModified | string |
ZawartośćModyfikowana |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AdnotacjePrzegląd
|
Sections.AnnotationsPreview | boolean |
AdnotacjePrzegląd |
|
Identyfikator dokumentu
|
DocumentId | integer |
Identyfikator dokumentu |
|
Pola indeksu
|
IndexFields | object |
Pola indeksu |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Rozmiar pliku
|
FileSize | integer |
Rozmiar pliku |
|
Typ zawartości
|
ContentType | string |
Typ zawartości |
|
VersionStatus
|
VersionStatus | string |
VersionStatus |
|
isCold
|
DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
DocumentFlags.isEmail | boolean |
isEmail |
Pobieranie okien dialogowych
Pobiera listę okien dialogowych dla szafki plików lub zasobnika dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinet | True | string |
Wybierz pozycję File Cabinet lub Document Tray, aby pobrać okna dialogowe. |
|
Typ okna dialogowego
|
DialogType | string |
Wybierz typ okien dialogowych, które mają być zwracane. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dialogi
|
Dialogs | array of object |
Dialogi |
|
Name
|
Dialogs.Name | string |
Name |
|
Przewodnik
|
Dialogs.Guid | string |
Przewodnik |
|
Kolor
|
Dialogs.Color | string |
Kolor |
|
IsDefault
|
Dialogs.IsDefault | boolean |
IsDefault |
|
Typ
|
Dialogs.Type | string |
Typ |
|
FileCabinetId
|
Dialogs.FileCabinetId | string |
FileCabinetId |
Pobieranie pliku
Pobiera plik/sekcję dokumentu przechowywanego w szafie plików lub zasobniku dokumentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinetID | True | string |
Wybierz pozycję File Cabinet lub Document Tray z dokumentem. |
|
Identyfikator dokumentu
|
DocumentId | True | integer |
Określ identyfikator dokumentu z plikiem, który chcesz pobrać. |
|
Numer pliku
|
FileNumber | True | string |
Określ numer pliku, który chcesz pobrać. |
|
Format dokumentu
|
DocumentFormat | True | string |
Wybierz format pobranego dokumentu. |
Zwraca
Body
- Body
- binary
Pobieranie pól okna dialogowego
Pobiera pola dla okna dialogowego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Plik Cabinet
|
FileCabinet | True | string |
Wybieranie pliku Cabinet |
|
Dialog
|
DialogId | True | string |
Wybierz okno dialogowe, aby pobrać pola. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Pola formularza
|
Fields | array of object |
Pola formularza |
|
DBFieldName
|
Fields.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.DWFieldType | string |
DWFieldType |
|
Nazwa wyświetlana
|
Fields.DisplayName | string |
Nazwa wyświetlana |
|
ReadOnly
|
Fields.ReadOnly | boolean |
ReadOnly |
|
Widoczny
|
Fields.Visible | boolean |
Widoczny |
Pobieranie pól pliku cabinet
Pobiera listę pól dla pliku cabinet.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Plik Cabinet
|
FileCabinet | True | string |
Wybierz plik Cabinet, aby pobrać pola. |
|
Typ pola
|
FieldType | string |
Wybierz typ pól do zwrócenia. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Pola formularza
|
Fields | array of object |
Pola formularza |
|
TableFieldColumns
|
Fields.TableFieldColumns | array of object |
TableFieldColumns |
|
DBFieldName
|
Fields.TableFieldColumns.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.TableFieldColumns.DWFieldType | string |
DWFieldType |
|
Nazwa wyświetlana
|
Fields.TableFieldColumns.DisplayName | string |
Nazwa wyświetlana |
|
DropLeadingBlanks
|
Fields.TableFieldColumns.DropLeadingBlanks | boolean |
DropLeadingBlanks |
|
DropLeadingZero
|
Fields.TableFieldColumns.DropLeadingZero | boolean |
DropLeadingZero |
|
FieldInfoText
|
Fields.TableFieldColumns.FieldInfoText | string |
FieldInfoText |
|
FixedEntry
|
Fields.TableFieldColumns.FixedEntry | string |
FixedEntry |
|
Długość
|
Fields.TableFieldColumns.Length | integer |
Długość |
|
NotEmpty
|
Fields.TableFieldColumns.NotEmpty | boolean |
NotEmpty |
|
Precyzja
|
Fields.TableFieldColumns.Precision | integer |
Precyzja |
|
Scope
|
Fields.TableFieldColumns.Scope | string |
Scope |
|
UsedAsDocumentName
|
Fields.UsedAsDocumentName | boolean |
UsedAsDocumentName |
|
DBFieldName
|
Fields.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.DWFieldType | string |
DWFieldType |
|
Nazwa wyświetlana
|
Fields.DisplayName | string |
Nazwa wyświetlana |
|
DropLeadingBlanks
|
Fields.DropLeadingBlanks | boolean |
DropLeadingBlanks |
|
DropLeadingZero
|
Fields.DropLeadingZero | boolean |
DropLeadingZero |
|
FieldInfoText
|
Fields.FieldInfoText | string |
FieldInfoText |
|
FixedEntry
|
Fields.FixedEntry | string |
FixedEntry |
|
Długość
|
Fields.Length | integer |
Długość |
|
NotEmpty
|
Fields.NotEmpty | boolean |
NotEmpty |
|
Precyzja
|
Fields.Precision | integer |
Precyzja |
|
Scope
|
Fields.Scope | string |
Scope |
Pobieranie pól sygnatury
Pobiera listę pól dla sygnatury.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinet | True | string |
Wybierz kartę File Cabinet lub Document Tray z żądaną sygnaturą. |
|
Stempel
|
Stamp | True | string |
Wybierz sygnaturę, aby pobrać jego pola. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Pola formularza
|
Fields | array of object |
Pola formularza |
|
Id
|
Fields.Id | string |
Id |
|
Etykieta
|
Fields.Label | string |
Etykieta |
|
Nazwa wyświetlana
|
Fields.DisplayName | string |
Nazwa wyświetlana |
Pobieranie sygnatur
Pobiera listę sygnatur dla szafki plików lub zasobnika dokumentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinet | True | string |
Wybierz pozycję File Cabinet lub Document Tray, aby pobrać sygnatury. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Album
|
Stamps | array of object |
Album |
|
Id
|
Stamps.Id | string |
Id |
|
Name
|
Stamps.Name | string |
Name |
|
Nazwa wyświetlana
|
Stamps.DisplayName | string |
Nazwa wyświetlana |
|
Kolor
|
Stamps.Color | string |
Kolor |
|
Signature
|
Stamps.Signature | string |
Signature |
|
Hasło chronione
|
Stamps.PasswordProtected | boolean |
Hasło chronione |
|
Zastąpić
|
Stamps.Overwrite | boolean |
Zastąpić |
|
Typ
|
Stamps.Type | string |
Typ |
|
FileCabinetId
|
Stamps.FileCabinetId | string |
FileCabinetId |
Pobieranie szaf plików i zasobników dokumentów
Pobiera listę szaf plików i/lub zasobników dokumentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ pliku Cabinet
|
FileCabinetType | True | string |
Wybierz typy, które mają zostać zwrócone. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
FileCabinets
|
FileCabinets | array of object |
FileCabinets |
|
Name
|
FileCabinets.Name | string |
Name |
|
Przewodnik
|
FileCabinets.Guid | string |
Przewodnik |
|
Kolor
|
FileCabinets.Color | string |
Kolor |
|
IsTray
|
FileCabinets.IsTray | boolean |
IsTray |
Przechowywanie w szafie plików
Przechowuje nowy dokument w szafie plików.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Plik Cabinet
|
FileCabinet | True | string |
Wybierz plik Cabinet do przechowywania. |
|
Okno dialogowe Sklep
|
StoreDialogId | True | string |
Wybierz okno dialogowe sklepu, które ma być używane do przechowywania. |
|
Indeksowanie danych
|
index | string |
Określ dane indeksu dla dokumentu. |
|
|
Zawartość pliku
|
file | file |
Określ zawartość pliku do przechowywania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sekcje
|
Sections | array of object |
Sekcje |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
Identyfikator sekcji
|
Sections.SectionId | string |
Identyfikator sekcji |
|
Typ zawartości
|
Sections.ContentType | string |
Typ zawartości |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Rozmiar pliku
|
Sections.FileSize | integer |
Rozmiar pliku |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ZawartośćModyfikowana
|
Sections.ContentModified | string |
ZawartośćModyfikowana |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AdnotacjePrzegląd
|
Sections.AnnotationsPreview | boolean |
AdnotacjePrzegląd |
|
Identyfikator dokumentu
|
DocumentId | integer |
Identyfikator dokumentu |
|
Pola indeksu
|
IndexFields | object |
Pola indeksu |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Rozmiar pliku
|
FileSize | integer |
Rozmiar pliku |
|
Typ zawartości
|
ContentType | string |
Typ zawartości |
|
VersionStatus
|
VersionStatus | string |
VersionStatus |
|
isCold
|
DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
DocumentFlags.isEmail | boolean |
isEmail |
Przenoszenie dokumentów
Przenosi jeden lub więcej dokumentów z jednego zasobnika pliku/dokumentu do innego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Docelowy szafa plików/zasobnik dokumentu
|
DestinationFileCabinetID | True | string |
Wybierz docelowy plik cabinet lub zasobnik dokumentu. |
|
Okno dialogowe Sklep
|
StoreDialogID | string |
Wybierz okno dialogowe sklepu służące do indeksowania przenoszonych dokumentów. |
|
|
Źródłowa szafka plików/zasobnik dokumentu
|
SourceFileCabinetId | True | string |
Wybierz źródłową szafę plików lub zasobnik dokumentu. |
|
identyfikator
|
DocumentId | integer |
Określ identyfikator dokumentu. |
|
|
Name
|
Name | string |
Wybierz lub określ nazwę pola. |
|
|
Wartość
|
Value | string |
Określ wartość pola. |
|
|
Zachowaj źródło
|
KeepSource | boolean |
Wybierz, czy dokumenty źródłowe mają zostać usunięte, czy nie. |
|
|
Wypełnianie elementu Intellix
|
FillIntellix | boolean |
Określ, czy podczas przechowywania ma być używane inteligentne indeksowanie. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Documents
|
Documents | array of object |
Documents |
|
Sekcje
|
Documents.Sections | array of object |
Sekcje |
|
SignatureStatus
|
Documents.Sections.SignatureStatus | array of string |
SignatureStatus |
|
Identyfikator sekcji
|
Documents.Sections.SectionId | string |
Identyfikator sekcji |
|
Typ zawartości
|
Documents.Sections.ContentType | string |
Typ zawartości |
|
HaveMorePages
|
Documents.Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Documents.Sections.PageCount | integer |
PageCount |
|
Rozmiar pliku
|
Documents.Sections.FileSize | integer |
Rozmiar pliku |
|
OriginalFileName
|
Documents.Sections.OriginalFileName | string |
OriginalFileName |
|
ZawartośćModyfikowana
|
Documents.Sections.ContentModified | string |
ZawartośćModyfikowana |
|
HasTextAnnotation
|
Documents.Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AdnotacjePrzegląd
|
Documents.Sections.AnnotationsPreview | boolean |
AdnotacjePrzegląd |
|
Identyfikator dokumentu
|
Documents.DocumentId | integer |
Identyfikator dokumentu |
|
Pola indeksu
|
Documents.IndexFields | object |
Pola indeksu |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Rozmiar pliku
|
Documents.FileSize | integer |
Rozmiar pliku |
|
Typ zawartości
|
Documents.ContentType | string |
Typ zawartości |
|
VersionStatus
|
Documents.VersionStatus | string |
VersionStatus |
|
isCold
|
Documents.DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
Documents.DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
Documents.DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
Documents.DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
Documents.DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
Documents.DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
Documents.DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
Documents.DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
Documents.DocumentFlags.isEmail | boolean |
isEmail |
Umieszczanie sygnatury
Umieszcza sygnaturę w dokumencie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinetID | True | string |
Wybierz pozycję File Cabinet lub Document Tray z dokumentem. |
|
Identyfikator dokumentu
|
DocumentID | True | integer |
Określ identyfikator dokumentu, który chcesz sygnaturować. |
|
Numer pliku
|
FileNumber | True | integer |
Określ plik/sekcję zawierającą stronę do oznaczania sygnaturą. |
|
Numer strony
|
PageNumber | True | integer |
Określ numer strony, na który ma być umieszczana sygnatura. |
|
Warstwa
|
Layer | True | integer |
Określ warstwę dokumentu, aby umieścić sygnaturę na [1–5] |
|
Położenie w poziomie (położenie X)
|
PositionX | number |
[Opcjonalnie] Położenie od lewej krawędzi strony w mm. |
|
|
Położenie w pionie (położenie Y)
|
PositionY | number |
[Opcjonalnie] Położenie od górnej krawędzi strony w mm. |
|
|
Stempel
|
StampId | True | string |
Wybierz lub określ sygnaturę do użycia. |
|
Hasło
|
Password | string |
Określ hasło sygnatury (jeśli jest to wymagane). |
|
|
Name
|
Name | string |
Określ nazwę pola. |
|
|
Wartość
|
Value | string |
Określ wartość pola. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
User
|
Created.User | string |
User |
|
Time
|
Created.Time | string |
Time |
|
Typ
|
Type | string |
Typ |
|
Kolor
|
Color | string |
Kolor |
|
Rotacja
|
Rotation | integer |
Rotacja |
|
Transparent
|
Transparent | boolean |
Transparent |
|
StrokeWidth
|
StrokeWidth | integer |
StrokeWidth |
|
Przewodnik
|
Guid | string |
Przewodnik |
Usuwanie dokumentu
Usuwa dokument z szafy plików lub zasobnika dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinetID | True | string |
Wybierz pozycję File Cabinet lub Document Tray z dokumentem. |
|
Identyfikator dokumentu
|
DocumentID | True | integer |
Określ identyfikator dokumentu, który chcesz usunąć. |
Usuwanie pliku
Usuwa plik/sekcję z istniejącego dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinet | True | string |
Wybierz pozycję File Cabinet lub Document Tray z dokumentem. |
|
Identyfikator dokumentu
|
DocumentID | True | integer |
Określ identyfikator dokumentu do usunięcia. |
|
Numer pliku
|
FileNumber | True | integer |
Określ numer pliku do usunięcia. |
Uzyskiwanie organizacji
Pobierz nazwę organizacji.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
Name | string |
Name |
Wyszukiwanie w pliku cabinet
Wyszukaj plik cabinet pod kątem dokumentów spełniających określone kryteria.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Plik Cabinet
|
FileCabinet | True | string |
Wybierz plik Cabinet do wyszukania. |
|
Okno dialogowe wyszukiwania
|
SearchDialogId | True | string |
Wybierz okno dialogowe wyszukiwania, które ma być używane do wyszukiwania. |
|
Kwerenda wyszukiwania
|
SearchQuery | True |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Documents
|
Documents | array of object |
Documents |
|
Sekcje
|
Documents.Sections | array of |
Sekcje |
|
Identyfikator dokumentu
|
Documents.DocumentId | integer |
Identyfikator dokumentu |
|
Pola indeksu
|
Documents.IndexFields | object |
Pola indeksu |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Rozmiar pliku
|
Documents.FileSize | integer |
Rozmiar pliku |
|
Typ zawartości
|
Documents.ContentType | string |
Typ zawartości |
|
VersionStatus
|
Documents.VersionStatus | string |
VersionStatus |
|
isCold
|
Documents.DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
Documents.DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
Documents.DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
Documents.DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
Documents.DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
Documents.DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
Documents.DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
Documents.DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
Documents.DocumentFlags.isEmail | boolean |
isEmail |
Wyświetlanie listy dokumentów w zasobniku dokumentów
Wyświetl listę dokumentów z określonego zasobnika dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pasek dokumentów
|
DocumentTray | True | string |
Wybierz pasek dokumentów do wyszukania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Documents
|
Documents | array of object | |
|
Sekcje
|
Documents.Sections | array of |
Sekcje |
|
Identyfikator dokumentu
|
Documents.DocumentId | integer |
Identyfikator dokumentu |
|
Pola indeksu
|
Documents.IndexFields | object |
Pola indeksu |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Rozmiar pliku
|
Documents.FileSize | integer |
Rozmiar pliku |
|
Typ zawartości
|
Documents.ContentType | string |
Typ zawartości |
|
VersionStatus
|
Documents.VersionStatus | string |
VersionStatus |
|
isCold
|
Documents.DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
Documents.DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
Documents.DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
Documents.DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
Documents.DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
Documents.DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
Documents.DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
Documents.DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
Documents.DocumentFlags.isEmail | boolean |
isEmail |
Zastępowanie pliku
Zastępuje plik/sekcję w istniejącym dokumencie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafa plików/zasobnik dokumentu
|
FileCabinet | True | string |
Wybierz pozycję File Cabinet lub Document Tray z dokumentem. |
|
Identyfikator dokumentu
|
DocumentID | True | integer |
Określ identyfikator dokumentu, który ma zastąpić plik. |
|
Numer pliku
|
FileNumber | True | integer |
Określ numer pliku do zastąpienia. |
|
Zawartość pliku
|
file | file |
Określ zawartość pliku do przechowywania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
SignatureStatus
|
SignatureStatus | array of string |
SignatureStatus |
|
Identyfikator sekcji
|
SectionId | string |
Identyfikator sekcji |
|
Typ zawartości
|
ContentType | string |
Typ zawartości |
|
HaveMorePages
|
HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
PageCount | integer |
PageCount |
|
Rozmiar pliku
|
FileSize | integer |
Rozmiar pliku |
|
OriginalFileName
|
OriginalFileName | string |
OriginalFileName |
|
ZawartośćModyfikowana
|
ContentModified | string |
ZawartośćModyfikowana |
|
HasTextAnnotation
|
HasTextAnnotation | boolean |
HasTextAnnotation |
|
AdnotacjePrzegląd
|
AnnotationsPreview | boolean |
AdnotacjePrzegląd |
Definicje
binarny
Jest to podstawowy typ danych "binary".