DocuWare

Få åtkomst till vanliga DocuWare-funktioner inifrån dina flöden.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

Kontakt
Namn	DocuWare GmbH
URL	https://support.docuware.com
E-postmeddelande	support@docuware.com

Metadata för anslutningsprogram
Utgivare	DocuWare
Webbplats	https://start.docuware.com
Sekretesspolicy	https://start.docuware.com/data-privacy
Kategorier	Innehåll och filer; Produktivitet

DocuWare tillhandahåller ett kraftfullt och omfattande REST API. Med DocuWares Power Automate Connector kan användarna nu utnyttja många av de vanligaste funktionerna i DocuWare REST API i Power Automate. Detta ger användaren större flexibilitet att skapa flöden som helt uppfyller deras affärsbehov tack vare den sömlösa integreringen med DocuWare.

Förutsättningar

Du behöver följande för att fortsätta:

• En DocuWare Cloud-prenumeration
• Ett Microsoft Power Apps- eller Power Automate-konto

Hämta autentiseringsuppgifter

Det är enkelt att skapa en ny API-nyckel och kan göras inifrån DocuWare.

Följ dessa steg för att skapa en ny API-nyckel i DocuWare:

1. Logga in på ditt DocuWare-konto som du vill använda med Power Automate
2. Från huvudmenyn går du till "Konfigurationer"
3. Från sidan "Konfigurationer" går du till avsnittet "Integreringar" och klickar på ikonen för "Power Automate API Keys"
   • Om du inte ser ikonen "Power Automate API Keys" är det möjligt att användaren inte har rätt behörigheter. Kontakta DocuWare-administratören för att lösa detta.
4. Klicka på knappen Skapa API-nyckel
5. Fyll i värdena "Namn" och "Beskrivning" (valfritt) och klicka på "Skapa"
   • När du har tryckt på Skapa kan det uppstå en liten fördröjning när konfigurationsprocessen skapar din nyckel.
   • Se också till att spara din API-nyckel. Det här är din enda möjlighet att visa den fullständiga API-nyckeln. Om du förlorar den här nyckeln måste du skapa en till.

Nu har du en giltig API-nyckel som kan användas i Power Automate för att skapa en anslutning till DocuWare. Den här anslutningen kan sedan användas med DocuWare Power Automate Connector.

Kom igång med anslutningsappen

Det är enkelt att skapa en anslutning i Power Automate och du kan göra det när du skapar dina flöden.

Följ dessa steg för att skapa en ny anslutning i Power Automate:

1. Logga in på Power Automate
2. Skapa ett nytt flöde eller öppna ett befintligt flöde
3. Lägga till en aktivitet från DocuWare Power Automate-anslutningsappen i ditt flöde
   • Klicka på "+ Nytt steg" för att lägga till ett nytt steg i flödet
   • När du ser "Välj en åtgärd" väljer du "Alla" i kategorivalet och skriver sedan "DocuWare" i sökfältet.
   • Välj anslutningsappen "DocuWare" och välj sedan i listan över tillgängliga åtgärder.
4. När åtgärden läggs till i flödet uppmanas du att skapa en ny anslutning.
5. Ange ett anslutningsnamn ("Anslutningsnamn") och DEN API-nyckel ("API-nyckel") som du fick från DocuWare i föregående avsnitt och klicka på "Skapa".

Från och med nu använder alla aktiviteter som läggs till från DocuWare-anslutningsappen den här anslutningen. Du kan skapa ytterligare anslutningar genom att klicka på "..." i det övre högra hörnet av en aktivitet och klicka sedan på "+ Lägg till ny anslutning" längst ned på menyn som visas.

Kända problem och begränsningar

För närvarande stöds inte DocuWares Power Automate-anslutningsprogram i den nya Power Automate Flow-designern.

Vanliga fel och åtgärder

HTTP-felkoder:

• 400: Kontrollera att du har fyllt i alla obligatoriska fält i aktiviteten. Vissa fält krävs och måste fyllas i innan aktiviteten kan köras.
• 401: Kontrollera att du har angett rätt API-nyckel. Du kan också kontrollera statusen för API-nyckeln på sidan "Konfigurationer" under "Integreringar" –> "Power Automate API Keys".
• 404: Kontrollera att det angivna dokumentet och/eller filskåpet finns och att du har åtkomst till dem. Om dokumentet eller filskåpet inte finns, eller om du inte har åtkomst till dem, får du ett fel 404.
• 500: Det här är ett allmänt fel som kan orsakas av ett antal olika problem. Om du får det här felet kontaktar du DocuWare-supporten för att få hjälp.

