DocuWare

A folyamatokon belüli gyakori DocuWare-funkciók elérése.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket:      - Azure Government-régiók      - Azure China-régiók      - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	prémium	Az összes Power Apps-régió , kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)

Érintkezés
Név	DocuWare GmbH
URL	https://support.docuware.com
Email	support@docuware.com

Összekötő metaadatai
Kiadó	DocuWare
Webhely	https://start.docuware.com
Adatvédelmi irányelvek	https://start.docuware.com/data-privacy
Kategóriák	Tartalom és fájlok; Termelékenység

A DocuWare hatékony és kiterjedt REST API-t biztosít. A DocuWare Power Automate Connectorjával a felhasználók mostantól a DocuWare REST API számos leggyakoribb funkcióját használhatják a Power Automate-ben. Ez nagyobb rugalmasságot tesz lehetővé a felhasználók számára olyan folyamatok létrehozásában, amelyek teljes mértékben megfelelnek az üzleti igényeiknek, köszönhetően a DocuWare-hez való zökkenőmentes integrációnak.

Előfeltételek

A folytatáshoz a következőkre lesz szüksége:

• DocuWare Cloud-előfizetés
• Microsoft Power Apps- vagy Power Automate-fiók

Hitelesítő adatok lekérése

Az új API-kulcs létrehozása egyszerű, és a DocuWare-ben is elvégezhető.

Az alábbi lépéseket követve hozzon létre egy új API-kulcsot a DocuWare-ben:

1. Jelentkezzen be a Power Automate-rel használni kívánt DocuWare-fiókjába
2. A főmenüben lépjen a "Konfigurációk" elemre
3. A "Konfigurációk" lapon lépjen az "Integrációk" szakaszra, és kattintson a "Power Automate API-kulcsok" ikonra
   • Ha nem látja a "Power Automate API-kulcsok" ikont, lehetséges, hogy a felhasználó nem rendelkezik a megfelelő engedélyekkel. A probléma megoldásához forduljon a DocuWare rendszergazdájához.
4. Kattintson az "API-kulcs létrehozása" gombra
5. Töltse ki a "Név" és a "Leírás" (nem kötelező) értéket, majd kattintson a "Létrehozás" gombra.
   • A "Létrehozás" billentyű lenyomása után előfordulhat, hogy a konfigurációs folyamat létrehozza a kulcsot.
   • Emellett mindenképpen mentse az API-kulcsot. Ez lesz az egyetlen lehetősége, hogy megtekintse a teljes API-kulcsot. Ha elveszíti ezt a kulcsot, létre kell hoznia egy másikat.

Ezen a ponton már rendelkezik egy érvényes API-kulccsal, amely a Power Automate-ben használható a DocuWare-kapcsolat létrehozásához. Ez a kapcsolat ezután használható a DocuWare Power Automate-összekötővel.

Ismerkedés az összekötővel

A Kapcsolatok létrehozása a Power Automate-ben egyszerű, és a folyamatok létrehozásakor is elvégezhető.

Az alábbi lépéseket követve hozzon létre új kapcsolatot a Power Automate-ben:

1. Bejelentkezés a Power Automate-be
2. Új folyamat létrehozása vagy meglévő folyamat megnyitása
3. Tevékenység hozzáadása a DocuWare Power Automate-összekötőből a folyamathoz
   • Kattintson a "+ Új lépés" gombra egy új lépés hozzáadásához a folyamathoz
   • Amikor megjelenik a "Művelet kiválasztása" elem, válassza az "Összes" lehetőséget a kategóriaválasztásból, majd írja be a "DocuWare" kifejezést a keresőmezőbe.
   • Válassza a "DocuWare" összekötőt, majd válasszon az elérhető műveletek listájából.
4. Amikor hozzáadja a műveletet a folyamathoz, a rendszer kérni fogja, hogy hozzon létre egy új kapcsolatot.
5. Adjon meg egy kapcsolatnevet ("Kapcsolat neve") és az előző szakaszban a DocuWare-től kapott API-kulcsot ("API-kulcs"), és kattintson a "Létrehozás" gombra.

Ettől a ponttól kezdve a DocuWare-összekötőből hozzáadott összes tevékenység ezt a kapcsolatot fogja használni. További kapcsolatokat a "..." gombra kattintva hozhat létre. a tevékenység jobb felső sarkában, majd az előugró menü alján kattintson a "+ Új kapcsolat hozzáadása" elemre.

