DocuWare

Accedere alle funzionalità DocuWare comuni dall'interno dei flussi.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio	Class	Regions
Copilot Studio	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica	Normale	Tutte le aree di App per la logica , ad eccezione delle seguenti:      - Aree di Azure per enti pubblici      - Aree di Azure Cina      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Di alta qualità	Tutte le aree di Power Apps , ad eccezione dei seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
Nome	DocuWare GmbH
URL	https://support.docuware.com
Email	support@docuware.com

Metadati del connettore
Editore	DocuWare
Sito web	https://start.docuware.com
Informativa sulla privacy	https://start.docuware.com/data-privacy
Categorie	Contenuto e file; Produttività

DocuWare offre un'API REST potente e completa. Con il connettore Power Automate di DocuWare, gli utenti possono ora sfruttare molte delle funzionalità più comuni dell'API REST DocuWare in Power Automate. Ciò consente all'utente una maggiore flessibilità di creare flussi che soddisfano completamente le proprie esigenze aziendali, grazie alla perfetta integrazione con DocuWare.

Prerequisiti

Per procedere, è necessario quanto segue:

• Sottoscrizione di DocuWare Cloud
• Un account Di Microsoft Power Apps o Power Automate

Come ottenere le credenziali

La creazione di una nuova chiave API è semplice e può essere eseguita da DocuWare.

Seguire questa procedura per creare una nuova chiave API in DocuWare:

1. Accedere all'account DocuWare da usare con Power Automate
2. Dal menu principale passare a "Configurazioni"
3. Nella pagina "Configurazioni" passare alla sezione "Integrazioni" e fare clic sull'icona "Chiavi API di Power Automate"
   • Se non viene visualizzata l'icona "Chiavi API di Power Automate", è possibile che l'utente non disponga delle autorizzazioni corrette. Per risolvere il problema, contattare l'amministratore di DocuWare.
4. Fare clic sul pulsante "Crea chiave API"
5. Compilare i valori "Name" e "Description" (facoltativo) e fare clic su "Crea"
   • Dopo aver premuto "Crea", potrebbe verificarsi un lieve ritardo perché il processo di configurazione crea il tasto.
   • Assicurarsi anche di salvare la chiave API. Questa sarà l'unica opportunità per visualizzare la chiave API completa. Se si perde questa chiave, sarà necessario crearne un'altra.

A questo punto, è ora disponibile una chiave API valida che può essere usata in Power Automate per creare una connessione a DocuWare. Questa connessione può quindi essere usata con il connettore DocuWare Power Automate.

Introduzione al connettore

La creazione di una connessione in Power Automate è semplice e può essere eseguita quando si creano i flussi.

Seguire questa procedura per creare una nuova connessione in Power Automate:

1. Accedere a Power Automate
2. Creare un nuovo flusso o aprire un flusso esistente
3. Aggiungere un'attività dal connettore DocuWare Power Automate al flusso
   • Fare clic su "+ Nuovo passaggio" per aggiungere un nuovo passaggio al flusso
   • Quando viene visualizzato "Scegliere un'operazione", selezionare "Tutto" nella selezione della categoria e quindi digitare "DocuWare" nel campo di ricerca.
   • Selezionare il connettore "DocuWare" e quindi scegliere dall'elenco delle azioni disponibili.
4. Quando l'azione viene aggiunta al flusso, verrà richiesto di creare una nuova connessione.
5. Immettere un nome di connessione ("Nome connessione") e la chiave API ("Chiave API") ricevuta da DocuWare nella sezione precedente e fare clic su "Crea".

Da questo punto in poi, tutte le attività aggiunte dal connettore DocuWare useranno questa connessione. È possibile creare connessioni aggiuntive facendo clic su "..." nell'angolo superiore destro di un'attività e quindi fare clic su "+ Aggiungi nuova connessione" nella parte inferiore del menu visualizzato.

Problemi noti e limitazioni

Al momento, il connettore Power Automate di DocuWare non è supportato nella nuova finestra di progettazione del flusso di Power Automate.

Errori e rimedi comuni

Codici di errore HTTP:

• 400: assicurarsi di aver compilato tutti i campi obbligatori nell'attività. Alcuni campi sono obbligatori e devono essere compilati prima dell'esecuzione dell'attività.
• 401: Assicurarsi di aver immesso la chiave API corretta. È anche possibile controllare lo stato della chiave API nella pagina "Configurazioni", in "Integrazioni" -> "Chiavi API di Power Automate".
• 404: assicurarsi che il documento e/o l'archivio file specificato esistano e che sia possibile accedervi. Se il documento o l'archivio file non esiste o non si ha accesso a tali documenti, verrà visualizzato un errore 404.
• 500: si tratta di un errore generico che può essere causato da diversi problemi. Se viene visualizzato questo errore, contattare il supporto docuWare per assistenza.