Vanliga frågor

Metodtips

Följande är några av de bästa metoderna som vi rekommenderar när du använder DocuWare Power Automate Connector:

• Använd alltid en dedikerad DocuWare-användare för autentisering med DocuWare Power Automate Connector. På så sätt kan du enkelt spåra och hantera de åtgärder som utförs av anslutningsappen.
• Börja med att testa ditt flöde med aktiviteten "Hämta organisation". Det här är den mest grundläggande åtgärden i DocuWare Power Automate Connector och gör att du kan kontrollera att anslutningen fungerar korrekt.

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:

Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
API-nyckel	securestring	API-nyckeln för åtkomst till DocuWare	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Ersätt en fil	Ersätter en fil/ett avsnitt i ett befintligt dokument.
Hämta dialogfält	Hämtar fälten för en dialogruta
Hämta dialogrutor	Hämtar en lista med dialogrutor för ett filskåp eller ett dokumentfack.
Hämta dokumentinformation	Hämtar information om ett dokument.
Hämta filskåp och dokumentfack	Hämtar en lista över filskåp och/eller dokumentfack.
Hämta filskåpsfält	Hämtar en lista med fält för ett filskåp.
Hämta organisation	Hämta organisationsnamnet.
Hämta stämpelfält	Hämtar en lista med fält för en stämpel.
Hämta stämplar	Hämtar en lista över stämplar för ett filskåp eller ett dokumentfack.
Importera till dokumentfältet	Importera ett nytt dokument till ett dokumentfack.
Ladda ned en fil	Laddar ned en fil/del av ett dokument som lagras i ett filskåp eller ett dokumentfack.
Ladda ned ett dokument	Laddar ned ett dokument från ett filskåp eller ett dokumentfack.
Lagra i filskåp	Lagrar ett nytt dokument i ett filskåp.
Lägga till en fil	Lägger till en fil/ett avsnitt i ett befintligt dokument.
Placera en stämpel	Placerar en stämpel på ett dokument.
Sök i filskåp	Sök i ett filskåp efter dokument som matchar de angivna kriterierna.
Ta bort en fil	Tar bort en fil/ett avsnitt från ett befintligt dokument.
Ta bort ett dokument	Tar bort ett dokument från ett filskåp eller dokumentfack.
Uppdatera indexfält	Uppdaterar indexfälten i ett dokument.
Visa en lista över dokument i dokumentfältet	Visa en lista över dokument från det angivna dokumentfältet.
Överföra dokument	Flyttar ett eller flera dokument från ett filskåp/dokumentfack till ett annat.

Ersätt en fil

Åtgärds-ID:

ReplaceFile

Ersätter en fil/ett avsnitt i ett befintligt dokument.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinet	True	string	Välj arkivskåp eller dokumentfack med dokumentet.
Dokument-ID	DocumentID	True	integer	Ange ID för dokumentet med den fil som ska ersättas.
Filnummer	FileNumber	True	integer	Ange det filnummer som ska ersättas.
Filinnehåll	file		file	Ange innehållet i filen som ska lagras.

Returer

Name	Sökväg	Typ	Description
SignatureStatus	SignatureStatus	array of string	SignatureStatus
SectionId	SectionId	string	SectionId
Innehållstyp	ContentType	string	Innehållstyp
HaveMorePages	HaveMorePages	boolean	HaveMorePages
PageCount	PageCount	integer	PageCount
Filstorlek	FileSize	integer	Filstorlek
OriginalFileName	OriginalFileName	string	OriginalFileName
ContentModified	ContentModified	string	ContentModified
HasTextAnnotation	HasTextAnnotation	boolean	HasTextAnnotation
AnteckningarFörhandsvisning	AnnotationsPreview	boolean	AnteckningarFörhandsvisning

Hämta dialogfält

Åtgärds-ID:

GetDialogFields

Hämtar fälten för en dialogruta

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Filskåp	FileCabinet	True	string	Välj filskåpet
Dialog	DialogId	True	string	Välj den dialogruta som fälten ska hämtas för.

Returer

