DocuWare
Přístup k běžným funkcím DocuWare z toků
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | DocuWare GmbH |
| URL | https://support.docuware.com |
| support@docuware.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | DocuWare |
| Internetová stránka | https://start.docuware.com |
| Zásady ochrany osobních údajů | https://start.docuware.com/data-privacy |
| Kategorie | Obsah a soubory; Produktivita |
DocuWare poskytuje výkonné a rozsáhlé rozhraní REST API. Díky konektoru Power Automate pro DocuWare teď můžou uživatelé využívat řadu nejběžnějších funkcí rozhraní DocuWare REST API v Power Automate. To umožňuje uživatelům větší flexibilitu vytvářet toky, které plně řeší své obchodní potřeby díky bezproblémové integraci s DocuWare.
Požadavky
Abyste mohli pokračovat, budete potřebovat následující:
- Předplatné DocuWare Cloud
- Účet Microsoft Power Apps nebo Power Automate
Jak získat přihlašovací údaje
Vytvoření nového klíče rozhraní API je snadné a dá se provést z DocuWare.
Pomocí následujícího postupu vytvořte nový klíč rozhraní API v DocuWare:
- Přihlaste se ke svému účtu DocuWare, který chcete používat s Power Automate
- V hlavní nabídce přejděte na Konfigurace.
- Na stránce Konfigurace přejděte do části Integrace a klikněte na ikonu Klíče rozhraní API Power Automate.
- Pokud nevidíte ikonu Klíče rozhraní API Power Automate, je možné, že váš uživatel nemá správná oprávnění. Obraťte se na správce DocuWare a požádejte ho o vyřešení.
- Klikněte na tlačítko Vytvořit klíč rozhraní API.
- Vyplňte hodnoty Name (Název) a Description (volitelné) a klikněte na Vytvořit.
- Po stisknutí klávesy Create může dojít k mírnému zpoždění, protože proces konfigurace vytvoří váš klíč.
- Nezapomeňte také uložit klíč rozhraní API. Toto bude jediná příležitost k zobrazení celého klíče rozhraní API. Pokud tento klíč ztratíte, budete muset vytvořit další klíč.
V tuto chvíli máte platný klíč rozhraní API, který můžete použít v Power Automate k vytvoření připojení k DocuWare. Toto připojení se pak dá použít s konektorem DocuWare Power Automate.
Začínáme s konektorem
Vytvoření připojení v Power Automate je snadné a můžete ho provést při vytváření toků.
Pokud chcete vytvořit nové připojení v Power Automate, postupujte takto:
- Přihlášení k Power Automate
- Vytvoření nového toku nebo otevření existujícího toku
- Přidání aktivity z konektoru DocuWare Power Automate do toku
- Kliknutím na +Nový krok přidáte do toku nový krok.
- Když se zobrazí "Zvolit operaci", vyberte z výběru kategorie možnost Vše a do vyhledávacího pole zadejte "DocuWare".
- Vyberte konektor DocuWare a pak vyberte ze seznamu dostupných akcí.
- Po přidání akce do toku se zobrazí výzva k vytvoření nového připojení.
- Zadejte název připojení ("Název připojení") a klíč rozhraní API (klíč rozhraní API), který jste obdrželi z DocuWare v předchozí části, a klikněte na Vytvořit.
Od tohoto okamžiku budou všechny aktivity přidané z konektoru DocuWare používat toto připojení. Kliknutím na tlačítko "..." můžete vytvořit další připojení. v pravém horním rohu aktivity a potom v dolní části místní nabídky klikněte na + Přidat nové připojení.
Známé problémy a omezení
V tomto okamžiku není konektor Power Automate pro DocuWare v novém návrháři toku Power Automate podporovaný.
Běžné chyby a nápravné prostředky
Kódy chyb HTTP:
- 400: Ujistěte se, že jste v aktivitě vyplnili všechna požadovaná pole. Některá pole jsou povinná a musí být vyplněná před spuštěním aktivity.
- 401: Ujistěte se, že jste zadali správný klíč rozhraní API. Stav klíče rozhraní API můžete také zkontrolovat na stránce Konfigurace v části Integrace –> Klíče rozhraní API Power Automate.
- 404: Ujistěte se, že zadaný dokument a/nebo souborová skříňka existuje a že k nim máte přístup. Pokud dokument nebo soubor cab neexistuje nebo k nim nemáte přístup, zobrazí se chyba 404.
- 500: Jedná se o obecnou chybu, kterou může způsobovat řada různých problémů. Pokud se zobrazí tato chyba, požádejte o pomoc podporu DocuWare.
časté otázky
Osvědčené postupy
Tady jsou některé z osvědčených postupů, které doporučujeme při používání konektoru DocuWare Power Automate:
- Vždy používejte vyhrazeného uživatele DocuWare k ověřování pomocí konektoru DocuWare Power Automate. To vám umožní snadno sledovat a spravovat akce, které konektor provádí.
- Začněte testováním toku pomocí aktivity Získat organizaci. Toto je nejzásadnější akce poskytovaná v konektoru DocuWare Power Automate a umožní vám ověřit, že připojení funguje správně.
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Nesdílitelné |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| klíč rozhraní API | securestring | Klíč rozhraní API pro přístup k DocuWare | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Aktualizace polí indexu |
Aktualizuje indexová pole dokumentu. |
| Hledání v souboru CAB |
V souboru CAB vyhledejte dokumenty odpovídající zadaným kritériím. |
| Import do zásobníku dokumentů |
Naimportujte nový dokument do zásobníku dokumentu. |
| Nahrazení souboru |
Nahradí soubor nebo oddíl v existujícím dokumentu. |
| Odstranění dokumentu |
Odstraní dokument ze souboru cab nebo zásobníku dokumentu. |
| Odstranění souboru |
Odstraní soubor nebo oddíl z existujícího dokumentu. |
| Přenos dokumentů |
Přesune jeden nebo více dokumentů z jedné skříně souborů nebo zásobníku dokumentů do jiného. |
| Připojení souboru |
Připojí soubor nebo oddíl k existujícímu dokumentu. |
| Stažení dokumentu |
Stáhne dokument ze souborové skříňky nebo zásobníku dokumentů. |
| Stažení souboru |
Stáhne soubor nebo oddíl dokumentu uloženého v souborové skříni nebo zásobníku dokumentů. |
| Uložení do souboru CAB |
Uloží nový dokument do souboru CAB. |
| Umístění razítka |
Umístí razítko na dokument. |
| Zobrazení seznamu dokumentů na hlavním panelu dokumentů |
Vypíše dokumenty ze zadaného zásobníku dokumentů. |
| Získat dialogová pole |
Získá pole dialogového okna. |
| Získat dialogy |
Získá seznam dialogů pro souborovou skříňku nebo zásobník dokumentů. |
| Získání informací o dokumentu |
Získá informace o dokumentu. |
| Získání organizace |
Získejte název organizace. |
| Získání polí razítka |
Získá seznam polí pro razítko. |
| Získání polí souboru CAB |
Získá seznam polí pro soubor cab. |
| Získání razítek |
Získá seznam razítek pro souborová skříňka nebo zásobník dokumentů. |
| Získání souborů CAB a zásobníků dokumentů |
Získá seznam skříní souborů a/nebo zásobníků dokumentů. |
Aktualizace polí indexu
Aktualizuje indexová pole dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka
|
FileCabinetID | True | string |
Vyberte soubor cab s dokumentem, který chcete aktualizovat. |
|
ID dokumentu
|
DocumentID | True | integer |
Zadejte ID dokumentu, který chcete aktualizovat. |
|
Název
|
Name | string |
Vyberte nebo zadejte pole indexu. |
|
|
Hodnota
|
Value | string |
Zadejte hodnotu indexu. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Oddíly
|
Sections | array of object |
Oddíly |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
Typ obsahu
|
Sections.ContentType | string |
Typ obsahu |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Velikost souboru
|
Sections.FileSize | integer |
Velikost souboru |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
PoznámkyPreview
|
Sections.AnnotationsPreview | boolean |
PoznámkyPreview |
|
Id dokumentu
|
DocumentId | integer |
Id dokumentu |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Velikost souboru
|
FileSize | integer |
Velikost souboru |
|
Typ obsahu
|
ContentType | string |
Typ obsahu |
|
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 |
Hledání v souboru CAB
V souboru CAB vyhledejte dokumenty odpovídající zadaným kritériím.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka
|
FileCabinet | True | string |
Vyberte soubor cab, který chcete vyhledat. |
|
Dialogové okno Hledat
|
SearchDialogId | True | string |
Vyberte dialogové okno hledání, které chcete použít k hledání. |
|
Vyhledávací dotaz
|
SearchQuery | True |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Počet
|
Count | integer |
Počet |
|
Documents
|
Documents | array of object |
Documents |
|
Oddíly
|
Documents.Sections | array of |
Oddíly |
|
Id dokumentu
|
Documents.DocumentId | integer |
Id dokumentu |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Velikost souboru
|
Documents.FileSize | integer |
Velikost souboru |
|
Typ obsahu
|
Documents.ContentType | string |
Typ obsahu |
|
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 |
Import do zásobníku dokumentů
Naimportujte nový dokument do zásobníku dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Zásobník dokumentů
|
DocumentTray | True | string |
Vyberte zásobník dokumentů, do které chcete importovat. |
|
Dialogové okno Uložit
|
StoreDialogId | string |
Vyberte dialogové okno úložiště, které chcete použít při importu. |
|
|
Indexovat data
|
index | string |
Zadejte data indexu dokumentu. |
|
|
Obsah souboru
|
file | file |
Zadejte obsah souboru, který chcete importovat. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Oddíly
|
Sections | array of object |
Oddíly |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
Typ obsahu
|
Sections.ContentType | string |
Typ obsahu |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Velikost souboru
|
Sections.FileSize | integer |
Velikost souboru |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
PoznámkyPreview
|
Sections.AnnotationsPreview | boolean |
PoznámkyPreview |
|
Id dokumentu
|
DocumentId | integer |
Id dokumentu |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Velikost souboru
|
FileSize | integer |
Velikost souboru |
|
Typ obsahu
|
ContentType | string |
Typ obsahu |
|
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 |
Nahrazení souboru
Nahradí soubor nebo oddíl v existujícím dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinet | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s dokumentem. |
|
ID dokumentu
|
DocumentID | True | integer |
Zadejte ID dokumentu se souborem, který chcete nahradit. |
|
Číslo souboru
|
FileNumber | True | integer |
Zadejte číslo souboru, které chcete nahradit. |
|
Obsah souboru
|
file | file |
Zadejte obsah souboru, který se má uložit. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
SignatureStatus
|
SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
SectionId | string |
SectionId |
|
Typ obsahu
|
ContentType | string |
Typ obsahu |
|
HaveMorePages
|
HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
PageCount | integer |
PageCount |
|
Velikost souboru
|
FileSize | integer |
Velikost souboru |
|
OriginalFileName
|
OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
HasTextAnnotation | boolean |
HasTextAnnotation |
|
PoznámkyPreview
|
AnnotationsPreview | boolean |
PoznámkyPreview |
Odstranění dokumentu
Odstraní dokument ze souboru cab nebo zásobníku dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinetID | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s dokumentem. |
|
ID dokumentu
|
DocumentID | True | integer |
Zadejte ID dokumentu, který chcete odstranit. |
Odstranění souboru
Odstraní soubor nebo oddíl z existujícího dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinet | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s dokumentem. |
|
ID dokumentu
|
DocumentID | True | integer |
Zadejte ID dokumentu, ze které chcete dokument odstranit. |
|
Číslo souboru
|
FileNumber | True | integer |
Zadejte číslo souboru, které chcete odstranit. |
Přenos dokumentů
Přesune jeden nebo více dokumentů z jedné skříně souborů nebo zásobníku dokumentů do jiného.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Cílový zásobník souborů /zásobník dokumentů
|
DestinationFileCabinetID | True | string |
Vyberte cílovou skříni souborů nebo zásobník dokumentů. |
|
Dialogové okno Uložit
|
StoreDialogID | string |
Vyberte dialogové okno úložiště pro indexování přesunutých dokumentů. |
|
|
Zdrojový zásobník souborů / zásobník dokumentů
|
SourceFileCabinetId | True | string |
Vyberte zdrojová skříňka souborů nebo zásobník dokumentů. |
|
ID
|
DocumentId | integer |
Zadejte ID dokumentu. |
|
|
Název
|
Name | string |
Vyberte nebo zadejte název pole. |
|
|
Hodnota
|
Value | string |
Zadejte hodnotu pole. |
|
|
Zachovat zdroj
|
KeepSource | boolean |
Zvolte, jestli se mají zdrojové dokumenty odstranit, nebo ne. |
|
|
Vyplnit Intellix
|
FillIntellix | boolean |
Zvolte, jestli se má inteligentní indexování používat při ukládání. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Počet
|
Count | integer |
Počet |
|
Documents
|
Documents | array of object |
Documents |
|
Oddíly
|
Documents.Sections | array of object |
Oddíly |
|
SignatureStatus
|
Documents.Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Documents.Sections.SectionId | string |
SectionId |
|
Typ obsahu
|
Documents.Sections.ContentType | string |
Typ obsahu |
|
HaveMorePages
|
Documents.Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Documents.Sections.PageCount | integer |
PageCount |
|
Velikost souboru
|
Documents.Sections.FileSize | integer |
Velikost souboru |
|
OriginalFileName
|
Documents.Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Documents.Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Documents.Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
PoznámkyPreview
|
Documents.Sections.AnnotationsPreview | boolean |
PoznámkyPreview |
|
Id dokumentu
|
Documents.DocumentId | integer |
Id dokumentu |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Velikost souboru
|
Documents.FileSize | integer |
Velikost souboru |
|
Typ obsahu
|
Documents.ContentType | string |
Typ obsahu |
|
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 |
Připojení souboru
Připojí soubor nebo oddíl k existujícímu dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinet | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s dokumentem. |
|
ID dokumentu
|
DocID | True | string |
Zadejte ID dokumentu, ke které se má připojit. |
|
Obsah souboru
|
file | file |
Zadejte obsah souboru, který se má uložit. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
SignatureStatus
|
SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
SectionId | string |
SectionId |
|
Typ obsahu
|
ContentType | string |
Typ obsahu |
|
HaveMorePages
|
HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
PageCount | integer |
PageCount |
|
Velikost souboru
|
FileSize | integer |
Velikost souboru |
|
OriginalFileName
|
OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
HasTextAnnotation | boolean |
HasTextAnnotation |
|
PoznámkyPreview
|
AnnotationsPreview | boolean |
PoznámkyPreview |
Stažení dokumentu
Stáhne dokument ze souborové skříňky nebo zásobníku dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinetID | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s dokumentem. |
|
ID dokumentu
|
DocumentId | True | integer |
Zadejte ID dokumentu, který chcete stáhnout. |
|
Formát dokladu
|
DocumentFormat | True | string |
Vyberte formát staženého dokumentu. |
Návraty
Body
- Body
- binary
Stažení souboru
Stáhne soubor nebo oddíl dokumentu uloženého v souborové skříni nebo zásobníku dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinetID | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s dokumentem. |
|
ID dokumentu
|
DocumentId | True | integer |
Zadejte ID dokumentu se souborem, který chcete stáhnout. |
|
Číslo souboru
|
FileNumber | True | string |
Zadejte číslo souboru, který chcete stáhnout. |
|
Formát dokladu
|
DocumentFormat | True | string |
Vyberte formát staženého dokumentu. |
Návraty
Body
- Body
- binary
Uložení do souboru CAB
Uloží nový dokument do souboru CAB.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka
|
FileCabinet | True | string |
Vyberte soubor cab, do které chcete soubor uložit. |
|
Dialogové okno Uložit
|
StoreDialogId | True | string |
Vyberte dialogové okno úložiště, které chcete použít k ukládání. |
|
Indexovat data
|
index | string |
Zadejte data indexu dokumentu. |
|
|
Obsah souboru
|
file | file |
Zadejte obsah souboru, který se má uložit. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Oddíly
|
Sections | array of object |
Oddíly |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
Typ obsahu
|
Sections.ContentType | string |
Typ obsahu |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Velikost souboru
|
Sections.FileSize | integer |
Velikost souboru |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
PoznámkyPreview
|
Sections.AnnotationsPreview | boolean |
PoznámkyPreview |
|
Id dokumentu
|
DocumentId | integer |
Id dokumentu |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Velikost souboru
|
FileSize | integer |
Velikost souboru |
|
Typ obsahu
|
ContentType | string |
Typ obsahu |
|
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 |
Umístění razítka
Umístí razítko na dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinetID | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s dokumentem. |
|
ID dokumentu
|
DocumentID | True | integer |
Zadejte ID dokumentu, který chcete razítek. |
|
Číslo souboru
|
FileNumber | True | integer |
Zadejte soubor nebo oddíl obsahující stránku, která se má razítekovat. |
|
Číslo stránky
|
PageNumber | True | integer |
Zadejte číslo stránky, na které se má razítko umístit. |
|
Vrstva
|
Layer | True | integer |
Zadejte vrstvu dokumentu pro umístění razítka na [1-5] |
|
Vodorovná pozice (pozice X)
|
PositionX | number |
[Volitelné] Pozice od levého okraje stránky v mm. |
|
|
Svislá pozice (pozice Y)
|
PositionY | number |
[Volitelné] Pozice od horního okraje stránky v mm. |
|
|
Razítko
|
StampId | True | string |
Vyberte nebo zadejte razítko, které se má použít. |
|
Heslo
|
Password | string |
Zadejte heslo razítka (v případě potřeby). |
|
|
Název
|
Name | string |
Zadejte název pole. |
|
|
Hodnota
|
Value | string |
Zadejte hodnotu pole. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Uživatel
|
Created.User | string |
Uživatel |
|
Time
|
Created.Time | string |
Time |
|
Typ
|
Type | string |
Typ |
|
Barva
|
Color | string |
Barva |
|
Rotace
|
Rotation | integer |
Rotace |
|
Transparent
|
Transparent | boolean |
Transparent |
|
Tahem po tahu
|
StrokeWidth | integer |
Tahem po tahu |
|
Průvodce
|
Guid | string |
Průvodce |
Zobrazení seznamu dokumentů na hlavním panelu dokumentů
Vypíše dokumenty ze zadaného zásobníku dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Zásobník dokumentů
|
DocumentTray | True | string |
Vyberte zásobník dokumentů, který chcete vyhledat. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Počet
|
Count | integer |
Počet |
|
Documents
|
Documents | array of object | |
|
Oddíly
|
Documents.Sections | array of |
Oddíly |
|
Id dokumentu
|
Documents.DocumentId | integer |
Id dokumentu |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Velikost souboru
|
Documents.FileSize | integer |
Velikost souboru |
|
Typ obsahu
|
Documents.ContentType | string |
Typ obsahu |
|
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 |
Získat dialogová pole
Získá pole dialogového okna.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka
|
FileCabinet | True | string |
Výběr souboru CAB |
|
Dialog
|
DialogId | True | string |
Výběrem dialogového okna získáte pole pro. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Fields
|
Fields | array of object |
Fields |
|
DBFieldName
|
Fields.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.DWFieldType | string |
DWFieldType |
|
ZobrazovanéJméno
|
Fields.DisplayName | string |
ZobrazovanéJméno |
|
ReadOnly
|
Fields.ReadOnly | boolean |
ReadOnly |
|
Viditelný
|
Fields.Visible | boolean |
Viditelný |
Získat dialogy
Získá seznam dialogů pro souborovou skříňku nebo zásobník dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinet | True | string |
Vyberte souborová skříňka nebo zásobník dokumentů, ze které chcete získat dialogy. |
|
Typ dialogového okna
|
DialogType | string |
Vyberte typ dialogových oken, která se mají vrátit. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Dialogs
|
Dialogs | array of object |
Dialogs |
|
Název
|
Dialogs.Name | string |
Název |
|
Průvodce
|
Dialogs.Guid | string |
Průvodce |
|
Barva
|
Dialogs.Color | string |
Barva |
|
IsDefault
|
Dialogs.IsDefault | boolean |
IsDefault |
|
Typ
|
Dialogs.Type | string |
Typ |
|
FileCabinetId
|
Dialogs.FileCabinetId | string |
FileCabinetId |
Získání informací o dokumentu
Získá informace o dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinetID | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s dokumentem. |
|
ID dokumentu
|
DocumentID | True | integer |
Zadejte ID dokumentu, na kterém chcete informace. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Oddíly
|
Sections | array of object |
Oddíly |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
Typ obsahu
|
Sections.ContentType | string |
Typ obsahu |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Velikost souboru
|
Sections.FileSize | integer |
Velikost souboru |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
PoznámkyPreview
|
Sections.AnnotationsPreview | boolean |
PoznámkyPreview |
|
Id dokumentu
|
DocumentId | integer |
Id dokumentu |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Velikost souboru
|
FileSize | integer |
Velikost souboru |
|
Typ obsahu
|
ContentType | string |
Typ obsahu |
|
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 |
Získání organizace
Získejte název organizace.
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název
|
Name | string |
Název |
Získání polí razítka
Získá seznam polí pro razítko.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinet | True | string |
Vyberte souborovou skříňku nebo zásobník dokumentů s požadovaným razítkem. |
|
Razítko
|
Stamp | True | string |
Výběrem razítka získáte jeho pole. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Fields
|
Fields | array of object |
Fields |
|
identifikační číslo
|
Fields.Id | string |
identifikační číslo |
|
Označení
|
Fields.Label | string |
Označení |
|
ZobrazovanéJméno
|
Fields.DisplayName | string |
ZobrazovanéJméno |
Získání polí souboru CAB
Získá seznam polí pro soubor cab.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka
|
FileCabinet | True | string |
Vyberte souborová skříňka, pro která chcete získat pole. |
|
Typ pole
|
FieldType | string |
Vyberte typ polí, která chcete vrátit. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Fields
|
Fields | array of object |
Fields |
|
TableFieldColumns
|
Fields.TableFieldColumns | array of object |
TableFieldColumns |
|
DBFieldName
|
Fields.TableFieldColumns.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.TableFieldColumns.DWFieldType | string |
DWFieldType |
|
ZobrazovanéJméno
|
Fields.TableFieldColumns.DisplayName | string |
ZobrazovanéJméno |
|
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élka
|
Fields.TableFieldColumns.Length | integer |
Délka |
|
NotEmpty
|
Fields.TableFieldColumns.NotEmpty | boolean |
NotEmpty |
|
Přesnost
|
Fields.TableFieldColumns.Precision | integer |
Přesnost |
|
Scope
|
Fields.TableFieldColumns.Scope | string |
Scope |
|
UsedAsDocumentName
|
Fields.UsedAsDocumentName | boolean |
UsedAsDocumentName |
|
DBFieldName
|
Fields.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.DWFieldType | string |
DWFieldType |
|
ZobrazovanéJméno
|
Fields.DisplayName | string |
ZobrazovanéJméno |
|
DropLeadingBlanks
|
Fields.DropLeadingBlanks | boolean |
DropLeadingBlanks |
|
DropLeadingZero
|
Fields.DropLeadingZero | boolean |
DropLeadingZero |
|
FieldInfoText
|
Fields.FieldInfoText | string |
FieldInfoText |
|
FixedEntry
|
Fields.FixedEntry | string |
FixedEntry |
|
Délka
|
Fields.Length | integer |
Délka |
|
NotEmpty
|
Fields.NotEmpty | boolean |
NotEmpty |
|
Přesnost
|
Fields.Precision | integer |
Přesnost |
|
Scope
|
Fields.Scope | string |
Scope |
Získání razítek
Získá seznam razítek pro souborová skříňka nebo zásobník dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Souborová skříňka / zásobník dokumentů
|
FileCabinet | True | string |
Pokud chcete získat razítka, vyberte souborová skříňka nebo zásobník dokumentů. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Známky
|
Stamps | array of object |
Známky |
|
identifikační číslo
|
Stamps.Id | string |
identifikační číslo |
|
Název
|
Stamps.Name | string |
Název |
|
ZobrazovanéJméno
|
Stamps.DisplayName | string |
ZobrazovanéJméno |
|
Barva
|
Stamps.Color | string |
Barva |
|
Signature
|
Stamps.Signature | string |
Signature |
|
Ochrana heslem
|
Stamps.PasswordProtected | boolean |
Ochrana heslem |
|
Přepsat
|
Stamps.Overwrite | boolean |
Přepsat |
|
Typ
|
Stamps.Type | string |
Typ |
|
FileCabinetId
|
Stamps.FileCabinetId | string |
FileCabinetId |
Získání souborů CAB a zásobníků dokumentů
Získá seznam skříní souborů a/nebo zásobníků dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ souboru CAB
|
FileCabinetType | True | string |
Vyberte, které typy chcete vrátit. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
FileCabinets
|
FileCabinets | array of object |
FileCabinets |
|
Název
|
FileCabinets.Name | string |
Název |
|
Průvodce
|
FileCabinets.Guid | string |
Průvodce |
|
Barva
|
FileCabinets.Color | string |
Barva |
|
IsTray
|
FileCabinets.IsTray | boolean |
IsTray |
Definice
binární
Toto je základní datový typ Binary.