Domande frequenti

Migliori pratiche

Di seguito sono riportate alcune delle procedure consigliate per l'uso del connettore DocuWare Power Automate:

• Usare sempre un utente DocuWare dedicato per l'autenticazione con il connettore DocuWare Power Automate. In questo modo sarà possibile tenere traccia e gestire facilmente le azioni eseguite dal connettore.
• Per iniziare, testare il flusso con l'attività "Ottieni organizzazione". Questa è l'azione più semplice fornita nel connettore DocuWare Power Automate e consente di verificare che la connessione funzioni correttamente.

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

Predefinita	Parametri per la creazione della connessione.	Tutte le aree geografiche	Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome	TIPO	Description	Obbligatorio
Chiave dell'API	securestring	Chiave API per l'accesso a DocuWare	Vero

Limiti per la limitazione delle richieste

Nome	Chiamate	Periodo di rinnovo
Chiamate API per connessione	100	60 secondi

Azioni

Aggiornare i campi dell'indice	Aggiorna i campi di indice di un documento.
Aggiungere un file	Aggiunge un file o una sezione a un documento esistente.
Archiviare nel file cab	Archivia un nuovo documento in un archivio file.
Cercare nell'archivio file	Cercare documenti corrispondenti ai criteri specificati in un archivio file.
Elencare i documenti nella barra dei documenti	Elencare i documenti dalla barra dei documenti specificata.
Eliminare un file	Elimina un file o una sezione da un documento esistente.
Eliminazione di un documento	Elimina un documento da un archivio file o da una barra dei documenti.
Importa nella barra dei documenti	Importare un nuovo documento in una barra dei documenti.
Ottenere archivi file e vassoi dei documenti	Ottiene un elenco di archivi file e/o contenitori di documenti.
Ottenere finestre di dialogo	Ottiene un elenco di dialoghi per un archivio file o una barra dei documenti.
Ottenere francobolli	Ottiene un elenco di timbri per un archivio file o un vassoio di documenti.
Ottenere i campi della finestra di dialogo	Ottiene i campi per una finestra di dialogo
Ottenere i campi file cabinet	Ottiene un elenco di campi per un file cab.
Ottenere i campi stamp	Ottiene un elenco di campi per un timbro.
Ottenere informazioni sul documento	Ottiene informazioni su un documento.
Ottenere l'organizzazione	Ottenere il nome dell'organizzazione.
Posizionare un timbro	Inserisce un timbro su un documento.
Scaricare un documento	Scarica un documento da un archivio file o da una barra dei documenti.
Scaricare un file	Scarica un file o una sezione di un documento archiviato in un archivio file o in una barra dei documenti.
Sostituire un file	Sostituisce un file o una sezione in un documento esistente.
Trasferire documenti	Sposta uno o più documenti da un archivio file/cassetto documenti a un altro.

Aggiornare i campi dell'indice

ID operazione:

UpdateIndexFields

Aggiorna i campi di indice di un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
File Cabinet	FileCabinetID	True	string	Selezionare l'archivio file con il documento da aggiornare.
ID documento	DocumentID	True	integer	Specificare l'ID del documento da aggiornare.
Nome	Name		string	Selezionare o specificare un campo di indice.
Value	Value		string	Specificare un valore di indice.

Restituisce

Nome	Percorso	Tipo	Descrizione
Sezioni	Sections	array of object	Sezioni
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
Tipo di Contenuto	Sections.ContentType	string	Tipo di Contenuto
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Dimensione del file	Sections.FileSize	integer	Dimensione del file
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnnotazioniPreview	Sections.AnnotationsPreview	boolean	AnnotazioniPreview
DocumentId	DocumentId	integer	DocumentId
IndexFields	IndexFields	object	IndexFields
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Dimensione del file	FileSize	integer	Dimensione del file
Tipo di Contenuto	ContentType	string	Tipo di Contenuto
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

Aggiungere un file

ID operazione:

AppendFile

Aggiunge un file o una sezione a un documento esistente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinet	True	string	Selezionare l'archivio file o la barra dei documenti con il documento.
ID documento	DocID	True	string	Specificare l'ID del documento a cui aggiungere.
Contenuto del file	file		file	Specificare il contenuto del file da archiviare.