Ismert problémák és korlátozások

A DocuWare Power Automate-összekötője jelenleg nem támogatott az új Power Automate Flow-tervezőben.

Gyakori hibák és jogorvoslatok

HTTP-hibakódok:

• 400: Győződjön meg arról, hogy kitöltötte a tevékenység összes szükséges mezőjét. Bizonyos mezőkre szükség van, amelyeket ki kell tölteni a tevékenység futtatása előtt.
• 401: Győződjön meg arról, hogy a megfelelő API-kulcsot adta meg. Az API-kulcs állapotát a "Konfigurációk" lapon, az "Integrációk" –> "Power Automate API-kulcsok" területen is ellenőrizheti.
• 404: Győződjön meg arról, hogy a megadott dokumentum és/vagy fájlszekrény létezik, és hogy hozzáfér hozzájuk. Ha a dokumentum vagy a fájlszekrény nem létezik, vagy nem rendelkezik hozzáféréssel ezekhez, akkor a 404-as hibaüzenet jelenik meg.
• 500: Ez egy általános hiba, amelyet számos különböző probléma okozhat. Ha ezt a hibát kapja, forduljon a DocuWare ügyfélszolgálatához segítségért.

GYIK

Ajánlott eljárások

A DocuWare Power Automate-összekötő használatakor az alábbi ajánlott eljárások közül választhat:

• Mindig használjon dedikált DocuWare-felhasználót a DocuWare Power Automate-összekötővel való hitelesítéshez. Ez lehetővé teszi az összekötő által végrehajtott műveletek egyszerű nyomon követését és kezelését.
• Először tesztelje a folyamatot a "Szervezet lekérése" tevékenységgel. Ez a DocuWare Power Automate-összekötő legalapvetőbb művelete, amely lehetővé teszi, hogy ellenőrizze, hogy a kapcsolat megfelelően működik-e.

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:

Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
API-kulcs	securestring	A DocuWare elérésére szolgáló API-kulcs	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

Bélyegek lekérése	Lekéri a fájlszekrény vagy a dokumentumtálca bélyegeinek listáját.
Bélyegmezők lekérése	Lekéri a bélyeg mezőinek listáját.
Bélyegző elhelyezése	Bélyegzőt helyez el egy dokumentumon.
Dokumentum letöltése	Letölt egy dokumentumot egy fájlszekrényből vagy egy tálcáról.
Dokumentum törlése	Dokumentum törlése fájlszekrényből vagy dokumentumtálcából.
Dokumentumadatok lekérése	Információt kap egy dokumentumról.
Dokumentumok listázása a dokumentumtálcában	Dokumentumok listázása a megadott dokumentumtálcából.
Dokumentumok átvitele	Egy vagy több dokumentum áthelyezése egy fájlszekrényből vagy dokumentumtálcából egy másikba.
Fájl cseréje	Egy meglévő dokumentum fájlját/szakaszát cseréli le.
Fájl hozzáfűzése	Fájl/szakasz hozzáfűzése egy meglévő dokumentumhoz.
Fájl letöltése	Egy fájlszekrényben vagy tálcán tárolt dokumentum fájlját/szakaszát tölti le.
Fájl törlése	Fájl/szakasz törlése meglévő dokumentumból.
Fájlszekrény mezőinek lekérése	Lekéri a fájlszekrény mezőinek listáját.
Fájlszekrények és dokumentumtálcák lekérése	Lekéri a fájlszekrények és/vagy dokumentumtálcák listáját.
Importálás dokumentumtálcára	Új dokumentum importálása egy dokumentumtálcába.
Indexmezők frissítése	Frissíti a dokumentum indexmezőit.
Keresés a fájlszekrényben	Keressen egy fájlszekrényben a megadott feltételeknek megfelelő dokumentumokat.
Párbeszédpanelek lekérése	Lekéri a fájlszekrényhez vagy a dokumentumtálcához tartozó párbeszédpanelek listáját.
Párbeszédpanelmezők lekérése	Párbeszédpanel mezőinek lekérdezése
Szervezet lekérése	Kérje le a szervezet nevét.
Tárolás fájlszekrénybe	Új dokumentumot tárol egy fájlszekrényben.

Bélyegek lekérése

Műveletazonosító:

GetStamps

Lekéri a fájlszekrény vagy a dokumentumtálca bélyegeinek listáját.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinet	True	string	Válassza ki a fájlszekrényt vagy a dokumentumtálcát a bélyegek lekéréséhez.

Válaszok

Name	Elérési út	Típus	Description
Bélyegek	Stamps	array of object	Bélyegek
Azonosító	Stamps.Id	string	Azonosító
Név	Stamps.Name	string	Név
Megjelenítendő név	Stamps.DisplayName	string	Megjelenítendő név
Szín	Stamps.Color	string	Szín
Signature	Stamps.Signature	string	Signature
PasswordProtected	Stamps.PasswordProtected	boolean	PasswordProtected
Felülírás	Stamps.Overwrite	boolean	Felülírás
Típus	Stamps.Type	string	Típus
FileCabinetId	Stamps.FileCabinetId	string	FileCabinetId

Bélyegmezők lekérése

Műveletazonosító:

GetStampFields

Lekéri a bélyeg mezőinek listáját.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinet	True	string	Válassza ki a kívánt bélyeggel rendelkező fájlszekrényt vagy dokumentumtálcát.
Bélyeg	Stamp	True	string	Jelölje ki a bélyeget a mezők lekéréséhez.

Válaszok

Name	Elérési út	Típus	Description
Fields	Fields	array of object	Fields
Azonosító	Fields.Id	string	Azonosító
Címke	Fields.Label	string	Címke
Megjelenítendő név	Fields.DisplayName	string	Megjelenítendő név

Bélyegző elhelyezése

Műveletazonosító:

PlaceAStamp

Bélyegzőt helyez el egy dokumentumon.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinetID	True	string	Válassza ki a dokumentumot tartalmazó fájlszekrényt vagy dokumentumtálcát.
Dokumentumazonosító	DocumentID	True	integer	Adja meg a bélyegzni kívánt dokumentum azonosítóját.
Fájlszám	FileNumber	True	integer	Adja meg a lebélyegzendő lapot tartalmazó fájlt/szakaszt.
Oldalszám	PageNumber	True	integer	Adja meg a bélyeg elhelyezéséhez használni kívánt oldalszámot.
Réteg	Layer	True	integer	Adja meg azt a dokumentumréteget, amelyen a bélyeget a következőre szeretné helyezni: [1-5]
Vízszintes pozíció (X pozíció)	PositionX		number	[Nem kötelező] Pozíció az oldal bal szélétől mm-ben.
Függőleges pozíció (Y pozíció)	PositionY		number	[Nem kötelező] Pozíció az oldal felső szélétől mm-ben.
Bélyeg	StampId	True	string	Jelölje ki vagy adja meg a használni kívánt bélyegzőt.
Jelszó	Password		string	Adja meg a bélyegző jelszavát (ha szükséges).
Név	Name		string	Adjon meg egy mezőnevet.
Érték	Value		string	Adjon meg egy mezőértéket.

Válaszok

Name	Elérési út	Típus	Description
User	Created.User	string	User
Idő	Created.Time	string	Idő
Típus	Type	string	Típus
Szín	Color	string	Szín
Változtatás	Rotation	integer	Változtatás
Transparent	Transparent	boolean	Transparent
StrokeWidth	StrokeWidth	integer	StrokeWidth
GUID	Guid	string	GUID

Dokumentum letöltése

Műveletazonosító:

DownloadDocument

Letölt egy dokumentumot egy fájlszekrényből vagy egy tálcáról.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinetID	True	string	Válassza ki a dokumentumot tartalmazó fájlszekrényt vagy dokumentumtálcát.
Dokumentumazonosító	DocumentId	True	integer	Adja meg a letölteni kívánt dokumentum azonosítóját.
Dokumentumformátum	DocumentFormat	True	string	Válassza ki a letöltött dokumentum formátumát.

Válaszok

Törzs

Törzs

binary

Dokumentum törlése

Műveletazonosító:

DeleteDocument

Dokumentum törlése fájlszekrényből vagy dokumentumtálcából.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinetID	True	string	Válassza ki a dokumentumot tartalmazó fájlszekrényt vagy dokumentumtálcát.
Dokumentumazonosító	DocumentID	True	integer	Adja meg a törölni kívánt dokumentum azonosítóját.

Dokumentumadatok lekérése