Name	Sökväg	Typ	Description
Fields	Fields	array of object	Fields
DBFieldName	Fields.DBFieldName	string	DBFieldName
DWFieldType	Fields.DWFieldType	string	DWFieldType
visningsnamn	Fields.DisplayName	string	visningsnamn
ReadOnly	Fields.ReadOnly	boolean	ReadOnly
Synlig	Fields.Visible	boolean	Synlig

Hämta dialogrutor

Åtgärds-ID:

GetDialogs

Hämtar en lista med dialogrutor för ett filskåp eller ett dokumentfack.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinet	True	string	Välj det arkivskåp eller dokumentfack som du vill hämta dialogrutor från.
Dialogtyp	DialogType		string	Välj vilken typ av dialogrutor som ska returneras.

Returer

Name	Sökväg	Typ	Description
Dialogs	Dialogs	array of object	Dialogs
Namn	Dialogs.Name	string	Namn
Guide	Dialogs.Guid	string	Guide
Färg	Dialogs.Color	string	Färg
IsDefault	Dialogs.IsDefault	boolean	IsDefault
Typ	Dialogs.Type	string	Typ
FileCabinetId	Dialogs.FileCabinetId	string	FileCabinetId

Hämta dokumentinformation

Åtgärds-ID:

GetDocumentInformation

Hämtar information om ett dokument.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinetID	True	string	Välj arkivskåp eller dokumentfack med dokumentet.
Dokument-ID	DocumentID	True	integer	Ange ID för det dokument som du vill ha information om.

Returer

Name	Sökväg	Typ	Description
Sektioner	Sections	array of object	Sektioner
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
Innehållstyp	Sections.ContentType	string	Innehållstyp
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Filstorlek	Sections.FileSize	integer	Filstorlek
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnteckningarFörhandsvisning	Sections.AnnotationsPreview	boolean	AnteckningarFörhandsvisning
DocumentId	DocumentId	integer	DocumentId
IndexFält	IndexFields	object	IndexFält
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Filstorlek	FileSize	integer	Filstorlek
Innehållstyp	ContentType	string	Innehållstyp
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

Hämta filskåp och dokumentfack

Åtgärds-ID:

GetFileCabinets

Hämtar en lista över filskåp och/eller dokumentfack.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Filskåpstyp	FileCabinetType	True	string	Välj vilka typer du vill returnera.

Returer

Name	Sökväg	Typ	Description
FileCabinets	FileCabinets	array of object	FileCabinets
Namn	FileCabinets.Name	string	Namn
Guide	FileCabinets.Guid	string	Guide
Färg	FileCabinets.Color	string	Färg
IsTray	FileCabinets.IsTray	boolean	IsTray

Hämta filskåpsfält

Åtgärds-ID:

GetFileCabinetFields

Hämtar en lista med fält för ett filskåp.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Filskåp	FileCabinet	True	string	Välj det filskåp som du vill hämta fält för.
Fälttyp	FieldType		string	Välj vilken typ av fält som ska returneras.

Returer

Name	Sökväg	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
visningsnamn	Fields.TableFieldColumns.DisplayName	string	visningsnamn
DropLeadingBlanks	Fields.TableFieldColumns.DropLeadingBlanks	boolean	DropLeadingBlanks
DropLeadingZero	Fields.TableFieldColumns.DropLeadingZero	boolean	DropLeadingZero
FieldInfoText	Fields.TableFieldColumns.FieldInfoText	string	FieldInfoText
FixedEntry	Fields.TableFieldColumns.FixedEntry	string	FixedEntry
Length	Fields.TableFieldColumns.Length	integer	Length
NotEmpty	Fields.TableFieldColumns.NotEmpty	boolean	NotEmpty
Noggrannhet	Fields.TableFieldColumns.Precision	integer	Noggrannhet
Omfång	Fields.TableFieldColumns.Scope	string	Omfång
UsedAsDocumentName	Fields.UsedAsDocumentName	boolean	UsedAsDocumentName
DBFieldName	Fields.DBFieldName	string	DBFieldName
DWFieldType	Fields.DWFieldType	string	DWFieldType
visningsnamn	Fields.DisplayName	string	visningsnamn
DropLeadingBlanks	Fields.DropLeadingBlanks	boolean	DropLeadingBlanks
DropLeadingZero	Fields.DropLeadingZero	boolean	DropLeadingZero
FieldInfoText	Fields.FieldInfoText	string	FieldInfoText
FixedEntry	Fields.FixedEntry	string	FixedEntry
Length	Fields.Length	integer	Length
NotEmpty	Fields.NotEmpty	boolean	NotEmpty
Noggrannhet	Fields.Precision	integer	Noggrannhet
Omfång	Fields.Scope	string	Omfång