Restituisce

Nome	Percorso	Tipo	Descrizione
SignatureStatus	SignatureStatus	array of string	SignatureStatus
SectionId	SectionId	string	SectionId
Tipo di Contenuto	ContentType	string	Tipo di Contenuto
HaveMorePages	HaveMorePages	boolean	HaveMorePages
PageCount	PageCount	integer	PageCount
Dimensione del file	FileSize	integer	Dimensione del file
OriginalFileName	OriginalFileName	string	OriginalFileName
ContentModified	ContentModified	string	ContentModified
HasTextAnnotation	HasTextAnnotation	boolean	HasTextAnnotation
AnnotazioniPreview	AnnotationsPreview	boolean	AnnotazioniPreview

Archiviare nel file cab

ID operazione:

StoreToFileCabinet

Archivia un nuovo documento in un archivio file.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
File Cabinet	FileCabinet	True	string	Selezionare l'archivio file da archiviare.
Finestra di dialogo Archivia	StoreDialogId	True	string	Selezionare la finestra di dialogo dello Store da usare per l'archiviazione.
Indicizzare i dati	index		string	Specificare i dati dell'indice per il documento.
Contenuto del file	file		file	Specificare il contenuto del file da archiviare.

Restituisce

Nome	Percorso	Tipo	Descrizione
Sezioni	Sections	array of object	Sezioni
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
Tipo di Contenuto	Sections.ContentType	string	Tipo di Contenuto
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Dimensione del file	Sections.FileSize	integer	Dimensione del file
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnnotazioniPreview	Sections.AnnotationsPreview	boolean	AnnotazioniPreview
DocumentId	DocumentId	integer	DocumentId
IndexFields	IndexFields	object	IndexFields
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Dimensione del file	FileSize	integer	Dimensione del file
Tipo di Contenuto	ContentType	string	Tipo di Contenuto
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

Cercare nell'archivio file

ID operazione:

SearchForDocumentsInFileCabinet

Cercare documenti corrispondenti ai criteri specificati in un archivio file.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
File Cabinet	FileCabinet	True	string	Selezionare File Cabinet da cercare.
Finestra di dialogo di ricerca	SearchDialogId	True	string	Selezionare la finestra di dialogo di ricerca da usare per la ricerca.
Query di ricerca	SearchQuery	True

Restituisce

Nome	Percorso	Tipo	Descrizione
Conteggio	Count	integer	Conteggio
Documents	Documents	array of object	Documents
Sezioni	Documents.Sections	array of	Sezioni
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFields	Documents.IndexFields	object	IndexFields
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Dimensione del file	Documents.FileSize	integer	Dimensione del file
Tipo di Contenuto	Documents.ContentType	string	Tipo di Contenuto
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

Elencare i documenti nella barra dei documenti

ID operazione:

ListDocumentsInDocumentTray

Elencare i documenti dalla barra dei documenti specificata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Vassoio documenti	DocumentTray	True	string	Selezionare la barra dei documenti da cercare.

Restituisce

Nome	Percorso	Tipo	Descrizione
Conteggio	Count	integer	Conteggio
Documents	Documents	array of object
Sezioni	Documents.Sections	array of	Sezioni
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFields	Documents.IndexFields	object	IndexFields
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Dimensione del file	Documents.FileSize	integer	Dimensione del file
Tipo di Contenuto	Documents.ContentType	string	Tipo di Contenuto
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

Eliminare un file

ID operazione:

DeleteFile

Elimina un file o una sezione da un documento esistente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinet	True	string	Selezionare l'archivio file o la barra dei documenti con il documento.
ID documento	DocumentID	True	integer	Specificare l'ID del documento da cui eliminare.
Numero file	FileNumber	True	integer	Specificare il numero di file da eliminare.

Eliminazione di un documento

ID operazione:

DeleteDocument

Elimina un documento da un archivio file o da una barra dei documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinetID	True	string	Selezionare l'archivio file o la barra dei documenti con il documento.
ID documento	DocumentID	True	integer	Specificare l'ID del documento da eliminare.

Importa nella barra dei documenti

ID operazione:

ImportToDocumentTray

Importare un nuovo documento in una barra dei documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Vassoio documenti	DocumentTray	True	string	Selezionare la barra dei documenti in cui eseguire l'importazione.
Finestra di dialogo Archivia	StoreDialogId		string	Selezionare la finestra di dialogo di archiviazione da usare durante l'importazione.
Indicizzare i dati	index		string	Specificare i dati dell'indice per il documento.
Contenuto del file	file		file	Specificare il contenuto del file da importare.