Műveletazonosító:

GetDocumentInformation

Információt kap egy dokumentumról.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinetID	True	string	Válassza ki a dokumentumot tartalmazó fájlszekrényt vagy dokumentumtálcát.
Dokumentumazonosító	DocumentID	True	integer	Adja meg annak a dokumentumnak az azonosítóját, amelyen adatokat szeretne megadni.

Válaszok

Name	Elérési út	Típus	Description
Szakaszok	Sections	array of object	Szakaszok
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
Szakaszazonosító	Sections.SectionId	string	Szakaszazonosító
TartalomTípus	Sections.ContentType	string	TartalomTípus
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Fájlméret	Sections.FileSize	integer	Fájlméret
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
SzéljegyzetekPreview	Sections.AnnotationsPreview	boolean	SzéljegyzetekPreview
DocumentId	DocumentId	integer	DocumentId
Indexmezők	IndexFields	object	Indexmezők
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Fájlméret	FileSize	integer	Fájlméret
TartalomTípus	ContentType	string	TartalomTípus
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

Dokumentumok listázása a dokumentumtálcában

Műveletazonosító:

ListDocumentsInDocumentTray

Dokumentumok listázása a megadott dokumentumtálcából.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumtálca	DocumentTray	True	string	Válassza ki a keresendő dokumentumtálcát.

Válaszok

Name	Elérési út	Típus	Description
Számlál	Count	integer	Számlál
Documents	Documents	array of object
Szakaszok	Documents.Sections	array of	Szakaszok
DocumentId	Documents.DocumentId	integer	DocumentId
Indexmezők	Documents.IndexFields	object	Indexmezők
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Fájlméret	Documents.FileSize	integer	Fájlméret
TartalomTípus	Documents.ContentType	string	TartalomTípus
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

Dokumentumok átvitele

Műveletazonosító:

TransferDocument

Egy vagy több dokumentum áthelyezése egy fájlszekrényből vagy dokumentumtálcából egy másikba.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Célfájlszekrény/dokumentumtálca	DestinationFileCabinetID	True	string	Válassza ki a célfájlszekrényt vagy a dokumentumtálcát.
Áruház párbeszédpanel	StoreDialogID		string	Válassza ki az áthelyezett dokumentumok indexelését szolgáló tár párbeszédpanelt.
Forrásfájl-szekrény/dokumentumtálca	SourceFileCabinetId	True	string	Válassza ki a forrásfájl-szekrényt vagy a dokumentumtálcát.
azonosító	DocumentId		integer	Adjon meg egy dokumentumazonosítót.
Név	Name		string	Válasszon vagy adjon meg egy mezőnevet.
Érték	Value		string	Adjon meg egy mezőértéket.
Forrás megőrzése	KeepSource		boolean	Adja meg, hogy a forrásdokumentumokat törölni kell-e vagy sem.
Intellix kitöltése	FillIntellix		boolean	Adja meg, hogy a tároláshoz intelligens indexelést kell-e használni.

Válaszok

Name	Elérési út	Típus	Description
Számlál	Count	integer	Számlál
Documents	Documents	array of object	Documents
Szakaszok	Documents.Sections	array of object	Szakaszok
SignatureStatus	Documents.Sections.SignatureStatus	array of string	SignatureStatus
Szakaszazonosító	Documents.Sections.SectionId	string	Szakaszazonosító
TartalomTípus	Documents.Sections.ContentType	string	TartalomTípus
HaveMorePages	Documents.Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Documents.Sections.PageCount	integer	PageCount
Fájlméret	Documents.Sections.FileSize	integer	Fájlméret
OriginalFileName	Documents.Sections.OriginalFileName	string	OriginalFileName
ContentModified	Documents.Sections.ContentModified	string	ContentModified
HasTextAnnotation	Documents.Sections.HasTextAnnotation	boolean	HasTextAnnotation
SzéljegyzetekPreview	Documents.Sections.AnnotationsPreview	boolean	SzéljegyzetekPreview
DocumentId	Documents.DocumentId	integer	DocumentId
Indexmezők	Documents.IndexFields	object	Indexmezők
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Fájlméret	Documents.FileSize	integer	Fájlméret
TartalomTípus	Documents.ContentType	string	TartalomTípus
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

Fájl cseréje

Műveletazonosító:

ReplaceFile