Hämta organisation

Åtgärds-ID:

GetOrganization

Hämta organisationsnamnet.

Returer

Name	Sökväg	Typ	Description
Namn	Name	string	Namn

Hämta stämpelfält

Åtgärds-ID:

GetStampFields

Hämtar en lista med fält för en stämpel.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinet	True	string	Välj arkivskåp eller dokumentfack med önskad stämpel.
Frimärke	Stamp	True	string	Välj stämpeln för att hämta dess fält.

Returer

Name	Sökväg	Typ	Description
Fields	Fields	array of object	Fields
Id	Fields.Id	string	Id
Etikett	Fields.Label	string	Etikett
visningsnamn	Fields.DisplayName	string	visningsnamn

Hämta stämplar

Åtgärds-ID:

GetStamps

Hämtar en lista över stämplar för ett filskåp eller ett dokumentfack.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinet	True	string	Välj det arkivskåp eller dokumentfack som du vill hämta stämplar från.

Returer

Name	Sökväg	Typ	Description
Album	Stamps	array of object	Album
Id	Stamps.Id	string	Id
Namn	Stamps.Name	string	Namn
visningsnamn	Stamps.DisplayName	string	visningsnamn
Färg	Stamps.Color	string	Färg
Signature	Stamps.Signature	string	Signature
PasswordProtected	Stamps.PasswordProtected	boolean	PasswordProtected
Skriv över	Stamps.Overwrite	boolean	Skriv över
Typ	Stamps.Type	string	Typ
FileCabinetId	Stamps.FileCabinetId	string	FileCabinetId

Importera till dokumentfältet

Åtgärds-ID:

ImportToDocumentTray

Importera ett nytt dokument till ett dokumentfack.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokumentfack	DocumentTray	True	string	Välj det dokumentfack som du vill importera till.
Dialogrutan Arkiv	StoreDialogId		string	Välj den lagringsdialogruta som ska användas under importen.
Indexdata	index		string	Ange indexdata för dokumentet.
Filinnehåll	file		file	Ange innehållet i filen som ska importeras.

Returer

Name	Sökväg	Typ	Description
Sektioner	Sections	array of object	Sektioner
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
Innehållstyp	Sections.ContentType	string	Innehållstyp
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Filstorlek	Sections.FileSize	integer	Filstorlek
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnteckningarFörhandsvisning	Sections.AnnotationsPreview	boolean	AnteckningarFörhandsvisning
DocumentId	DocumentId	integer	DocumentId
IndexFält	IndexFields	object	IndexFält
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Filstorlek	FileSize	integer	Filstorlek
Innehållstyp	ContentType	string	Innehållstyp
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

Ladda ned en fil

Åtgärds-ID:

DownloadFile

Laddar ned en fil/del av ett dokument som lagras i ett filskåp eller ett dokumentfack.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinetID	True	string	Välj arkivskåp eller dokumentfack med dokumentet.
Dokument-ID	DocumentId	True	integer	Ange ID för dokumentet med den fil som du vill ladda ned.
Filnummer	FileNumber	True	string	Ange filnumret för den fil som du vill ladda ned.
Dokumentformat	DocumentFormat	True	string	Välj formatet för det nedladdade dokumentet.

Returer

Body

Body

binary

Ladda ned ett dokument

Åtgärds-ID:

DownloadDocument

Laddar ned ett dokument från ett filskåp eller ett dokumentfack.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinetID	True	string	Välj arkivskåp eller dokumentfack med dokumentet.
Dokument-ID	DocumentId	True	integer	Ange ID för det dokument som du vill ladda ned.
Dokumentformat	DocumentFormat	True	string	Välj formatet för det nedladdade dokumentet.

Returer

Body

Body

binary

Lagra i filskåp

Åtgärds-ID:

StoreToFileCabinet