Restituisce

Nome	Percorso	Tipo	Descrizione
Sezioni	Sections	array of object	Sezioni
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
Tipo di Contenuto	Sections.ContentType	string	Tipo di Contenuto
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Dimensione del file	Sections.FileSize	integer	Dimensione del file
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnnotazioniPreview	Sections.AnnotationsPreview	boolean	AnnotazioniPreview
DocumentId	DocumentId	integer	DocumentId
IndexFields	IndexFields	object	IndexFields
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Dimensione del file	FileSize	integer	Dimensione del file
Tipo di Contenuto	ContentType	string	Tipo di Contenuto
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

Ottenere archivi file e vassoi dei documenti

ID operazione:

GetFileCabinets

Ottiene un elenco di archivi file e/o contenitori di documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Tipo file cab	FileCabinetType	True	string	Selezionare i tipi che si desidera restituire.

Restituisce

Nome	Percorso	Tipo	Descrizione
FileCabinets	FileCabinets	array of object	FileCabinets
Nome	FileCabinets.Name	string	Nome
GUID	FileCabinets.Guid	string	GUID
Colore	FileCabinets.Color	string	Colore
IsTray	FileCabinets.IsTray	boolean	IsTray

Ottenere finestre di dialogo

ID operazione:

GetDialogs

Ottiene un elenco di dialoghi per un archivio file o una barra dei documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinet	True	string	Selezionare l'archivio file o la barra dei documenti da cui ottenere le finestre di dialogo.
Tipo di finestra di dialogo	DialogType		string	Selezionare il tipo di dialoghi da restituire.

Restituisce

Nome	Percorso	Tipo	Descrizione
Dialogs	Dialogs	array of object	Dialogs
Nome	Dialogs.Name	string	Nome
GUID	Dialogs.Guid	string	GUID
Colore	Dialogs.Color	string	Colore
IsDefault	Dialogs.IsDefault	boolean	IsDefault
TIPO	Dialogs.Type	string	TIPO
FileCabinetId	Dialogs.FileCabinetId	string	FileCabinetId

Ottenere francobolli

ID operazione:

GetStamps

Ottiene un elenco di timbri per un archivio file o un vassoio di documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinet	True	string	Selezionare l'archivio file o il cassetto dei documenti da cui ottenere i francobolli.

Restituisce

Nome	Percorso	Tipo	Descrizione
Francobolli	Stamps	array of object	Francobolli
id	Stamps.Id	string	id
Nome	Stamps.Name	string	Nome
Nome visualizzato	Stamps.DisplayName	string	Nome visualizzato
Colore	Stamps.Color	string	Colore
Signature	Stamps.Signature	string	Signature
PasswordProtected	Stamps.PasswordProtected	boolean	PasswordProtected
Sovrascrivere	Stamps.Overwrite	boolean	Sovrascrivere
TIPO	Stamps.Type	string	TIPO
FileCabinetId	Stamps.FileCabinetId	string	FileCabinetId

Ottenere i campi della finestra di dialogo

ID operazione:

GetDialogFields

Ottiene i campi per una finestra di dialogo

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
File Cabinet	FileCabinet	True	string	Selezionare l'archivio file
Dialog	DialogId	True	string	Selezionare la finestra di dialogo per cui ottenere i campi.

Restituisce

Nome	Percorso	Tipo	Descrizione
Fields	Fields	array of object	Fields
DBFieldName	Fields.DBFieldName	string	DBFieldName
DWFieldType	Fields.DWFieldType	string	DWFieldType
Nome visualizzato	Fields.DisplayName	string	Nome visualizzato
ReadOnly	Fields.ReadOnly	boolean	ReadOnly
Visibile	Fields.Visible	boolean	Visibile

Ottenere i campi file cabinet

ID operazione:

GetFileCabinetFields

Ottiene un elenco di campi per un file cab.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
File Cabinet	FileCabinet	True	string	Selezionare l'archivio file per cui ottenere i campi.
Tipo di campo	FieldType		string	Selezionare il tipo di campi da restituire.

Restituisce