Egy meglévő dokumentum fájlját/szakaszát cseréli le.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinet	True	string	Válassza ki a dokumentumot tartalmazó fájlszekrényt vagy dokumentumtálcát.
Dokumentumazonosító	DocumentID	True	integer	Adja meg a lecserélendő fájllal rendelkező dokumentum azonosítóját.
Fájlszám	FileNumber	True	integer	Adja meg a lecserélni kívánt fájlszámot.
Fájl tartalma	file		file	Adja meg a tárolni kívánt fájl tartalmát.

Válaszok

Name	Elérési út	Típus	Description
SignatureStatus	SignatureStatus	array of string	SignatureStatus
Szakaszazonosító	SectionId	string	Szakaszazonosító
TartalomTípus	ContentType	string	TartalomTípus
HaveMorePages	HaveMorePages	boolean	HaveMorePages
PageCount	PageCount	integer	PageCount
Fájlméret	FileSize	integer	Fájlméret
OriginalFileName	OriginalFileName	string	OriginalFileName
ContentModified	ContentModified	string	ContentModified
HasTextAnnotation	HasTextAnnotation	boolean	HasTextAnnotation
SzéljegyzetekPreview	AnnotationsPreview	boolean	SzéljegyzetekPreview

Fájl hozzáfűzése

Műveletazonosító:

AppendFile

Fájl/szakasz hozzáfűzése egy meglévő dokumentumhoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinet	True	string	Válassza ki a dokumentumot tartalmazó fájlszekrényt vagy dokumentumtálcát.
Dokumentumazonosító	DocID	True	string	Adja meg a hozzáfűzni kívánt dokumentum azonosítóját.
Fájl tartalma	file		file	Adja meg a tárolni kívánt fájl tartalmát.

Válaszok

Name	Elérési út	Típus	Description
SignatureStatus	SignatureStatus	array of string	SignatureStatus
Szakaszazonosító	SectionId	string	Szakaszazonosító
TartalomTípus	ContentType	string	TartalomTípus
HaveMorePages	HaveMorePages	boolean	HaveMorePages
PageCount	PageCount	integer	PageCount
Fájlméret	FileSize	integer	Fájlméret
OriginalFileName	OriginalFileName	string	OriginalFileName
ContentModified	ContentModified	string	ContentModified
HasTextAnnotation	HasTextAnnotation	boolean	HasTextAnnotation
SzéljegyzetekPreview	AnnotationsPreview	boolean	SzéljegyzetekPreview

Fájl letöltése

Műveletazonosító:

DownloadFile

Egy fájlszekrényben vagy tálcán tárolt dokumentum fájlját/szakaszát tölti le.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinetID	True	string	Válassza ki a dokumentumot tartalmazó fájlszekrényt vagy dokumentumtálcát.
Dokumentumazonosító	DocumentId	True	integer	Adja meg a letölteni kívánt fájllal rendelkező dokumentum azonosítóját.
Fájlszám	FileNumber	True	string	Adja meg a letölteni kívánt fájl fájlszámát.
Dokumentumformátum	DocumentFormat	True	string	Válassza ki a letöltött dokumentum formátumát.

Válaszok

Törzs

Törzs

binary

Fájl törlése

Műveletazonosító:

DeleteFile

Fájl/szakasz törlése meglévő dokumentumból.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinet	True	string	Válassza ki a dokumentumot tartalmazó fájlszekrényt vagy dokumentumtálcát.
Dokumentumazonosító	DocumentID	True	integer	Adja meg a törölni kívánt dokumentum azonosítóját.
Fájlszám	FileNumber	True	integer	Adja meg a törölni kívánt fájlszámot.

Fájlszekrény mezőinek lekérése

Műveletazonosító:

GetFileCabinetFields

Lekéri a fájlszekrény mezőinek listáját.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény	FileCabinet	True	string	Válassza ki a Fájlszekrény lehetőséget a mezők lekéréséhez.
Mezőtípus	FieldType		string	Válassza ki a visszaadni kívánt mezők típusát.

Válaszok