Lagrar ett nytt dokument i ett filskåp.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Filskåp	FileCabinet	True	string	Välj det filskåp som du vill lagra i.
Dialogrutan Arkiv	StoreDialogId	True	string	Välj den lagringsdialogruta som ska användas för lagring.
Indexdata	index		string	Ange indexdata för dokumentet.
Filinnehåll	file		file	Ange innehållet i filen som ska lagras.

Returer

Name	Sökväg	Typ	Description
Sektioner	Sections	array of object	Sektioner
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
Innehållstyp	Sections.ContentType	string	Innehållstyp
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Filstorlek	Sections.FileSize	integer	Filstorlek
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnteckningarFörhandsvisning	Sections.AnnotationsPreview	boolean	AnteckningarFörhandsvisning
DocumentId	DocumentId	integer	DocumentId
IndexFält	IndexFields	object	IndexFält
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Filstorlek	FileSize	integer	Filstorlek
Innehållstyp	ContentType	string	Innehållstyp
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

Lägga till en fil

Åtgärds-ID:

AppendFile

Lägger till en fil/ett avsnitt i ett befintligt dokument.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinet	True	string	Välj arkivskåp eller dokumentfack med dokumentet.
Dokument-ID	DocID	True	string	Ange ID för dokumentet som ska läggas till i.
Filinnehåll	file		file	Ange innehållet i filen som ska lagras.

Returer

Name	Sökväg	Typ	Description
SignatureStatus	SignatureStatus	array of string	SignatureStatus
SectionId	SectionId	string	SectionId
Innehållstyp	ContentType	string	Innehållstyp
HaveMorePages	HaveMorePages	boolean	HaveMorePages
PageCount	PageCount	integer	PageCount
Filstorlek	FileSize	integer	Filstorlek
OriginalFileName	OriginalFileName	string	OriginalFileName
ContentModified	ContentModified	string	ContentModified
HasTextAnnotation	HasTextAnnotation	boolean	HasTextAnnotation
AnteckningarFörhandsvisning	AnnotationsPreview	boolean	AnteckningarFörhandsvisning

Placera en stämpel

Åtgärds-ID:

PlaceAStamp

Placerar en stämpel på ett dokument.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinetID	True	string	Välj arkivskåp eller dokumentfack med dokumentet.
Dokument-ID	DocumentID	True	integer	Ange ID för det dokument som du vill stämpla.
Filnummer	FileNumber	True	integer	Ange filen/avsnittet som innehåller den sida som ska stämplas.
Sidnummer	PageNumber	True	integer	Ange det sidnummer som stämpeln ska vara på.
Skikt	Layer	True	integer	Ange dokumentskiktet för att placera stämpeln på [1–5]
Vågrät position (X-position)	PositionX		number	[Valfritt] Placera från sidans vänstra kant i mm.
Lodrät position (Y-position)	PositionY		number	[Valfritt] Placera från sidans övre kant i mm.
Frimärke	StampId	True	string	Välj eller ange den stämpel som ska användas.
Lösenord	Password		string	Ange lösenordet för stämpeln (om det behövs).
Namn	Name		string	Ange ett fältnamn.
Värde	Value		string	Ange ett fältvärde.

Returer

Name	Sökväg	Typ	Description
User	Created.User	string	User
Time	Created.Time	string	Time
Typ	Type	string	Typ
Färg	Color	string	Färg
Rotation	Rotation	integer	Rotation
Transparent	Transparent	boolean	Transparent
StrokeWidth	StrokeWidth	integer	StrokeWidth
Guide	Guid	string	Guide

Sök i filskåp

Åtgärds-ID:

SearchForDocumentsInFileCabinet

Sök i ett filskåp efter dokument som matchar de angivna kriterierna.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Filskåp	FileCabinet	True	string	Välj det filskåp som ska sökas igenom.
Sökdialogruta	SearchDialogId	True	string	Välj den sökdialogruta som ska användas för sökning.
Sökfråga	SearchQuery	True

Returer

Name	Sökväg	Typ	Description
Räkna	Count	integer	Räkna
Documents	Documents	array of object	Documents
Sektioner	Documents.Sections	array of	Sektioner
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFält	Documents.IndexFields	object	IndexFält
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Filstorlek	Documents.FileSize	integer	Filstorlek
Innehållstyp	Documents.ContentType	string	Innehållstyp
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

Ta bort en fil

Åtgärds-ID:

DeleteFile