Nome	Percorso	Tipo	Descrizione
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
Nome visualizzato	Fields.TableFieldColumns.DisplayName	string	Nome visualizzato
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
Precisione	Fields.TableFieldColumns.Precision	integer	Precisione
Ambito	Fields.TableFieldColumns.Scope	string	Ambito
UsedAsDocumentName	Fields.UsedAsDocumentName	boolean	UsedAsDocumentName
DBFieldName	Fields.DBFieldName	string	DBFieldName
DWFieldType	Fields.DWFieldType	string	DWFieldType
Nome visualizzato	Fields.DisplayName	string	Nome visualizzato
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
Precisione	Fields.Precision	integer	Precisione
Ambito	Fields.Scope	string	Ambito

Ottenere i campi stamp

ID operazione:

GetStampFields

Ottiene un elenco di campi per un timbro.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinet	True	string	Selezionare l'archivio file o il cassetto dei documenti con il timbro desiderato.
Francobollo	Stamp	True	string	Selezionare il timbro per ottenere i relativi campi.

Restituisce

Nome	Percorso	Tipo	Descrizione
Fields	Fields	array of object	Fields
id	Fields.Id	string	id
Etichetta	Fields.Label	string	Etichetta
Nome visualizzato	Fields.DisplayName	string	Nome visualizzato

Ottenere informazioni sul documento

ID operazione:

GetDocumentInformation

Ottiene informazioni su un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinetID	True	string	Selezionare l'archivio file o la barra dei documenti con il documento.
ID documento	DocumentID	True	integer	Specificare l'ID del documento su cui si desidera ottenere informazioni.

Restituisce

Nome	Percorso	Tipo	Descrizione
Sezioni	Sections	array of object	Sezioni
SignatureStatus	Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Sections.SectionId	string	SectionId
Tipo di Contenuto	Sections.ContentType	string	Tipo di Contenuto
HaveMorePages	Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Sections.PageCount	integer	PageCount
Dimensione del file	Sections.FileSize	integer	Dimensione del file
OriginalFileName	Sections.OriginalFileName	string	OriginalFileName
ContentModified	Sections.ContentModified	string	ContentModified
HasTextAnnotation	Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnnotazioniPreview	Sections.AnnotationsPreview	boolean	AnnotazioniPreview
DocumentId	DocumentId	integer	DocumentId
IndexFields	IndexFields	object	IndexFields
DocumentTitle	DocumentTitle	string	DocumentTitle
FileCabinetId	FileCabinetId	string	FileCabinetId
TotalPages	TotalPages	integer	TotalPages
Dimensione del file	FileSize	integer	Dimensione del file
Tipo di Contenuto	ContentType	string	Tipo di Contenuto
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

Ottenere l'organizzazione

ID operazione:

GetOrganization

Ottenere il nome dell'organizzazione.

Restituisce

Nome	Percorso	Tipo	Descrizione
Nome	Name	string	Nome

Posizionare un timbro

ID operazione:

PlaceAStamp

Inserisce un timbro su un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinetID	True	string	Selezionare l'archivio file o la barra dei documenti con il documento.
ID documento	DocumentID	True	integer	Specificare l'ID del documento da stampare.
Numero file	FileNumber	True	integer	Specificare il file o la sezione contenente la pagina da stampare.
Numero pagina	PageNumber	True	integer	Specificare il numero di pagina in cui inserire il timbro.
Strato	Layer	True	integer	Specificare il livello documento per posizionare il timbro su [1-5]
Posizione orizzontale (posizione X)	PositionX		number	[Facoltativo] Posizione dal bordo sinistro della pagina in mm.
Posizione verticale (posizione Y)	PositionY		number	[Facoltativo] Posizione dal bordo superiore della pagina in mm.
Francobollo	StampId	True	string	Selezionare o specificare il timbro da utilizzare.
Parola chiave	Password		string	Specificare la password per il timbro (se necessario).
Nome	Name		string	Specificare un nome di campo.
Value	Value		string	Specificare un valore di campo.

Restituisce

Nome	Percorso	Tipo	Descrizione
User	Created.User	string	User
Time	Created.Time	string	Time
TIPO	Type	string	TIPO
Colore	Color	string	Colore
Rotazione	Rotation	integer	Rotazione
Transparent	Transparent	boolean	Transparent
StrokeWidth	StrokeWidth	integer	StrokeWidth
GUID	Guid	string	GUID

Scaricare un documento

ID operazione:

DownloadDocument

Scarica un documento da un archivio file o da una barra dei documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinetID	True	string	Selezionare l'archivio file o la barra dei documenti con il documento.
ID documento	DocumentId	True	integer	Specificare l'ID del documento da scaricare.
Formato documento	DocumentFormat	True	string	Selezionare il formato per il documento scaricato.