Name	Elérési út	Típus	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
Megjelenítendő név	Fields.TableFieldColumns.DisplayName	string	Megjelenítendő név
DropLeadingBlanks	Fields.TableFieldColumns.DropLeadingBlanks	boolean	DropLeadingBlanks
DropLeadingZero	Fields.TableFieldColumns.DropLeadingZero	boolean	DropLeadingZero
FieldInfoText	Fields.TableFieldColumns.FieldInfoText	string	FieldInfoText
FixEntry	Fields.TableFieldColumns.FixedEntry	string	FixEntry
Length	Fields.TableFieldColumns.Length	integer	Length
NotEmpty	Fields.TableFieldColumns.NotEmpty	boolean	NotEmpty
Precizitás	Fields.TableFieldColumns.Precision	integer	Precizitás
Scope	Fields.TableFieldColumns.Scope	string	Scope
UsedAsDocumentName	Fields.UsedAsDocumentName	boolean	UsedAsDocumentName
DBFieldName	Fields.DBFieldName	string	DBFieldName
DWFieldType	Fields.DWFieldType	string	DWFieldType
Megjelenítendő név	Fields.DisplayName	string	Megjelenítendő név
DropLeadingBlanks	Fields.DropLeadingBlanks	boolean	DropLeadingBlanks
DropLeadingZero	Fields.DropLeadingZero	boolean	DropLeadingZero
FieldInfoText	Fields.FieldInfoText	string	FieldInfoText
FixEntry	Fields.FixedEntry	string	FixEntry
Length	Fields.Length	integer	Length
NotEmpty	Fields.NotEmpty	boolean	NotEmpty
Precizitás	Fields.Precision	integer	Precizitás
Scope	Fields.Scope	string	Scope

Fájlszekrények és dokumentumtálcák lekérése

Műveletazonosító:

GetFileCabinets

Lekéri a fájlszekrények és/vagy dokumentumtálcák listáját.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény típusa	FileCabinetType	True	string	Válassza ki a visszaadni kívánt típusokat.

Válaszok

Name	Elérési út	Típus	Description
FileCabinets	FileCabinets	array of object	FileCabinets
Név	FileCabinets.Name	string	Név
GUID	FileCabinets.Guid	string	GUID
Szín	FileCabinets.Color	string	Szín
IsTray	FileCabinets.IsTray	boolean	IsTray

Importálás dokumentumtálcára

Műveletazonosító:

ImportToDocumentTray

Új dokumentum importálása egy dokumentumtálcába.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumtálca	DocumentTray	True	string	Jelölje ki azt a dokumentumtálcát, amelybe importálni szeretné.
Áruház párbeszédpanel	StoreDialogId		string	Válassza ki az importálás során használni kívánt tár párbeszédpanelt.
Indexadatok	index		string	Adja meg a dokumentum indexadatait.
Fájl tartalma	file		file	Adja meg az importálandó fájl tartalmát.

Válaszok

Name	Elérési út	Típus	Description
Szakaszok	Sections	array of object	Szakaszok
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
Szakaszazonosító	Sections.SectionId	string	Szakaszazonosító
TartalomTípus	Sections.ContentType	string	TartalomTípus
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Fájlméret	Sections.FileSize	integer	Fájlméret
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
SzéljegyzetekPreview	Sections.AnnotationsPreview	boolean	SzéljegyzetekPreview
DocumentId	DocumentId	integer	DocumentId
Indexmezők	IndexFields	object	Indexmezők
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Fájlméret	FileSize	integer	Fájlméret
TartalomTípus	ContentType	string	TartalomTípus
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

Indexmezők frissítése

Műveletazonosító:

UpdateIndexFields

Frissíti a dokumentum indexmezőit.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény	FileCabinetID	True	string	Válassza ki a frissíteni kívánt dokumentumot tartalmazó fájlszekrényt.
Dokumentumazonosító	DocumentID	True	integer	Adja meg a frissíteni kívánt dokumentum azonosítóját.
Név	Name		string	Jelöljön ki vagy adjon meg egy indexmezőt.
Érték	Value		string	Adjon meg egy indexértéket.

Válaszok

Name	Elérési út	Típus	Description
Szakaszok	Sections	array of object	Szakaszok
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
Szakaszazonosító	Sections.SectionId	string	Szakaszazonosító
TartalomTípus	Sections.ContentType	string	TartalomTípus
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Fájlméret	Sections.FileSize	integer	Fájlméret
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
SzéljegyzetekPreview	Sections.AnnotationsPreview	boolean	SzéljegyzetekPreview
DocumentId	DocumentId	integer	DocumentId
Indexmezők	IndexFields	object	Indexmezők
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Fájlméret	FileSize	integer	Fájlméret
TartalomTípus	ContentType	string	TartalomTípus
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