Tar bort en fil/ett avsnitt från ett befintligt dokument.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinet	True	string	Välj arkivskåp eller dokumentfack med dokumentet.
Dokument-ID	DocumentID	True	integer	Ange ID för dokumentet som du vill ta bort från.
Filnummer	FileNumber	True	integer	Ange det filnummer som ska tas bort.

Ta bort ett dokument

Åtgärds-ID:

DeleteDocument

Tar bort ett dokument från ett filskåp eller dokumentfack.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arkivskåp/dokumentfack	FileCabinetID	True	string	Välj arkivskåp eller dokumentfack med dokumentet.
Dokument-ID	DocumentID	True	integer	Ange ID för det dokument som du vill ta bort.

Uppdatera indexfält

Åtgärds-ID:

UpdateIndexFields

Uppdaterar indexfälten i ett dokument.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Filskåp	FileCabinetID	True	string	Välj filskåpet med det dokument som ska uppdateras.
Dokument-ID	DocumentID	True	integer	Ange ID för dokumentet som ska uppdateras.
Namn	Name		string	Välj eller ange ett indexfält.
Värde	Value		string	Ange ett indexvärde.

Returer

Name	Sökväg	Typ	Description
Sektioner	Sections	array of object	Sektioner
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
Innehållstyp	Sections.ContentType	string	Innehållstyp
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Filstorlek	Sections.FileSize	integer	Filstorlek
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnteckningarFörhandsvisning	Sections.AnnotationsPreview	boolean	AnteckningarFörhandsvisning
DocumentId	DocumentId	integer	DocumentId
IndexFält	IndexFields	object	IndexFält
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Filstorlek	FileSize	integer	Filstorlek
Innehållstyp	ContentType	string	Innehållstyp
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

Visa en lista över dokument i dokumentfältet

Åtgärds-ID:

ListDocumentsInDocumentTray

Visa en lista över dokument från det angivna dokumentfältet.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokumentfack	DocumentTray	True	string	Välj det dokumentfack som du vill söka i.

Returer

Name	Sökväg	Typ	Description
Räkna	Count	integer	Räkna
Documents	Documents	array of object
Sektioner	Documents.Sections	array of	Sektioner
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFält	Documents.IndexFields	object	IndexFält
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Filstorlek	Documents.FileSize	integer	Filstorlek
Innehållstyp	Documents.ContentType	string	Innehållstyp
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

Överföra dokument

Åtgärds-ID:

TransferDocument

Flyttar ett eller flera dokument från ett filskåp/dokumentfack till ett annat.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Målfilskåp/dokumentfack	DestinationFileCabinetID	True	string	Välj målfilskåpet eller dokumentfältet.
Dialogrutan Arkiv	StoreDialogID		string	Välj dialogrutan Arkiv för indexering av dokument som flyttas.
Källfilskåp/dokumentfack	SourceFileCabinetId	True	string	Välj källfilskåpet eller dokumentfältet.
ID-nummer	DocumentId		integer	Ange ett dokument-ID.
Namn	Name		string	Välj eller ange ett fältnamn.
Värde	Value		string	Ange ett fältvärde.
Behåll källa	KeepSource		boolean	Välj om källdokumenten ska tas bort eller inte.
Fyll Intellix	FillIntellix		boolean	Välj om intelligent indexering ska användas vid lagring.

Returer

Name	Sökväg	Typ	Description
Räkna	Count	integer	Räkna
Documents	Documents	array of object	Documents
Sektioner	Documents.Sections	array of object	Sektioner
SignatureStatus	Documents.Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Documents.Sections.SectionId	string	SectionId
Innehållstyp	Documents.Sections.ContentType	string	Innehållstyp
HaveMorePages	Documents.Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Documents.Sections.PageCount	integer	PageCount
Filstorlek	Documents.Sections.FileSize	integer	Filstorlek
OriginalFileName	Documents.Sections.OriginalFileName	string	OriginalFileName
ContentModified	Documents.Sections.ContentModified	string	ContentModified
HasTextAnnotation	Documents.Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnteckningarFörhandsvisning	Documents.Sections.AnnotationsPreview	boolean	AnteckningarFörhandsvisning
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFält	Documents.IndexFields	object	IndexFält
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Filstorlek	Documents.FileSize	integer	Filstorlek
Innehållstyp	Documents.ContentType	string	Innehållstyp
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

Definitioner

binär

Det här är den grundläggande datatypen "binär".