Restituisce

Corpo

Corpo

binary

Scaricare un file

ID operazione:

DownloadFile

Scarica un file o una sezione di un documento archiviato in un archivio file o in una barra dei documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinetID	True	string	Selezionare l'archivio file o la barra dei documenti con il documento.
ID documento	DocumentId	True	integer	Specificare l'ID del documento con il file da scaricare.
Numero file	FileNumber	True	string	Specificare il numero di file da scaricare.
Formato documento	DocumentFormat	True	string	Selezionare il formato per il documento scaricato.

Restituisce

Corpo

Corpo

binary

Sostituire un file

ID operazione:

ReplaceFile

Sostituisce un file o una sezione in un documento esistente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file/Cassetto documenti	FileCabinet	True	string	Selezionare l'archivio file o la barra dei documenti con il documento.
ID documento	DocumentID	True	integer	Specificare l'ID del documento con il file da sostituire.
Numero file	FileNumber	True	integer	Specificare il numero di file da sostituire.
Contenuto del file	file		file	Specificare il contenuto del file da archiviare.

Restituisce

Nome	Percorso	Tipo	Descrizione
SignatureStatus	SignatureStatus	array of string	SignatureStatus
SectionId	SectionId	string	SectionId
Tipo di Contenuto	ContentType	string	Tipo di Contenuto
HaveMorePages	HaveMorePages	boolean	HaveMorePages
PageCount	PageCount	integer	PageCount
Dimensione del file	FileSize	integer	Dimensione del file
OriginalFileName	OriginalFileName	string	OriginalFileName
ContentModified	ContentModified	string	ContentModified
HasTextAnnotation	HasTextAnnotation	boolean	HasTextAnnotation
AnnotazioniPreview	AnnotationsPreview	boolean	AnnotazioniPreview

Trasferire documenti

ID operazione:

TransferDocument

Sposta uno o più documenti da un archivio file/cassetto documenti a un altro.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio file di destinazione/Cassetto documenti	DestinationFileCabinetID	True	string	Selezionare l'archivio file di destinazione o la barra dei documenti.
Finestra di dialogo Archivia	StoreDialogID		string	Selezionare la finestra di dialogo di archiviazione per l'indicizzazione dei documenti spostati.
Archivio file di origine/Cassetto documenti	SourceFileCabinetId	True	string	Selezionare l'archivio file di origine o la barra dei documenti.
Documento d'identità	DocumentId		integer	Specificare un ID documento.
Nome	Name		string	Selezionare o specificare un nome di campo.
Value	Value		string	Specificare un valore di campo.
Mantieni origine	KeepSource		boolean	Scegliere se i documenti di origine devono essere eliminati o meno.
Compilare Intellix	FillIntellix		boolean	Scegliere se usare l'indicizzazione intelligente durante l'archiviazione.

Restituisce

Nome	Percorso	Tipo	Descrizione
Conteggio	Count	integer	Conteggio
Documents	Documents	array of object	Documents
Sezioni	Documents.Sections	array of object	Sezioni
SignatureStatus	Documents.Sections.SignatureStatus	array of string	SignatureStatus
SectionId	Documents.Sections.SectionId	string	SectionId
Tipo di Contenuto	Documents.Sections.ContentType	string	Tipo di Contenuto
HaveMorePages	Documents.Sections.HaveMorePages	boolean	HaveMorePages
PageCount	Documents.Sections.PageCount	integer	PageCount
Dimensione del file	Documents.Sections.FileSize	integer	Dimensione del file
OriginalFileName	Documents.Sections.OriginalFileName	string	OriginalFileName
ContentModified	Documents.Sections.ContentModified	string	ContentModified
HasTextAnnotation	Documents.Sections.HasTextAnnotation	boolean	HasTextAnnotation
AnnotazioniPreview	Documents.Sections.AnnotationsPreview	boolean	AnnotazioniPreview
DocumentId	Documents.DocumentId	integer	DocumentId
IndexFields	Documents.IndexFields	object	IndexFields
DocumentTitle	Documents.DocumentTitle	string	DocumentTitle
FileCabinetId	Documents.FileCabinetId	string	FileCabinetId
TotalPages	Documents.TotalPages	integer	TotalPages
Dimensione del file	Documents.FileSize	integer	Dimensione del file
Tipo di Contenuto	Documents.ContentType	string	Tipo di Contenuto
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

Definizioni

binario

Questo è il tipo di dati di base 'binario'.