Keresés a fájlszekrényben

Műveletazonosító:

SearchForDocumentsInFileCabinet

Keressen egy fájlszekrényben a megadott feltételeknek megfelelő dokumentumokat.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény	FileCabinet	True	string	Válassza ki a keresendő fájlszekrényt.
Keresés párbeszédpanel	SearchDialogId	True	string	Válassza ki a kereséshez használni kívánt keresési párbeszédpanelt.
Keresési lekérdezés	SearchQuery	True

Válaszok

Name	Elérési út	Típus	Description
Számlál	Count	integer	Számlál
Documents	Documents	array of object	Documents
Szakaszok	Documents.Sections	array of	Szakaszok
DocumentId	Documents.DocumentId	integer	DocumentId
Indexmezők	Documents.IndexFields	object	Indexmezők
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Fájlméret	Documents.FileSize	integer	Fájlméret
TartalomTípus	Documents.ContentType	string	TartalomTípus
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árbeszédpanelek lekérése

Műveletazonosító:

GetDialogs

Lekéri a fájlszekrényhez vagy a dokumentumtálcához tartozó párbeszédpanelek listáját.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény/dokumentumtálca	FileCabinet	True	string	Válassza ki a fájlszekrényt vagy a dokumentumtálcát a párbeszédpanelek lekéréséhez.
Párbeszédpanel típusa	DialogType		string	Válassza ki a visszaadni kívánt párbeszédpanelek típusát.

Válaszok

Name	Elérési út	Típus	Description
Dialogs	Dialogs	array of object	Dialogs
Név	Dialogs.Name	string	Név
GUID	Dialogs.Guid	string	GUID
Szín	Dialogs.Color	string	Szín
Alapértelmezett	Dialogs.IsDefault	boolean	Alapértelmezett
Típus	Dialogs.Type	string	Típus
FileCabinetId	Dialogs.FileCabinetId	string	FileCabinetId

Párbeszédpanelmezők lekérése

Műveletazonosító:

GetDialogFields

Párbeszédpanel mezőinek lekérdezése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény	FileCabinet	True	string	Válassza ki a fájlszekrényt
Dialog	DialogId	True	string	Válassza ki a párbeszédpanelt a mezők lekéréséhez.

Válaszok

Name	Elérési út	Típus	Description
Fields	Fields	array of object	Fields
DBFieldName	Fields.DBFieldName	string	DBFieldName
DWFieldType	Fields.DWFieldType	string	DWFieldType
Megjelenítendő név	Fields.DisplayName	string	Megjelenítendő név
ReadOnly	Fields.ReadOnly	boolean	ReadOnly
Látható	Fields.Visible	boolean	Látható

Szervezet lekérése

Műveletazonosító:

GetOrganization

Kérje le a szervezet nevét.

Válaszok

Name	Elérési út	Típus	Description
Név	Name	string	Név

Tárolás fájlszekrénybe

Műveletazonosító:

StoreToFileCabinet

Új dokumentumot tárol egy fájlszekrényben.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlszekrény	FileCabinet	True	string	Válassza ki azt a fájlszekrényt, amelybe tárolni szeretné.
Áruház párbeszédpanel	StoreDialogId	True	string	Válassza ki a tároláshoz használni kívánt tár párbeszédpanelt.
Indexadatok	index		string	Adja meg a dokumentum indexadatait.
Fájl tartalma	file		file	Adja meg a tárolni kívánt fájl tartalmát.

Válaszok

Name	Elérési út	Típus	Description
Szakaszok	Sections	array of object	Szakaszok
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
Szakaszazonosító	Sections.SectionId	string	Szakaszazonosító
TartalomTípus	Sections.ContentType	string	TartalomTípus
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Fájlméret	Sections.FileSize	integer	Fájlméret
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
SzéljegyzetekPreview	Sections.AnnotationsPreview	boolean	SzéljegyzetekPreview
DocumentId	DocumentId	integer	DocumentId
Indexmezők	IndexFields	object	Indexmezők
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Fájlméret	FileSize	integer	Fájlméret
TartalomTípus	ContentType	string	TartalomTípus
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

Definíciók

bináris

Ez a bináris alapszintű adattípus.