Teilen über


InfoShare

InfoShare wurde für den Einsatz in Unternehmen entwickelt, die die Art und Weise optimieren möchten, wie sie digitale Dokumente, Informationen, Binder und Prozesse verwalten.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Kendox Support
URL https://kendox.com/en/service/support-services
Email support@kendox.com
Connectormetadaten
Herausgeber Kendox AG
Webseite https://www.kendox.com/en
Datenschutzrichtlinie https://www.kendox.com/en/about-us/data-protection
Kategorien Zusammenarbeit; Inhalt und Dateien

Kendox InfoShare Connector

Kendox InfoShare bietet eine leistungsstarke und sehr umfangreiche REST-API. Mithilfe dieser API können Sie Dokumente und Prozesse in InfoShare erstellen und verwalten. Zusammen mit dem Kendox InfoShare Power Automate Connector können Sie Inhaltsprozesse in einer weit verbreiteten Anwendungslandschaft optimieren und so Informationssilos vermeiden.

Voraussetzungen

Sie benötigen Folgendes, um fortzufahren:

  • Eine Lizenz, um diesen Connector zu verwenden, der über sales365@kendox.com.
  • Kendox InfoShare mit den WCF-Dienstendpunkten, die online erreichbar sind.
  • Kendox InfoShare-Anmeldeinformationen.

Unterstützte Vorgänge

Der Connector unterstützt die folgenden Vorgänge:

Allgemein

  • Logon: Anmelden bei InfoShare Server
  • Logon with hashed password: Anmelden bei InfoShare Server
  • Logoff: Anmelden von InfoShare Server
  • Get documents and processes selection: Abrufen von Dokumenten und Prozessen, die auf mobilem WebClient ausgewählt sind, über benutzerdefinierte Schaltflächenaktion

Dokument

  • Create document (deprecated): Erstellen eines Dokuments in InfoShare, veraltete Version
  • Create document (V2): Erstellen eines Dokuments in InfoShare, vorgeschlagene Version
  • Update document (deprecated): Aktualisieren des Dokuments in InfoShare, veraltete Version
  • Update document (V2): Aktualisieren des Dokuments in InfoShare, vorgeschlagene Version
  • Get document properties: Abrufen der Eigenschaften eines Dokuments aus InfoShare
  • Get file content: Abrufen des Inhalts einer Datei über InfoShare
  • Get file content converted: Konvertiert den Inhalt einer Datei in ein anderes Dateiformat (e.g. tiff in PDF). Abrufen von Dateiinhalten einschließlich Anmerkungen und Überlagerungen
  • Get document: Gibt Dokumentinformationen (Struktur) aus InfoShare zurück.
  • Merge PDF documents: Zusammenführen von zwei oder mehr PDF-Dokumenten in ein Zieldokument

Prozess

  • Create process: Erstellen und Starten eines Prozesses
  • Update process (deprecated): Aktualisieren eines Prozesses in InfoShare, veraltete Version
  • Update process (V2): Aktualisieren eines Prozesses in InfoShare, vorgeschlagene Version
  • Close an open process: Schließen eines Prozesses in InfoShare
  • Close task and continue process: Schließen einer Prozessaufgabe in InfoShare
  • Close current task and assign user to next task: Schließen einer Prozessaufgabe und Zuweisen des Benutzers zur nächsten Aufgabe in InfoShare
  • Get process: Gibt eine Liste von Prozessinformationen (Struktur) aus InfoShare zurück.
  • Get process properties: Abrufen der Eigenschaften eines Prozesses aus InfoShare
  • Document Search (deprecated): Suchen nach Dokumenten in InfoShare, veraltete Version
  • Document Search (V2): Suchen nach Dokumenten in InfoShare, vorgeschlagene Version
  • List processes (deprecated): Abrufen einer Liste von Prozessen innerhalb von InfoShare, ersetzt durch Prozesssuchaktion
  • Process search: Suchen nach Prozessen in InfoShare

Benutzertabellen

  • Create a user table: Erstellt eine Benutzertabelle
  • Get rows from a user table: Ruft einige Zeilen aus einer Benutzertabelle ab.
  • Insert rows into a user table: Einfügen von Zeilen in eine Benutzertabelle
  • Update a row in a user table: Aktualisieren einer Zeile in eine Benutzertabelle
  • Delete user table rows: Löscht einige Zeilen aus einer Benutzertabelle.

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
API-Schlüssel securestring Der API-Schlüssel für diese API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen von Dokumenteigenschaften

Abrufen von Dokumenteigenschaften

Abrufen von Dokumenten und Prozessen der Auswahl

Abrufen von Dokumenten und Prozessen, die auf mobilem WebClient ausgewählt sind, über benutzerdefinierte Schaltflächenaktion

Abrufen von konvertierten Dateiinhalten

Konvertieren Sie Dateiinhalte in ein anderes Format. Hinzufügen von Anmerkungen oder Überlagerungen zu Dateiinhalten

Abrufen von Prozesseigenschaften

Abrufen von Prozesseigenschaften

Abrufen von Zeilen aus einer Benutzertabelle

Abrufen von Zeilen aus einer Benutzertabelle

Aktualisieren einer Zeile in einer Benutzertabelle

Aktualisieren einer Zeile in einer Benutzertabelle

Aktuelle Aufgabe schließen und Dem nächsten Vorgang Benutzer zuweisen

Aktuelle Aufgabe schließen und Dem nächsten Vorgang Benutzer zuweisen

Anmeldung mit Hashkennwort

Anmeldung mit Hashkennwort

Aufgabe schließen und Vorgang fortsetzen

Aufgabe schließen und Vorgang fortsetzen

Auflisten von Prozessen (veraltet) [VERALTET]

Auflisten von Prozessen (veraltet)

Dateiinhalte abrufen

Dateiinhalte abrufen

Dokument abrufen

Dokument abrufen

Dokument aktualisieren (V2)

Dokument aktualisieren (V2)

Dokument aktualisieren (veraltet) [VERALTET]

Dokument aktualisieren (veraltet)

Dokument erstellen (V2)

Dokument erstellen (V2)

Dokument erstellen (veraltet) [VERALTET]

Dokument erstellen (veraltet)

Dokumentsuche (V2)

Dokumentsuche (V2)

Dokumentsuche (veraltet) [VERALTET]

Dokumentsuche (veraltet)

Einfügen von Zeilen in eine Benutzertabelle

Importieren von Tabellenzeilen in eine Benutzertabelle

Erstellen einer Benutzertabelle

Erstellen einer Benutzertabelle

Erstellen von Prozessen

Erstellen von Prozessen

Logoff

Logoff

Logon

Logon

Löschen von Benutzertabellenzeilen

Löschen von Benutzertabellenzeilen

PDF-Dokumente zusammenführen

Zusammenführen von zwei oder mehr PDF-Dokumenten in einem Dokument

Prozess abrufen

Prozess abrufen

Prozesssuche

Prozesssuche

Schließen eines geöffneten Prozesses

Schließen eines geöffneten Prozesses

Updateprozess (V2)

Updateprozess (V2)

Updateprozess (veraltet) [VERALTET]

Updateprozess (veraltet)

Abrufen von Dokumenteigenschaften

Abrufen von Dokumenteigenschaften

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DokumentID
DocumentId True string

ID des Dokuments

Kultur
Culture string

Die Kultur, in der die Eigenschaftsnamen angegeben werden (de, en, fr, ...). Default = de

Gibt zurück

Name Pfad Typ Beschreibung
array of object
globalValues
globalValues array of object

globalValues

values
globalValues.values array of object

values

Kultur
globalValues.values.culture string

Kultur

Text
globalValues.values.text string

Text

Eigenschaftsname
propertyName string

Name der Eigenschaft

PropertyTypeId
propertyTypeId string

Typ-ID des Indexfelds

values
values array of string

values

Abrufen von Dokumenten und Prozessen der Auswahl

Abrufen von Dokumenten und Prozessen, die auf mobilem WebClient ausgewählt sind, über benutzerdefinierte Schaltflächenaktion

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

SelectionId
SelectionId True string

Die Auswahl-ID ausgewählter Dokumente und Prozesse in Mobile Web Client über benutzerdefinierte Schaltflächenaktion

Gibt zurück

Name Pfad Typ Beschreibung
id
id string

Auswahl-ID

id
parentObjectId.id string

Listen-ID des übergeordneten Objekts im mobilen Webclient

objectId
parentObjectId.objectId string

Objekt-ID des übergeordneten Objekts (Document, Process,...)

objectTypeEnum
parentObjectId.objectTypeEnum string

ObjectTypeEnum des übergeordneten Objekts - z. B. Document, Process, ...

objectIds
objectIds array of object

Ausgewählte Dokumente und Prozesse in Mobile Web Client

id
objectIds.id string

Listen-ID des mobilen Webclients

objectId
objectIds.objectId string

Objekt-ID des ausgewählten Dokuments oder Prozesses im mobilen Webclient

objectTypeEnum
objectIds.objectTypeEnum string

ObjectTypeEnum des ausgewählten Dokuments oder Prozesses in Mobile Web Client

allObjectIds
allObjectIds array of object

Ausgewählte und nicht ausgewählte Dokumente und Prozesse in Mobile Web Client

id
allObjectIds.id string

Listen-ID des mobilen Webclients

objectId
allObjectIds.objectId string

Objekt-ID des ausgewählten und nicht ausgewählten Dokuments oder Prozesses in Mobile Web Client

objectTypeEnum
allObjectIds.objectTypeEnum string

ObjectTypeEnum des ausgewählten und nicht ausgewählten Dokuments oder Prozesses in Mobile Web Client

Abrufen von konvertierten Dateiinhalten

Konvertieren Sie Dateiinhalte in ein anderes Format. Hinzufügen von Anmerkungen oder Überlagerungen zu Dateiinhalten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DokumentID
DocumentId True string

ID des Dokuments

VersionId
VersionId string

ID der Version (Guid)ID der Version (Guid)

DocumentDataId
DocumentDataId string

ID der Dokumentdaten (GUID)

RenditionId
RenditionId string

ID der Dokumentdarstellung (GUID)

TargetFormat
TargetFormat True string

Das Zielformat (z. B. "png;pdf; tif;...")

AddAnnotations
AddAnnotatins boolean

Definiert, ob das Dokument mit Anmerkungen exportiert werden soll. Default = yes

AddOverlay
AddOverlay boolean

Definiert, ob das Dokument mit Überlagerungen exportiert werden soll. Default = yes

Gibt zurück

Konvertierter Dateiinhalt

Inhalt der Datei
string

Abrufen von Prozesseigenschaften

Abrufen von Prozesseigenschaften

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Prozess-ID
ProcessId True string

ID des Prozesses (Guid)

Kultur
Culture string

Die Kultur, in der die Eigenschaftsnamen angegeben werden (de, en, fr, ...). Default = de

Gibt zurück

Name Pfad Typ Beschreibung
array of object
Eigenschaftsname
propertyName string

Name der Prozesseigenschaft

PropertyTypeId
propertyTypeId string

Eigenschaftstyp-ID

values
values array of string

values

Abrufen von Zeilen aus einer Benutzertabelle

Abrufen von Zeilen aus einer Benutzertabelle

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

UserTable
UserTable True string

Name der Benutzertabelle

WhereClause
WhereClause string

Eine Liste der SQL-Klauselelemente. Format: [<ColumnName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (z. B.: [Vorname|Gleich|Jon|UND],[Nachname|Gleich|Doe|UND])

OrderByClause
OrderByClause string

Eine Liste der SQL-Reihenfolge nach Klauselelementen (z. B.: Vorname[ASC],City[DESC])

AddColumnHeaders
AddColumnHeaders boolean

Fügt Spaltenüberschriften als erste Zeile hinzu (Standard = false)

Gibt zurück

Name Pfad Typ Beschreibung
UserTableGetRecordsResult
UserTableGetRecordsResult array of array

UserTableGetRecordsResult

items
UserTableGetRecordsResult array of string

Aktualisieren einer Zeile in einer Benutzertabelle

Aktualisieren einer Zeile in einer Benutzertabelle

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Benutzertabellenname
UserTable True string

Benutzertabellenname

RowData
RowData True string

Zeichenfolge, die Zeilendaten enthält, die durch Semikolons getrennt werden sollen, muss das erste Element die InternalRecord_Id der Zeile sein, die aktualisiert werden soll, "100" im folgenden Beispiel: 100; John; Hirschkuh; 2024-01-01; 2024-12-31

Gibt zurück

Name Pfad Typ Beschreibung
userTableUpdateRowResult
userTableUpdateRowResult integer

userTableUpdateRowResult

Aktuelle Aufgabe schließen und Dem nächsten Vorgang Benutzer zuweisen

Aktuelle Aufgabe schließen und Dem nächsten Vorgang Benutzer zuweisen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Prozess-ID
ProcessId True string

ID des Prozesses (Guid)

TaskId
TaskId string

ID des Vorgangs (Guid)

Kommentar
Comment string

Kommentar

AssignUserLoginNames
AssignUserLoginNames True string

AssignUserLoginNames

Gibt zurück

Name Pfad Typ Beschreibung
Maßnahme
action string

Aktionstext für den Benutzer. Dem Endbenutzer angezeigt

assignedUserIds
assignedUserIds array of string

assignedUserIds

comments
comments array of object

comments

Datum
comments.date string

Datum des Kommentars

Id
comments.id string

ID des Kommentars

Text
comments.text string

Benutzerdefinierter Kommentar

UserId
comments.userId string

ID des Benutzers, der den Kommentar festgelegt hat

CompletedDate
completedDate string

Abschlussdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CompletedUserIds
CompletedUserIds array of string

CompletedUserIds

CreatedDate
createdDate string

Erstellungsdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
creatorId string

Benutzer-ID des Erstellers

Description
description string

Aufgabenbeschreibung

Fälligkeitsdatum
dueDate string

Fälligkeitsdatum des Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

intendedUserIds
intendedUserIds array of string

intendedUserIds

ReminderDate
reminderDate string

Datum für Erinnerung. Datumsformat: jjjj-MM-ddTHH:mm:ss

RequiresAllRecipients
requiresAllRecipients boolean

Definiert, ob alle Empfänger diese Aufgabe schließen müssen.

ShowCloseTaskDialog
showCloseTaskDialog boolean

Dialogfeld "Aufgabe schließen" am Aufgabenende anzeigen

Der Status
statusEnum string

Status des Vorgangsstatus (Öffnen, InProcess, Abgeschlossen, PreparedToComplete, Fehler)

TaskTemplateId
taskTemplateId string

Aufgabenvorlagen-ID

Anmeldung mit Hashkennwort

Anmeldung mit Hashkennwort

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

Benutzername
userName True string

Benutzername für die Anmeldung

Kennwort mit Hash
passwordHashed True string

Benutzerkennwort für die Anmeldung (Base64-codierter SHA 512-Hash)

Mandantenname
tenantName string

Mandantenname für die Anmeldung bei

Gibt zurück

Name Pfad Typ Beschreibung
ConnectionId
LogonResult.ConnectionId string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

ConnectionTimeoutSeconds
LogonResult.ConnectionTimeoutSeconds integer

Verbindungstimeout in Sekunden

IsApplicationLicence
LogonResult.IsApplicationLicence boolean

Ist Anwendungslizenztyp

IsConcurrentLicence
LogonResult.IsConcurrentLicence boolean

Ist gleichzeitiger Lizenztyp

IsNamedLicence
LogonResult.IsNamedLicence boolean

Benannter Lizenztyp

IsVerificationCodeNeeded
LogonResult.IsVerificationCodeNeeded boolean

Ist Überprüfungscode erforderlich

JWTToken
LogonResult.JWTToken string

Das JWT-Token für diese Verbindung

PossibleTwoWayAuthenticationType
LogonResult.PossibleTwoWayAuthenticationType string

Möglicher Zwei-Wege-Authentifizierungstyp (None, Mail, SMS)

TwoWayAuthenticationTargetMail
LogonResult.TwoWayAuthenticationTargetMail string

Die maskierte E-Mail-Adresse, an die zweiWayAuthentication E-Mails an

Aufgabe schließen und Vorgang fortsetzen

Aufgabe schließen und Vorgang fortsetzen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
connectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Prozess-ID
processId True string

ID des Prozesses (Guid)

Kommentar
comment string

Hinzuzufügenden Kommentar

TaskId
taskId string

Vorgangs-ID

AssignUsers
assignUsers True boolean

Benutzern zuweisen. Wenn diese Einstellung auf "Nein" festgelegt ist, weisen Sie dem Benutzer den Prozess zum Aktualisieren von Aktionen zu.

Gibt zurück

Name Pfad Typ Beschreibung
Maßnahme
action string

Aktionstext für den Benutzer. Dem Endbenutzer angezeigt

AssignedUserIds
assignedUserIds string

Liste der zugewiesenen Benutzer-IDs

comments
comments array of object

comments

Datum
comments.date string

Datum des Kommentars

Id
comments.id string

ID des Kommentars

Text
comments.text string

Benutzerdefinierter Kommentar

UserId
comments.userId string

Benutzer-ID

CompletedDate
completedDate string

Abschlussdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CompletedUserIds
completedUserIds string

Liste aller abgeschlossenen Benutzer-IDs

CreatedDate
createdDate string

Erstellungsdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
creatorId string

Benutzer-ID des Erstellers

Description
description string

Aufgabenbeschreibung

Fälligkeitsdatum
dueDate string

Fälligkeitsdatum des Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

IntendedUserIds
intendedUserIds string

Beabsichtigte Benutzer für diese Aufgabe

ReminderDate
reminderDate string

Datum für Erinnerung. Datumsformat: jjjj-MM-ddTHH:mm:ss

RequiresAllRecipients
requiresAllRecipients boolean

Definiert, ob alle Empfänger diese Aufgabe schließen müssen.

ShowCloseTaskDialog
showCloseTaskDialog boolean

Dialogfeld "Aufgabe schließen" am Aufgabenende anzeigen

Der Status
statusEnum string

Status des Vorgangsstatus (Öffnen, InProcess, Abgeschlossen, PreparedToComplete, Fehler)

TaskTemplateId
taskTemplateId string

Aufgabenvorlagen-ID

Auflisten von Prozessen (veraltet) [VERALTET]

Auflisten von Prozessen (veraltet)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Empfänger
Receiver string

Anmeldenamen von Empfängern aus Prozessen (z. B.: john@sample.com|megan@sample.com). Ist leer, wird der angemeldete Benutzer als Empfänger weitergeleitet.

Der Status
Status string

Status des Prozesses. Default = open

IgnoreReceiver
IgnoreReceiver boolean

Wenn ja, werden alle Prozesse indipendent des Empfängers aufgelistet. Default = false

MaxSerchResults
MaxSerchResults string

Maximale Anzahl von Prozesssuchergebnissen. Standard = 100

Gibt zurück

Name Pfad Typ Beschreibung
processes
processes array of object

processes

accessRightsEnumList
processes.accessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
processes.checkOutStateEnum string

Status des Prozesses auschecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
processes.checkOutUserId string

ID des Benutzers, für das das Dokument ausgecheckt ist

comments
processes.comments array of object

comments

Datum
processes.comments.date string

Datum des Kommentars

Id
processes.comments.id string

ID des Kommentars

Text
processes.comments.text string

Benutzerdefinierter Kommentar

UserId
processes.comments.userId string

ID des Benutzers, der den Kommentar festgelegt hat

CompletedDate
processes.completedDate string

Abschlussdatum des Prozesses. Datumsformat: jjjj-MM-ddTHH:mm:ss

completedTasks
processes.completedTasks array of object

completedTasks

Maßnahme
processes.completedTasks.action string

Aktionstext für den Benutzer. Dem Endbenutzer angezeigt

assignedUserIds
processes.completedTasks.assignedUserIds array of

assignedUserIds

comments
processes.completedTasks.comments array of object

comments

Datum
processes.completedTasks.comments.date string

Datum des Kommentars

Id
processes.completedTasks.comments.id string

ID des Kommentars

Text
processes.completedTasks.comments.text string

Benutzerdefinierter Kommentar

UserId
processes.completedTasks.comments.userId string

ID des Benutzers, der den Kommentar festgelegt hat

CompletedDate
processes.completedTasks.completedDate string

Abschlussdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

completedUserIds
processes.completedTasks.completedUserIds array of string

completedUserIds

CreatedDate
processes.completedTasks.createdDate string

Erstellungsdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
processes.completedTasks.creatorId string

Benutzer-ID des Erstellers

Description
processes.completedTasks.description string

Aufgabenbeschreibung

Fälligkeitsdatum
processes.completedTasks.dueDate string

Fälligkeitsdatum des Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

intendedUserIds
processes.completedTasks.intendedUserIds array of

intendedUserIds

ReminderDate
processes.completedTasks.reminderDate string

Datum für Erinnerung. Datumsformat: jjjj-MM-ddTHH:mm:ss

RequiresAllRecipients
processes.completedTasks.requiresAllRecipients boolean

Definiert, ob alle Empfänger diese Aufgabe schließen müssen.

ShowCloseTaskDialog
processes.completedTasks.showCloseTaskDialog boolean

Dialogfeld "Aufgabe schließen" am Aufgabenende anzeigen

Der Status
processes.completedTasks.statusEnum string

Vorgangsstatus (Öffnen, InProcess, Abgeschlossen, PreparedToComplete, Fehler)

TaskTemplateId
processes.completedTasks.taskTemplateId string

Aufgabenvorlagen-ID

CreatedDate
processes.createdDate string

Erstellungsdatum des Prozesses. Datumsformat: jjjj-MM-ddTHH:mm:ss

CurrentTask
processes.currentTask string

Derzeit aktive Aufgabe

CustomProperties
processes.customProperties string

Liste aller benutzerdefinierten Eigenschaften

DocumentIds
processes.documentIds string

Liste aller angefügten Dokument-IDs

Fälligkeitsdatum
processes.dueDate string

Fälligkeitsdatum für das Prozessdatumsformat: jjjj-MM-ddTHH:mm:ss

FolderElementId
processes.folderElementId string

Id des Prozesses als Ordnerelement

HasLinks
processes.hasLinks boolean

Kennzeichnen, ob der Prozess Links enthält

Id
processes.id string

ID des Prozesses

values
processes.name.values array of object

values

Kultur
processes.name.values.culture string

Kultur

Text
processes.name.values.text string

Text

PriorityEnum
processes.priorityEnum string

Priorität des Prozesses (Hoch, Normal, Niedrig)

PluginStream
processes.pluginStream string

Datencontainer für Plug-Ins

ProcessTemplateId
processes.processTemplateId string

Prozessvorlagen-ID

Eigenschaften
processes.properties array of object

Eigenschaften

Eigenschaftsname
processes.properties.propertyName string

Eigenschaftsname

propertyTypeId
processes.properties.propertyTypeId string

propertyTypeId

values
processes.properties.values array of string

values

ProtectionDomainId
processes.protectionDomainId string

Schutzdomänen-ID des Prozesses

StatusEnum
processes.statusEnum string

Status des Prozesses (Open, InProcess, Complete, PreparedToComplete, Error)

HasMore
hasMore boolean

Gibt an, ob mehr Ergebnisse vorhanden sind oder nicht. Das Kennzeichen ist auf "true" festgelegt, wenn weitere Ergebnisse verfügbar sind.

ResumePoint
resumePoint string

Der Fortsetzungspunkt aus vorherigen Suchvorgängen. Festlegen von NULL für den ersten Suchvorgang

Dateiinhalte abrufen

Dateiinhalte abrufen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DokumentID
DocumentId True string

ID des Dokuments

VersionId
VersionId string

ID der Version (GUID)

DocumentDataId
DocumentDataId string

ID der Dokumentdaten (GUID)

RenditionId
RenditionId string

ID der Dokumentdarstellung (GUID)

IgnoreHashValidation
IgnoreHashValidation boolean

Systemkonfiguration für Die Hashüberprüfung ignorieren. Default = yes

Gibt zurück

Inhalt der Datei

Inhalt der Datei
string

Dokument abrufen

Dokument abrufen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
connectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DokumentID
documentId True string

Die Dokument-ID

Gibt zurück

Name Pfad Typ Beschreibung
Abonnements
GetDocumentResult.Abonnements array of object

Abonnements

OnContentChange
GetDocumentResult.Abonnements.OnContentChange boolean

Abonnement ist bei Dateiänderungen aktiv

OnDelete
GetDocumentResult.Abonnements.OnDelete boolean

Abonnement ist beim Löschen aktiv

OnMetadataChange
GetDocumentResult.Abonnements.OnMetadataChange boolean

Abonnement ist bei Indexänderungen aktiv

UserId
GetDocumentResult.Abonnements.UserId string

Die Benutzer-ID für dieses abonnnement

AccessRightsEnumList
GetDocumentResult.AccessRightsEnumList array of string

accessRightsEnumList

PostItAnnotations
GetDocumentResult.AnnotationManager.PostItAnnotations array of object

PostItAnnotations

CreatedDate
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate string

Erstellungsdatum aus der Anmerkung nach der Veröffentlichung

CreatorId
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId string

Benutzer-ID des Erstellers aus der Anmerkungen

IsItalic
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic boolean

Ist die Schriftart kursiv aus der Anmerkung

IsStrikeOut
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut boolean

Wird schriftart aus der Anmerkung herausgestrichen

IsUnderline
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline boolean

Ist Schriftart unterstrichen aus der Anmerkung

Name
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name string

Schriftartname aus der Anmerkung des Beitrags. Default = Arial

Neigung
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch integer

Schriftabstand aus der Anmerkung nach der Notiz

Größe
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size integer

Schriftgrad aus der Anmerkung nach dem Posten. Beispiel: Größe:12 ist 12000. Sie benötigen Faktor 1000

Weight
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight integer

Schriftbreite aus der Anmerkung "Posten"

Id
GetDocumentResult.AnnotationManager.PostItAnnotations.Id string

ID des Beitrags

ModifiedDate
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate string

Datum der Änderung aus der Anmerkung nach dem Posten. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber integer

Anzahl der Seiten aus der Anmerkung nach dem Posten

SecurityLevelEnum
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum string

Sicherheitsstufe für die Bereitstellung der Anmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable boolean

Definiert, ob die Anmerkung nach dem Beitrag vom Benutzer ausgewählt werden kann.

Text
GetDocumentResult.AnnotationManager.PostItAnnotations.Text string

Benutzerdefinierter Text für den Beitrag der Anmerkung

X
GetDocumentResult.AnnotationManager.PostItAnnotations.X integer

X-Koordinate in Pixel pro Zoll für 7200 DPI des Beitrags

J
GetDocumentResult.AnnotationManager.PostItAnnotations.Y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI des Beitrags

RectangleAnnotations
GetDocumentResult.AnnotationManager.RectangleAnnotations array of object

RectangleAnnotations

Farbe
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color integer

Farbe des Rechtecks (32-Bit-ARGB-Wert) aus Rechteckanmerkung. Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

ColorHexCode
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode string

Farbe des Rechtecks (RGB-Hexadezimalcode) aus Rechteckanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

CreatedDate
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate string

Erstellungsdatum aus Rechteckanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId string

CreatorId

Höhe
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height integer

Höhe des Rechtecks in Pixel pro Zoll für 7200 DPI

Id
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id string

ID der Rechteckanmerkung

ModifiedDate
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate string

Änderungsdatum der Rechteckanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber integer

Anzahl der Seiten aus Rechteckanmerkung

SecurityLevelEnum
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum string

Sicherheitsstufe für Rechteckanmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable boolean

Definiert, ob die Rechteckanmerkung vom Benutzer auswählbar ist.

Transparent
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent boolean

Rechteck sollte transparent sein (Hervorhebung)

Breite
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width integer

Breite des Rechtecks in Pixel pro Zoll für 7200 DPI

X
GetDocumentResult.AnnotationManager.RectangleAnnotations.X integer

X-Koordinate in Pixel pro Zoll für 7200 DPI aus Rechteckanmerkung

J
GetDocumentResult.AnnotationManager.RectangleAnnotations.Y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI aus Rechteckanmerkung

TextAnnotations
GetDocumentResult.AnnotationManager.TextAnnotations array of object

TextAnnotations

BackgroundColor
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor integer

Farbe des Hintergrunds (32-Bit-ARGB-Wert) aus Textanmerkung. Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

BackgroundColorHexCode
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode string

Hintergrundfarbe (RGB-Hexadezimalcode) aus Textanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

CreatedDate
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate string

Erstellungsdatum aus Textanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId string

Benutzer-ID des Erstellers aus Textanmerkung

IsItalic
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic boolean

Ist Schriftart kursiv aus Textanmerkung

IsStrikeOut
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut boolean

Wird die Schriftart aus der Textanmerkung herausgestrichen

IsUnderline
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline boolean

Ist schrift unterstrichen aus Textanmerkung

Name
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name string

Schriftartname aus Textanmerkung. Default = Arial

Neigung
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch integer

Schriftabstand von Textanmerkung

Größe
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size integer

Schriftgrad aus Textanmerkung.. Beispiel: Größe:12 ist 12000. Sie benötigen Faktor 1000

Weight
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight integer

Schriftbreite aus Textanmerkung

ForegroundColor
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor integer

Farbe des Vordergrunds (32-Bit-ARGB-Wert) aus Textanmerkung. Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

ForegroundColorHexCode
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode string

Farbe des Vordergrunds (RGB-Hexadezimalcode) aus Textanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

Höhe
GetDocumentResult.AnnotationManager.TextAnnotations.Height integer

Höhe von Text in Pixel pro Zoll für 7200 DPI aus Textanmerkung

Id
GetDocumentResult.AnnotationManager.TextAnnotations.Id string

ID der Textanmerkung

ModifiedDate
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate string

Datum der Änderung aus textanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber integer

Anzahl der Seiten aus Textanmerkung

Drehung
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation integer

Drehung in Grad von textanmerkung

SecurityLevelEnum
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum string

Sicherheitsstufe für Textanmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable boolean

Definiert, ob die Textanmerkung vom Benutzer auswählbar ist.

Text
GetDocumentResult.AnnotationManager.TextAnnotations.Text string

Benutzerdefinierter Text der Textanmerkung

Transparent
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent boolean

Textanmerkung sollte transparent sein

Breite
GetDocumentResult.AnnotationManager.TextAnnotations.Width integer

Breite von Text in Pixel pro Zoll für 7200 DPI aus Textanmerkung

X
GetDocumentResult.AnnotationManager.TextAnnotations.X integer

X-Koordinate in Pixel pro Zoll für 7200 DPI aus Textanmerkung

J
GetDocumentResult.AnnotationManager.TextAnnotations.Y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI aus Textanmerkung

Bloggen
GetDocumentResult.Blogs array of object

Bloggen

CreatedDate
GetDocumentResult.Blogs.CreatedDate string

Datum, an dem der Blog erstellt wurde. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.Blogs.CreatorId string

Benutzer-ID des Erstellens des Benutzerblogs

Id
GetDocumentResult.Blogs.Id string

ID des Blogs

Text
GetDocumentResult.Blogs.Text string

Text des Blogelements

CheckOutStateEnum
GetDocumentResult.CheckOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
GetDocumentResult.CheckOutUserId string

ID des Benutzers, für das das Dokument ausgecheckt ist

DocumentData
GetDocumentResult.DocumentData array of object

DocumentData

Id
GetDocumentResult.DocumentData.Id string

ID der Dokumentdarstellung

Name
GetDocumentResult.DocumentData.Name string

Dokumentname der Darstellung

Wiedergaben
GetDocumentResult.DocumentData.Renditions array of object

Wiedergaben

ContentProtections
GetDocumentResult.DocumentData.Renditions.ContentProtections array of

ContentProtections

Extension
GetDocumentResult.DocumentData.Renditions.Extension string

Extension

Dateien
GetDocumentResult.DocumentData.Renditions.Files array of object

Dateien

BlobPath
GetDocumentResult.DocumentData.Renditions.Files.BlobPath string

BlobPath

BlobStoreId
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId string

BlobStoreId

HashValue
GetDocumentResult.DocumentData.Renditions.HashValue array of integer

HashValue

Id
GetDocumentResult.DocumentData.Renditions.Id string

Id

PageCount
GetDocumentResult.DocumentData.Renditions.PageCount integer

PageCount

Größe
GetDocumentResult.DocumentData.Renditions.Size integer

Größe

HasOverlay
GetDocumentResult.HasOverlay boolean

Definiert, ob das Dokument mit einer Überlagerung angezeigt werden soll.

Id
GetDocumentResult.Id string

ID des Dokuments

ImportTemplateId
GetDocumentResult.ImportTemplateId string

ID der Importvorlage für dieses Dokument

InfoStoreId
GetDocumentResult.InfoStoreId string

ID des Informationsspeichers

CheckOutLifeCycleStateId
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId string

Lebenszyklusstatus des Auscheckens

LifeCycleEndDate
GetDocumentResult.LifeCycleManager.LifeCycleEndDate string

Berechnetes Enddatum des Lebenszyklus. Datumsformat: jjjj-MM-ddTHH:mm:ss

LifeCycleStartDate
GetDocumentResult.LifeCycleManager.LifeCycleStartDate string

Startdatum des Lebenszyklus. Datumsformat: jjjj-MM-ddTHH:mm:ss

LifeCycleStateId
GetDocumentResult.LifeCycleManager.LifeCycleStateId string

ID des LifeCycle-Zustands

NextAutomaticLifeCycleStateId
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId string

Nächster automatischer Lebenszyklusstatus

NextLifeCycleStates
GetDocumentResult.LifeCycleManager.NextLifeCycleStates array of string

NextLifeCycleStates

LifeCycleProtections
GetDocumentResult.LifeCycleManager.LifeCycleProtections array of object

LifeCycleProtections

DeleteAfterExpiration
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration boolean

Dokument nach Ablauf des Schutzes löschen lassen

Id
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id string

ID des Lebenszyklusstatusschutzes

ProtectAnnotationChange
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange boolean

Schutz vor Anmerkungsänderungen

ProtectCheckOut
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut boolean

Schutz vor Auschecken

ProtectContentChange
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange boolean

Schutz vor Inhaltsänderungen

ProtectDelete
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete boolean

Schutz vor Löschvorgang

ProtectPropertyChange
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange boolean

Schutz vor Eigenschaftenänderungen

ProtectProtectionDomainChange
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange boolean

Schutz vor Sicherheitsänderungen

ProtectionDurationTicks
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks integer

Dauer des Schutzes

LifeCycleId
GetDocumentResult.LifeCycleManager.LifeCycleId string

ID des LifeCycle

MainFileLength
GetDocumentResult.MainFileLength integer

Hauptdateigröße

Name
GetDocumentResult.Name string

Name des Dokuments

PageCount
GetDocumentResult.PageCount integer

Seitenanzahl der Hauptdatei

Eigenschaften
GetDocumentResult.Properties array of object

Eigenschaften

GlobalValues
GetDocumentResult.Properties.GlobalValues array of object

GlobalValues

Werte
GetDocumentResult.Properties.GlobalValues.Values array of object

Werte

Kultur
GetDocumentResult.Properties.GlobalValues.Values.Culture string

Kultur

Text
GetDocumentResult.Properties.GlobalValues.Values.Text string

Text

PropertyTypeId
GetDocumentResult.Properties.PropertyTypeId string

Typ-ID des Indexfelds

Werte
GetDocumentResult.Properties.Values array of string

Werte

ProtectionDomainId
GetDocumentResult.ProtectionDomainId string

ID der Schutzdomäne

Erinnerungen
GetDocumentResult.Reminders array of object

Erinnerungen

Description
GetDocumentResult.Reminders.Description string

Beschreibung für Erinnerung

Intervall
GetDocumentResult.Reminders.Interval integer

Intervall in Tagen zwischen Erinnerungen

ProcessTemplateId
GetDocumentResult.Reminders.ProcessTemplateId string

Prozessvorlagen-ID für diese Erinnerung

ReminderDate
GetDocumentResult.Reminders.ReminderDate string

Datum der Erinnerung. Datumsformat: jjjj-MM-ddTHH:mm:ss

ReminderId
GetDocumentResult.Reminders.ReminderId string

ID der Erinnerung

SubjectIds
GetDocumentResult.Reminders.SubjectIds array of

subjectIds

UseUserFromProcessTemplate
GetDocumentResult.Reminders.UseUserFromProcessTemplate boolean

Definiert, ob die Benutzerdefinition aus der Prozessvorlage verwendet wird.

SessionCount
GetDocumentResult.SessionCount integer

Sitzungsanzahl

SigningProfileId
GetDocumentResult.SigningProfileId string

ID des Signaturprofils

VersionId
GetDocumentResult.VersionId string

Versions-ID des Dokuments

Dokument aktualisieren (V2)

Dokument aktualisieren (V2)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DocumentTitle
DocumentTitle string

Dokumenttitel

DocumentProperties
DocumentProperties string

Dokumenteigenschaften-Aktualisierungsformat: Vorname=Peter|Nachname=Muller|InvoiceNo=4711; 4712; 4713

RemoveDocumentProperties
RemoveDocumentProperties string

Liste der durch Semikolons getrennten Eigenschaftsnamen oder IDs, die aus dem Dokument entfernt werden sollen, z. B. "FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680ddd; Abteilungen"

Kultur
Culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...). Default = de

DokumentID
DocumentId True string

ID des Dokuments

ProtectionDomain
ProtectionDomain string

ProtectionDomain-Name oder -ID

Blog
Blog string

Hinzufügen eines Blogtexteintrags zu einem Dokument

UploadMethod
UploadMethod string

Methode, die beim Hochladen des Dokuments in InfoShare verwendet wird. Default = UploadFileBytesLarge

FileContent
FileContent string

Dateiinhalt base64-Zeichenfolge

ForceUndoCheckout
ForceUndoCheckout boolean

Auschecken eines Dokuments rückgängig machen. Default = false

Blöcke
ChunkSize integer

Größe des Dateiuploadblocks, der mit UploadStreamChunks und UploadFileBytesLarge-Uploadmethoden verwendet wird, Standard-262144

Gibt zurück

Name Pfad Typ Beschreibung
Abonnements
abonnements array of object

Abonnements

OnContentChange
abonnements.onContentChange boolean

Abonnement ist bei Dateiänderungen aktiv

OnDelete
abonnements.onDelete boolean

Abonnement ist beim Löschen aktiv

OnMetadataChange
abonnements.onMetadataChange boolean

Abonnement ist bei Indexänderungen aktiv

UserId
abonnements.userId string

Die Benutzer-ID für dieses abonnnement

accessRightsEnumList
accessRightsEnumList array of string

Liste der Zugriffsberechtigungen

postItAnnotations
annotationManager.postItAnnotations array of object

postItAnnotations

CreatedDate
annotationManager.postItAnnotations.createdDate string

Erstellungsdatum aus der Anmerkung nach der Veröffentlichung

CreatorId
annotationManager.postItAnnotations.creatorId string

Benutzer-ID des Erstellers aus der Anmerkungen

IsItalic
annotationManager.postItAnnotations.fontInfo.isItalic boolean

Ist die Schriftart kursiv aus der Anmerkung

IsStrikeOut
annotationManager.postItAnnotations.fontInfo.isStrikeOut boolean

Wird schriftart aus der Anmerkung herausgestrichen

IsUnderline
annotationManager.postItAnnotations.fontInfo.isUnderline boolean

Ist Schriftart unterstrichen aus der Anmerkung

Name
annotationManager.postItAnnotations.fontInfo.name string

Schriftartname aus der Anmerkung des Beitrags. Default = Arial

Neigung
annotationManager.postItAnnotations.fontInfo.pitch integer

Schriftabstand aus der Anmerkung nach der Notiz

Größe
annotationManager.postItAnnotations.fontInfo.size integer

Schriftgrad aus der Anmerkung nach dem Posten. Beispiel: Größe:12 ist 12000. Sie benötigen Faktor 1000

Weight
annotationManager.postItAnnotations.fontInfo.weight integer

Schriftbreite aus der Anmerkung "Posten"

Id
annotationManager.postItAnnotations.id string

Anmerkungsbeitrags-ID

ModifiedDate
annotationManager.postItAnnotations.modifiedDate string

Datum der Änderung aus der Anmerkung nach dem Posten. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.postItAnnotations.pageNumber integer

Anzahl der Seiten aus der Anmerkung nach dem Posten

SecurityLevelEnum
annotationManager.postItAnnotations.securityLevelEnum string

Sicherheitsstufe für die Bereitstellung der Anmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.postItAnnotations.selectable boolean

Definiert, ob die Anmerkung nach dem Beitrag vom Benutzer ausgewählt werden kann.

Text
annotationManager.postItAnnotations.text string

Benutzerdefinierter Text für den Beitrag der Anmerkung

X
annotationManager.postItAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI des Beitrags

J
annotationManager.postItAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI des Beitrags

rectangleAnnotations
annotationManager.rectangleAnnotations array of object

rectangleAnnotations

Farbe
annotationManager.rectangleAnnotations.color integer

Farbe des Rechtecks (32-Bit-ARGB-Wert) aus Rechteckanmerkung Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

ColorHexCode
annotationManager.rectangleAnnotations.colorHexCode string

Farbe des Rechtecks (RGB-Hexadezimalcode) aus Rechteckanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

CreatedDate
annotationManager.rectangleAnnotations.createdDate string

Erstellungsdatum aus Rechteckanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

creatorId
annotationManager.rectangleAnnotations.creatorId string

Ersteller-ID für Rechteckanmerkungen

Höhe
annotationManager.rectangleAnnotations.height integer

Höhe des Rechtecks in Pixel pro Zoll für 7200 DPI

Id
annotationManager.rectangleAnnotations.Id string

Rectangle-Anmerkungs-ID

ModifiedDate
annotationManager.rectangleAnnotations.modifiedDate string

Änderungsdatum der Rechteckanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.rectangleAnnotations.pageNumber integer

Anzahl der Seiten aus Rechteckanmerkung

SecurityLevelEnum
annotationManager.rectangleAnnotations.securityLevelEnum string

Sicherheitsstufe für Rechteckanmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.rectangleAnnotations.selectable boolean

Definiert, ob die Rechteckanmerkung vom Benutzer auswählbar ist.

Transparent
annotationManager.rectangleAnnotations.transparent boolean

Rechteck sollte transparent sein (Hervorhebung)

Breite
annotationManager.rectangleAnnotations.width integer

Breite des Rechtecks in Pixel pro Zoll für 7200 DPI

X
annotationManager.rectangleAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI aus Rechteckanmerkung

J
annotationManager.rectangleAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI aus Rechteckanmerkung

textAnnotations
annotationManager.textAnnotations array of object

Textanmerkungen

BackgroundColor
annotationManager.textAnnotations.backgroundColor integer

Farbe des Hintergrunds (32-Bit-ARGB-Wert) aus Textanmerkung. Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

BackgroundColorHexCode
annotationManager.textAnnotations.backgroundColorHexCode string

Hintergrundfarbe (RGB-Hexadezimalcode) aus Textanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

CreatedDate
annotationManager.textAnnotations.createdDate string

Erstellungsdatum aus Textanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
annotationManager.textAnnotations.creatorId string

Benutzer-ID des Erstellers aus Textanmerkung

IsItalic
annotationManager.textAnnotations.fontInfo.isItalic boolean

Ist Schriftart kursiv aus Textanmerkung

IsStrikeOut
annotationManager.textAnnotations.fontInfo.isStrikeOut boolean

Wird die Schriftart aus der Textanmerkung herausgestrichen

IsUnderline
annotationManager.textAnnotations.fontInfo.isUnderline boolean

Ist schrift unterstrichen aus Textanmerkung

Name
annotationManager.textAnnotations.fontInfo.name string

Schriftartname aus Textanmerkung. Default = Arial

Neigung
annotationManager.textAnnotations.fontInfo.pitch integer

Schriftabstand von Textanmerkung

Größe
annotationManager.textAnnotations.fontInfo.size integer

Schriftgrad aus Textanmerkung. Beispiel: Größe:12 ist 12000. Sie benötigen Faktor 1000

Weight
annotationManager.textAnnotations.fontInfo.weight integer

Schriftbreite aus Textanmerkung

ForegroundColor
annotationManager.textAnnotations.foregroundColor integer

Farbe des Vordergrunds (32-Bit-ARGB-Wert) aus Textanmerkung. Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

ForegroundColorHexCode
annotationManager.textAnnotations.foregroundColorHexCode string

Farbe des Vordergrunds (RGB-Hexadezimalcode) aus Textanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

Höhe
annotationManager.textAnnotations.height integer

Höhe von Text in Pixel pro Zoll für 7200 DPI aus Textanmerkung

Id
annotationManager.textAnnotations.id string

ID der Textanmerkung

ModifiedDate
annotationManager.textAnnotations.modifiedDate string

Datum der Änderung aus textanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.textAnnotations.pageNumber integer

Anzahl der Seiten aus Textanmerkung

Drehung
annotationManager.textAnnotations.rotation integer

Drehung in Grad von textanmerkung

SecurityLevelEnum
annotationManager.textAnnotations.securityLevelEnum string

Sicherheitsstufe für Textanmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.textAnnotations.selectable boolean

Definiert, ob die Textanmerkung vom Benutzer auswählbar ist.

Text
annotationManager.textAnnotations.text string

Benutzerdefinierter Text der Textanmerkung

Transparent
annotationManager.textAnnotations.transparent boolean

Textanmerkung sollte transparent sein

Breite
annotationManager.textAnnotations.width integer

Breite von Text in Pixel pro Zoll für 7200 DPI aus Textanmerkung

X
annotationManager.textAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI aus Textanmerkung

J
annotationManager.textAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI aus Textanmerkung

Blogs
blogs array of object

Blogs

CreatedDate
blogs.createdDate string

Datum, an dem der Blog erstellt wurde. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
blogs.creatorId string

Benutzer-ID des Erstellens des Benutzerblogs

Id
blogs.id string

ID des Blogs

Text
blogs.text string

Text des Blogelements

CheckOutStateEnum
checkOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
checkOutUserId string

ID des Benutzers, für das das Dokument ausgecheckt ist

documentData
documentData array of object

Dokumentdaten

Id
documentData.id string

Dokumentdaten-ID

Name
documentData.name string

Dokumentdatenname

Wiedergaben
documentData.renditions array of

Wiedergaben

HasOverlay
hasOverlay boolean

Definiert, ob das Dokument mit einer Überlagerung angezeigt werden soll.

Id
id string

ID des Dokuments

ImportTemplateId
importTemplateId string

ID der Importvorlage für dieses Dokument

InfoStoreId
infoStoreId string

ID des Informationsspeichers

CheckOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

Lebenszyklusstatus des Auscheckens

LifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

Berechnetes Enddatum des Lebenszyklus. Datumsformat: jjjj-MM-ddTHH:mm:ss

LifeCycleStartDate
lifeCycleManager.lifeCycleStartDate string

Startdatum des Lebenszyklus. Datumsformat: jjjj-MM-ddTHH:mm:ss

LifeCycleStateId
lifeCycleManager.lifeCycleStateId string

ID des LifeCycle-Zustands

NextAutomaticLifeCycleStateId
lifeCycleManager.nextAutomaticLifeCycleStateId string

Nächster automatischer Lebenszyklusstatus

nextLifeCycleStates
lifeCycleManager.nextLifeCycleStates array of string

Nächste Lebenszykluszustände

lifeCycleProtections
lifeCycleManager.lifeCycleProtections array of object

lifeCycleProtections

DeleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

Dokument nach Ablauf des Schutzes löschen lassen

Id
lifeCycleManager.lifeCycleProtections.id string

ID des Lebenszyklusstatusschutzes

ProtectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

Schutz vor Anmerkungsänderungen

ProtectCheckOut
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

Schutz vor Auschecken

ProtectContentChange
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

Schutz vor Inhaltsänderungen

ProtectDelete
lifeCycleManager.lifeCycleProtections.protectDelete boolean

Schutz vor Löschvorgang

ProtectPropertyChange
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

Schutz vor Eigenschaftenänderungen

ProtectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

Schutz vor Sicherheitsänderungen

ProtectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

Dauer des Schutzes

LifeCycleId
lifeCycleManager.lifeCycleId string

ID des LifeCycle

MainFileLength
mainFileLength integer

Hauptdateigröße

Name
name string

Name des Dokuments

PageCount
pageCount integer

Seitenanzahl der Hauptdatei

Eigenschaften
properties array of object

Eigenschaften

globalValues
properties.globalValues array of object

Globale Werte

values
properties.globalValues.values array of object

values

Kultur
properties.globalValues.values.culture string

Globale Wertkultur

Text
properties.globalValues.values.text string

Globaler Werttext

Eigenschaftsname
properties.propertyName string

Name der Eigenschaft

PropertyTypeId
properties.propertyTypeId string

Typ-ID des Indexfelds

values
properties.values array of string

Eigenschaftstypwerte

ProtectionDomainId
protectionDomainId string

ID der Schutzdomäne

Erinnerungen
reminders array of object

Erinnerungen

Description
reminders.description string

Beschreibung für Erinnerung

Intervall
reminders.interval integer

Intervall in Tagen zwischen Erinnerungen

ProcessTemplateId
reminders.processTemplateId string

Prozessvorlagen-ID für diese Erinnerung

ReminderDate
reminders.reminderDate string

Datum der Erinnerung. Datumsformat: jjjj-MM-ddTHH:mm:ss

ReminderId
reminders.reminderId string

ID der Erinnerung

subjectIds
reminders.subjectIds array of

subjectIds

UseUserFromProcessTemplate
reminders.useUserFromProcessTemplate boolean

Definiert, ob die Benutzerdefinition aus der Prozessvorlage verwendet wird.

SigningProfileId
signingProfileId string

ID des Signaturprofils

VersionId
versionId string

Versions-ID des Dokuments

Dokument aktualisieren (veraltet) [VERALTET]

Dokument aktualisieren (veraltet)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DokumentID
DocumentId True string

ID des Dokuments

DocumentTitle
DocumentTitle string

Dokumenttitel

DocumentProperties
DocumentProperties string

Dokumenteigenschaften-Aktualisierungsformat: Vorname=Peter|Nachname=Muller|InvoiceNo=4711; 4712; 4713

Kultur
Culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...). Default = de

FileContent
FileContent string

Dateiinhalt base64-Zeichenfolge

Gibt zurück

Name Pfad Typ Beschreibung
Abonnements
abonnements array of object

Abonnements

OnContentChange
abonnements.onContentChange boolean

Abonnement ist bei Dateiänderungen aktiv

OnDelete
abonnements.onDelete boolean

Abonnement ist beim Löschen aktiv

OnMetadataChange
abonnements.onMetadataChange boolean

Abonnement ist bei Indexänderungen aktiv

UserId
abonnements.userId string

Die Benutzer-ID für dieses abonnnement

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

postItAnnotations
annotationManager.postItAnnotations array of object

postItAnnotations

CreatedDate
annotationManager.postItAnnotations.createdDate string

Erstellungsdatum aus der Anmerkung nach der Veröffentlichung

CreatorId
annotationManager.postItAnnotations.creatorId string

Benutzer-ID des Erstellers aus der Anmerkungen

IsItalic
annotationManager.postItAnnotations.fontInfo.isItalic boolean

Ist die Schriftart kursiv aus der Anmerkung

IsStrikeOut
annotationManager.postItAnnotations.fontInfo.isStrikeOut boolean

Wird schriftart aus der Anmerkung herausgestrichen

IsUnderline
annotationManager.postItAnnotations.fontInfo.isUnderline boolean

Ist Schriftart unterstrichen aus der Anmerkung

Name
annotationManager.postItAnnotations.fontInfo.name string

Schriftartname aus der Anmerkung des Beitrags. Default = Arial

Neigung
annotationManager.postItAnnotations.fontInfo.pitch integer

Schriftabstand aus der Anmerkung nach der Notiz

Größe
annotationManager.postItAnnotations.fontInfo.size integer

Schriftgrad aus der Anmerkung nach dem Posten. Beispiel: Größe:12 ist 12000. Sie benötigen Faktor 1000

Weight
annotationManager.postItAnnotations.fontInfo.weight integer

Schriftbreite aus der Anmerkung "Posten"

Id
annotationManager.postItAnnotations.id string

ID des Beitrags

ModifiedDate
annotationManager.postItAnnotations.modifiedDate string

Datum der Änderung aus der Anmerkung nach dem Posten. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.postItAnnotations.pageNumber integer

Anzahl der Seiten aus der Anmerkung nach dem Posten

SecurityLevelEnum
annotationManager.postItAnnotations.securityLevelEnum string

Sicherheitsstufe für die Bereitstellung der Anmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.postItAnnotations.selectable boolean

Definiert, ob die Anmerkung nach dem Beitrag vom Benutzer ausgewählt werden kann.

Text
annotationManager.postItAnnotations.text string

Benutzerdefinierter Text für den Beitrag der Anmerkung

X
annotationManager.postItAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI des Beitrags

J
annotationManager.postItAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI des Beitrags

rectangleAnnotations
annotationManager.rectangleAnnotations array of object

rectangleAnnotations

Farbe
annotationManager.rectangleAnnotations.color integer

Farbe des Rechtecks (32-Bit-ARGB-Wert) aus Rechteckanmerkung Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

ColorHexCode
annotationManager.rectangleAnnotations.colorHexCode string

Farbe des Rechtecks (RGB-Hexadezimalcode) aus Rechteckanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

CreatedDate
annotationManager.rectangleAnnotations.createdDate string

Erstellungsdatum aus Rechteckanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

creatorId
annotationManager.rectangleAnnotations.creatorId string

CreatorId

Höhe
annotationManager.rectangleAnnotations.height integer

Höhe des Rechtecks in Pixel pro Zoll für 7200 DPI

Id
annotationManager.rectangleAnnotations.Id string

ID der Rechteckanmerkung

ModifiedDate
annotationManager.rectangleAnnotations.modifiedDate string

Änderungsdatum der Rechteckanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.rectangleAnnotations.pageNumber integer

Anzahl der Seiten aus Rechteckanmerkung

SecurityLevelEnum
annotationManager.rectangleAnnotations.securityLevelEnum string

Sicherheitsstufe für Rechteckanmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.rectangleAnnotations.selectable boolean

Definiert, ob die Rechteckanmerkung vom Benutzer auswählbar ist.

Transparent
annotationManager.rectangleAnnotations.transparent boolean

Rechteck sollte transparent sein (Hervorhebung)

Breite
annotationManager.rectangleAnnotations.width integer

Breite des Rechtecks in Pixel pro Zoll für 7200 DPI

X
annotationManager.rectangleAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI aus Rechteckanmerkung

J
annotationManager.rectangleAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI aus Rechteckanmerkung

textAnnotations
annotationManager.textAnnotations array of object

textAnnotations

BackgroundColor
annotationManager.textAnnotations.backgroundColor integer

Farbe des Hintergrunds (32-Bit-ARGB-Wert) aus Textanmerkung. Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

BackgroundColorHexCode
annotationManager.textAnnotations.backgroundColorHexCode string

Hintergrundfarbe (RGB-Hexadezimalcode) aus Textanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

CreatedDate
annotationManager.textAnnotations.createdDate string

Erstellungsdatum aus Textanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
annotationManager.textAnnotations.creatorId string

Benutzer-ID des Erstellers aus Textanmerkung

IsItalic
annotationManager.textAnnotations.fontInfo.isItalic boolean

Ist Schriftart kursiv aus Textanmerkung

IsStrikeOut
annotationManager.textAnnotations.fontInfo.isStrikeOut boolean

Wird die Schriftart aus der Textanmerkung herausgestrichen

IsUnderline
annotationManager.textAnnotations.fontInfo.isUnderline boolean

Ist schrift unterstrichen aus Textanmerkung

Name
annotationManager.textAnnotations.fontInfo.name string

Schriftartname aus Textanmerkung. Default = Arial

Neigung
annotationManager.textAnnotations.fontInfo.pitch integer

Schriftabstand von Textanmerkung

Größe
annotationManager.textAnnotations.fontInfo.size integer

Schriftgrad aus Textanmerkung. Beispiel: Größe:12 ist 12000. Sie benötigen Faktor 1000

Weight
annotationManager.textAnnotations.fontInfo.weight integer

Schriftbreite aus Textanmerkung

ForegroundColor
annotationManager.textAnnotations.foregroundColor integer

Farbe des Vordergrunds (32-Bit-ARGB-Wert) aus Textanmerkung. Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

ForegroundColorHexCode
annotationManager.textAnnotations.foregroundColorHexCode string

Farbe des Vordergrunds (RGB-Hexadezimalcode) aus Textanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

Höhe
annotationManager.textAnnotations.height integer

Höhe von Text in Pixel pro Zoll für 7200 DPI aus Textanmerkung

Id
annotationManager.textAnnotations.id string

ID der Textanmerkung

ModifiedDate
annotationManager.textAnnotations.modifiedDate string

Datum der Änderung aus textanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.textAnnotations.pageNumber integer

Anzahl der Seiten aus Textanmerkung

Drehung
annotationManager.textAnnotations.rotation integer

Drehung in Grad von textanmerkung

SecurityLevelEnum
annotationManager.textAnnotations.securityLevelEnum string

Sicherheitsstufe für Textanmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.textAnnotations.selectable boolean

Definiert, ob die Textanmerkung vom Benutzer auswählbar ist.

Text
annotationManager.textAnnotations.text string

Benutzerdefinierter Text der Textanmerkung

Transparent
annotationManager.textAnnotations.transparent boolean

Textanmerkung sollte transparent sein

Breite
annotationManager.textAnnotations.width integer

Breite von Text in Pixel pro Zoll für 7200 DPI aus Textanmerkung

X
annotationManager.textAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI aus Textanmerkung

J
annotationManager.textAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI aus Textanmerkung

Blogs
blogs array of object

Blogs

CreatedDate
blogs.createdDate string

Datum, an dem der Blog erstellt wurde. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
blogs.creatorId string

Benutzer-ID des Erstellens des Benutzerblogs

Id
blogs.id string

ID des Blogs

Text
blogs.text string

Text des Blogelements

CheckOutStateEnum
checkOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
checkOutUserId string

ID des Benutzers, für das das Dokument ausgecheckt ist

documentData
documentData array of object

documentData

Id
documentData.id string

ID der Dokumentdaten

Name
documentData.name string

Dokumentdatenname

Wiedergaben
documentData.renditions array of

Wiedergaben

HasOverlay
hasOverlay boolean

Definiert, ob das Dokument mit einer Überlagerung angezeigt werden soll.

Id
id string

ID des Dokuments

ImportTemplateId
importTemplateId string

ID der Importvorlage für dieses Dokument

InfoStoreId
infoStoreId string

ID des Informationsspeichers

CheckOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

Lebenszyklusstatus des Auscheckens

LifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

Berechnetes Enddatum des Lebenszyklus. Datumsformat: jjjj-MM-ddTHH:mm:ss

LifeCycleStartDate
lifeCycleManager.lifeCycleStartDate string

Startdatum des Lebenszyklus. Datumsformat: jjjj-MM-ddTHH:mm:ss

LifeCycleStateId
lifeCycleManager.lifeCycleStateId string

ID des LifeCycle-Zustands

NextAutomaticLifeCycleStateId
lifeCycleManager.nextAutomaticLifeCycleStateId string

Nächster automatischer Lebenszyklusstatus

nextLifeCycleStates
lifeCycleManager.nextLifeCycleStates array of string

nextLifeCycleStates

lifeCycleProtections
lifeCycleManager.lifeCycleProtections array of object

lifeCycleProtections

DeleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

Dokument nach Ablauf des Schutzes löschen lassen

Id
lifeCycleManager.lifeCycleProtections.id string

ID des Lebenszyklusstatusschutzes

ProtectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

Schutz vor Anmerkungsänderungen

ProtectCheckOut
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

Schutz vor Auschecken

ProtectContentChange
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

Schutz vor Inhaltsänderungen

ProtectDelete
lifeCycleManager.lifeCycleProtections.protectDelete boolean

Schutz vor Löschvorgang

ProtectPropertyChange
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

Schutz vor Eigenschaftenänderungen

ProtectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

Schutz vor Sicherheitsänderungen

ProtectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

Dauer des Schutzes

LifeCycleId
lifeCycleManager.lifeCycleId string

ID des LifeCycle

MainFileLength
mainFileLength integer

Hauptdateigröße

Name
name string

Name des Dokuments

PageCount
pageCount integer

Seitenanzahl der Hauptdatei

Eigenschaften
properties array of object

Eigenschaften

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

Kultur
properties.globalValues.values.culture string

Kultur

Text
properties.globalValues.values.text string

Text

Eigenschaftsname
properties.propertyName string

Name der Eigenschaft

PropertyTypeId
properties.propertyTypeId string

Typ-ID des Indexfelds

values
properties.values array of string

PropertyType-Werte

ProtectionDomainId
protectionDomainId string

ID der Schutzdomäne

Erinnerungen
reminders array of object

Erinnerungen

Description
reminders.description string

Beschreibung für Erinnerung

Intervall
reminders.interval integer

Intervall in Tagen zwischen Erinnerungen

ProcessTemplateId
reminders.processTemplateId string

Prozessvorlagen-ID für diese Erinnerung

ReminderDate
reminders.reminderDate string

Datum der Erinnerung. Datumsformat: jjjj-MM-ddTHH:mm:ss

ReminderId
reminders.reminderId string

ID der Erinnerung

subjectIds
reminders.subjectIds array of

subjectIds

UseUserFromProcessTemplate
reminders.useUserFromProcessTemplate boolean

Definiert, ob die Benutzerdefinition aus der Prozessvorlage verwendet wird.

SigningProfileId
signingProfileId string

ID des Signaturprofils

VersionId
versionId string

Versions-ID des Dokuments

Dokument erstellen (V2)

Dokument erstellen (V2)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DocumentTitle
DocumentTitle True string

Titel des Dokuments (inkl. Erweiterung)

ImportTemplate
ImportTemplate string

Der Name oder die ID der Importvorlage, falls leer, müssen InfoStore- und ProtectionDomain-Werte angegeben werden.

DocumentProperties
DocumentProperties string

Format für Dokumenteigenschaften einfügen: Vorname=Peter|Nachname=Muller|InvoiceNo=4711; 4712; 4713

Blog
Blog string

Hinzufügen eines Blogtexteintrags zu einem Dokument

Kultur
Culture string

Die Kultur, in der die Eigenschaftsnamen angegeben werden (de, en, fr, ...). Default = de

InfoStore
InfoStore string

InfoStore-Name oder -ID muss angegeben werden, wenn ImportTemplate leer ist

LifeCycle
LifeCycle string

LifeCycle Name oder ID

ProtectionDomain
ProtectionDomain string

ProtectionDomain Name oder ID muss angegeben werden, wenn ImportTemplate leer ist

UploadMethod
UploadMethod string

Methode, die beim Hochladen des Dokuments in InfoShare verwendet wird. Default = UploadFileBytesLarge

OriginalFileFormat
OriginalFileFormat string

Ursprüngliches Dateiformat für Konvertierungszwecke, z. B. "html". In PDF konvertiert

Blöcke
ChunkSize integer

Größe des Dateiuploadblocks, der mit UploadStreamChunks und UploadFileBytesLarge-Uploadmethoden verwendet wird, Standard

FileContent
FileContent True string

Dateiinhalt base64-Zeichenfolge

Gibt zurück

Name Pfad Typ Beschreibung
name
name string

name

id
id string

Dokument-ID

versionId
versionId string

Versions-ID

currentVersionId
currentVersionId string

Aktuelle Versions-ID

protectionDomainId
protectionDomainId string

Schutzdomänen-ID

infoStoreId
infoStoreId string

InfoStore-ID

checkOutStateEnum
checkOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

checkOutUserId
checkOutUserId string

Ausgecheckte Benutzer-ID

Eigenschaften
properties array of object

Eigenschaften

propertyTypeId
properties.propertyTypeId string

PropertyType-ID

values
properties.values array of string

PropertyType-Werte

globalValues
properties.globalValues array of object

Globale Werte

values
properties.globalValues.values array of object

values

Kultur
properties.globalValues.values.culture string

Globale Wertkultur

Text
properties.globalValues.values.text string

Globaler Werttext

propertyTypeName
properties.propertyTypeName string

PropertyType-Name

Eigenschaftsname
properties.propertyName string

Eigenschaftsname

importTemplateId
importTemplateId string

Vorlagen-ID importieren

Blogs
blogs array of object

Blogs

Erstellungsdatum
blogs.createdDate string

Erstellungsdatum des Blogs

creatorId
blogs.creatorId string

Blog creator Id

Text
blogs.text string

Blogtext

id
blogs.id string

ID des Blogs

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

Erinnerungen
reminders array of

Erinnerungen

pageCount
pageCount integer

Seitenanzahl

mainFileLength
mainFileLength integer

Hauptdateilänge

Abonnements
abonnements array of

Abonnements

textAnnotations
annotationManager.textAnnotations array of

Anmerkungstext

rectangleAnnotations
annotationManager.rectangleAnnotations array of

Anmerkungsrechteck

postItAnnotations
annotationManager.postItAnnotations array of

Anmerkungen posten es

stampAnnotations
annotationManager.stampAnnotations array of

Anmerkungsstempel

documentData
documentData array of object

Dokumentdaten

id
documentData.id string

Dokumentdaten-ID

name
documentData.name string

Dokumentdatenname

Wiedergaben
documentData.renditions array of object

Wiedergaben

id
documentData.renditions.id string

Darstellungs-ID

size
documentData.renditions.size string

Formatvariantengröße

files
documentData.renditions.files array of object

files

blobStoreId
documentData.renditions.files.blobStoreId string

BLOB-Speicher-ID

blobPath (englisch)
documentData.renditions.files.blobPath string

BLOB-Pfad

pageCount
documentData.renditions.pageCount string

Seitenanzahl der Formatvariante

Erweiterung
documentData.renditions.extension string

Darstellungserweiterung

hashValue
documentData.renditions.hashValue array of integer

Hashwert der Formatvariante

contentProtections
documentData.renditions.contentProtections array of

Schutz von Inhaltsdarstellungen

signingProfileId
signingProfileId string

Signaturprofil-ID

lifeCycleId
lifeCycleManager.lifeCycleId string

Lebenszyklus-ID

lifeCycleStateId
lifeCycleManager.lifeCycleStateId string

Lebenszyklusstatus-ID

lifeCycleStartDate
lifeCycleManager.lifeCycleStartDate string

Startdatum des Lebenszyklus

lifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

Enddatum des Lebenszyklus

nextLifeCycleStates
lifeCycleManager.nextLifeCycleStates array of

Nächste Lebenszykluszustände

checkOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

Auschecken der Lebenszyklusstatus-ID

nextAutomaticLifeCycleStateId
lifeCycleManager.nextAutomaticLifeCycleStateId string

Nächste id des automatischen Lebenszyklusstatus

lifeCycleProtections
lifeCycleManager.lifeCycleProtections array of object

Lebenszyklusschutz

id
lifeCycleManager.lifeCycleProtections.id string

Lebenszyklusschutz-ID

protectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

Lebenszyklusschutz dauer Ticks

protectCheckOut
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

Lebenszyklus schützen Auschecken

protectContentChange
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

Lebenszyklusschutz für Inhaltsänderungen

protectPropertyChange
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

Lebenszyklus schützen Eigenschaftenänderung

protectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

Lebenszyklus schützen Anmerkungsänderungen

protectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

Lebenszyklusschutz für Domänenänderungen

protectDelete
lifeCycleManager.lifeCycleProtections.protectDelete boolean

Lebenszyklus schützen Löschvorgang

deleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

Lebenszykluslöschung nach Ablauf

hasOverlay
hasOverlay boolean

Hat Überlagerung

sessionCount
sessionCount integer

Sitzungsanzahl

hasSignature
hasSignature boolean

Hat Signatur

hasBlog
hasBlog boolean

Hat Blog

hasAnnotation
hasAnnotation boolean

Hat Anmerkung

hasTempAccess
hasTempAccess boolean

Hat temporären Zugriff

hasReminders
hasReminders boolean

Enthält Erinnerungen

hasLinks
hasLinks boolean

Enthält Links

hasAbonnement
hasAbonnement boolean

Hat Abonnement

Dokument erstellen (veraltet) [VERALTET]

Dokument erstellen (veraltet)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DocumentTitle
DocumentTitle True string

Titel des Dokuments (inkl. Erweiterung)

ImportTemplate
ImportTemplate True string

Vorlage importieren

DocumentProperties
DocumentProperties string

Format für Dokumenteigenschaften einfügen: Vorname=Peter|Nachname=Muller|InvoiceNo=4711; 4712; 4713

Kultur
Culture string

Die Kultur, in der die Eigenschaftsnamen angegeben werden (de, en, fr, ...). Default = de

FileContent
FileContent True string

Dateiinhalt base64-Zeichenfolge

Gibt zurück

Name Pfad Typ Beschreibung
Abonnements
abonnements array of string

Abonnements

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

postItAnnotations
annotationManager.postItAnnotations array of object

postItAnnotations

CreatedDate
annotationManager.postItAnnotations.createdDate string

Erstellungsdatum aus der Anmerkung nach der Veröffentlichung

CreatorId
annotationManager.postItAnnotations.creatorId string

Benutzer-ID des Erstellers aus der Anmerkungen

IsItalic
annotationManager.postItAnnotations.fontInfo.isItalic boolean

Ist die Schriftart kursiv aus der Anmerkung

IsStrikeOut
annotationManager.postItAnnotations.fontInfo.isStrikeOut boolean

Wird schriftart aus der Anmerkung herausgestrichen

IsUnderline
annotationManager.postItAnnotations.fontInfo.isUnderline boolean

Ist Schriftart unterstrichen aus der Anmerkung

Name
annotationManager.postItAnnotations.fontInfo.name string

Schriftartname aus der Anmerkung des Beitrags. Default = Arial

Neigung
annotationManager.postItAnnotations.fontInfo.pitch integer

Schriftabstand aus der Anmerkung nach der Notiz

Größe
annotationManager.postItAnnotations.fontInfo.size integer

Schriftgrad aus der Anmerkung nach dem Posten. Beispiel: Größe:12 ist 12000. Sie benötigen Faktor 1000

Weight
annotationManager.postItAnnotations.fontInfo.weight integer

Schriftbreite aus der Anmerkung "Posten"

Id
annotationManager.postItAnnotations.id string

ID des Beitrags

ModifiedDate
annotationManager.postItAnnotations.modifiedDate string

Datum der Änderung aus der Anmerkung nach dem Posten. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.postItAnnotations.pageNumber integer

Anzahl der Seiten aus der Anmerkung nach dem Posten

SecurityLevelEnum
annotationManager.postItAnnotations.securityLevelEnum string

Sicherheitsstufe für die Bereitstellung der Anmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.postItAnnotations.selectable boolean

Definiert, ob die Anmerkung nach dem Beitrag vom Benutzer ausgewählt werden kann.

Text
annotationManager.postItAnnotations.text string

Benutzerdefinierter Text für den Beitrag der Anmerkung

X
annotationManager.postItAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI des Beitrags

J
annotationManager.postItAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI des Beitrags

rectangleAnnotations
annotationManager.rectangleAnnotations array of object

rectangleAnnotations

Farbe
annotationManager.rectangleAnnotations.color integer

Farbe des Rechtecks (32-Bit-ARGB-Wert) aus Rechteckanmerkung Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

ColorHexCode
annotationManager.rectangleAnnotations.colorHexCode string

Farbe des Rechtecks (RGB-Hexadezimalcode) aus Rechteckanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

CreatedDate
annotationManager.rectangleAnnotations.createdDate string

Erstellungsdatum aus Rechteckanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

creatorId
annotationManager.rectangleAnnotations.creatorId string

CreatorId

Höhe
annotationManager.rectangleAnnotations.height integer

Höhe des Rechtecks in Pixel pro Zoll für 7200 DPI

Id
annotationManager.rectangleAnnotations.Id string

ID der Rechteckanmerkung

ModifiedDate
annotationManager.rectangleAnnotations.modifiedDate string

Änderungsdatum der Rechteckanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.rectangleAnnotations.pageNumber integer

Anzahl der Seiten aus Rechteckanmerkung

SecurityLevelEnum
annotationManager.rectangleAnnotations.securityLevelEnum string

Sicherheitsstufe für Rechteckanmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.rectangleAnnotations.selectable boolean

Definiert, ob die Rechteckanmerkung vom Benutzer auswählbar ist.

Transparent
annotationManager.rectangleAnnotations.transparent boolean

Rechteck sollte transparent sein (Hervorhebung)

Breite
annotationManager.rectangleAnnotations.width integer

Breite des Rechtecks in Pixel pro Zoll für 7200 DPI

X
annotationManager.rectangleAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI aus Rechteckanmerkung

J
annotationManager.rectangleAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI aus Rechteckanmerkung

textAnnotations
annotationManager.textAnnotations array of object

textAnnotations

BackgroundColor
annotationManager.textAnnotations.backgroundColor integer

Farbe des Hintergrunds (32-Bit-ARGB-Wert) aus Textanmerkung Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

BackgroundColorHexCode
annotationManager.textAnnotations.backgroundColorHexCode string

Hintergrundfarbe (RGB-Hexadezimalcode) aus Textanmerkungsbeispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

CreatedDate
annotationManager.textAnnotations.createdDate string

Erstellungsdatum aus Textanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
annotationManager.textAnnotations.creatorId string

Benutzer-ID des Erstellers aus Textanmerkung

IsItalic
annotationManager.textAnnotations.fontInfo.isItalic boolean

Ist Schriftart kursiv aus Textanmerkung

IsStrikeOut
annotationManager.textAnnotations.fontInfo.isStrikeOut boolean

Wird die Schriftart aus der Textanmerkung herausgestrichen

IsUnderline
annotationManager.textAnnotations.fontInfo.isUnderline boolean

Ist schrift unterstrichen aus Textanmerkung

Name
annotationManager.textAnnotations.fontInfo.name string

Schriftartname aus Textanmerkung. Default = Arial

Neigung
annotationManager.textAnnotations.fontInfo.pitch integer

Schriftabstand von Textanmerkung

Größe
annotationManager.textAnnotations.fontInfo.size integer

Schriftgrad aus Textanmerkung. Beispiel: Größe:12 ist 12000. Sie benötigen Faktor 1000

Weight
annotationManager.textAnnotations.fontInfo.weight integer

Schriftbreite aus Textanmerkung

ForegroundColor
annotationManager.textAnnotations.foregroundColor integer

Farbe des Vordergrunds (32-Bit-ARGB-Wert) aus Textanmerkung. Beispiel: Schwarz: -16777216 Weiß: -1 Rot: -65536 Grün: -16744448 Blau: -16776961

ForegroundColorHexCode
annotationManager.textAnnotations.foregroundColorHexCode string

Farbe des Vordergrunds (RGB-Hexadezimalcode) aus Textanmerkung. Beispiel: Schwarz: #000000 Weiß: #FFFFFF Rot: #FF0000 Grün: #008000 Blau: #0000FF

Höhe
annotationManager.textAnnotations.height integer

Höhe von Text in Pixel pro Zoll für 7200 DPI aus Textanmerkung

Id
annotationManager.textAnnotations.id string

ID der Textanmerkung

ModifiedDate
annotationManager.textAnnotations.modifiedDate string

Datum der Änderung aus textanmerkung. Datumsformat: jjjj-MM-ddTHH:mm:ss

PageNumber
annotationManager.textAnnotations.pageNumber integer

Anzahl der Seiten aus Textanmerkung

Drehung
annotationManager.textAnnotations.rotation integer

Drehung in Grad von textanmerkung

SecurityLevelEnum
annotationManager.textAnnotations.securityLevelEnum string

Sicherheitsstufe für Textanmerkung (Öffentlich Verfügbar, Persönlich, PersonalProtected, OnlyEditors). Default = Öffentlich verfügbar

Auswählbar
annotationManager.textAnnotations.selectable boolean

Definiert, ob die Textanmerkung vom Benutzer auswählbar ist.

Text
annotationManager.textAnnotations.text string

Benutzerdefinierter Text der Textanmerkung

Transparent
annotationManager.textAnnotations.transparent boolean

Textanmerkung sollte transparent sein

Breite
annotationManager.textAnnotations.width integer

Breite von Text in Pixel pro Zoll für 7200 DPI aus Textanmerkung

X
annotationManager.textAnnotations.x integer

X-Koordinate in Pixel pro Zoll für 7200 DPI aus Textanmerkung

J
annotationManager.textAnnotations.y integer

Y-Koordinate in Pixel pro Zoll für 7200 DPI aus Textanmerkung

Blogs
blogs array of object

Blogs

Bloggen
blogs object

Liste aller Blogelemente

CheckOutState
checkOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
checkOutUserId string

ID des Benutzers, für das das Dokument ausgecheckt ist

documentData
documentData array of object

documentData

Id
documentData.id string

ID der Dokumentdarstellung

Name
documentData.name string

Dokumentname der Darstellung

Wiedergaben
documentData.renditions array of

Wiedergaben

HasOverlay
hasOverlay boolean

Definiert, ob das Dokument mit einer Überlagerung angezeigt werden soll.

Id
id string

ID des Dokuments

ImportTemplateId
importTemplateId string

ID der Importvorlage für dieses Dokument

InfoStoreId
infoStoreId string

ID des Informationsspeichers

CheckOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

Lebenszyklusstatus des Auscheckens

LifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

Berechnetes Enddatum des Lebenszyklus. Datumsformat: jjjj-MM-ddTHH:mm:ss

LifeCycleStartDate
lifeCycleManager.lifeCycleStartDate string

Startdatum des Lebenszyklus. Datumsformat: jjjj-MM-ddTHH:mm:ss

LifeCycleStateId
lifeCycleManager.lifeCycleStateId string

ID des LifeCycle-Zustands

NextAutomaticLifeCycleStateId
lifeCycleManager.nextAutomaticLifeCycleStateId string

Nächster automatischer Lebenszyklusstatus

nextLifeCycleStates
lifeCycleManager.nextLifeCycleStates array of string

nextLifeCycleStates

lifeCycleProtections
lifeCycleManager.lifeCycleProtections array of object

lifeCycleProtections

DeleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

Dokument nach Ablauf des Schutzes löschen lassen

Id
lifeCycleManager.lifeCycleProtections.id string

ID des Lebenszyklusstatusschutzes

ProtectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

Schutz vor Anmerkungsänderungen

ProtectCheckOut
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

Schutz vor Auschecken

ProtectContentChange
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

Schutz vor Inhaltsänderungen

ProtectDelete
lifeCycleManager.lifeCycleProtections.protectDelete boolean

Schutz vor Löschvorgang

ProtectPropertyChange
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

Schutz vor Eigenschaftenänderungen

ProtectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

Schutz vor Sicherheitsänderungen

ProtectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

Dauer des Schutzes

LifeCycleId
lifeCycleManager.lifeCycleId string

ID des LifeCycle

MainFileLength
mainFileLength integer

Hauptdateigröße

Name
name string

Name des Dokuments

PageCount
pageCount integer

Seitenanzahl der Hauptdatei

Eigenschaften
properties array of object

Eigenschaften

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

Kultur
properties.globalValues.values.culture string

Kultur

Text
properties.globalValues.values.text string

Text

PropertyTypeId
properties.propertyTypeId string

Typ-ID des Indexfelds

values
properties.values array of string

PropertyType-Werte

ProtectionDomainId
protectionDomainId string

ID der Schutzdomäne

Erinnerungen
reminders array of object

Erinnerungen

Erinnerungen
reminders object

Liste aller Erinnerungen

SessionCount
sessionCount integer

Sitzungsanzahl

SigningProfileId
signingProfileId string

ID des Signaturprofils

VersionId
versionId string

Versions-ID des Dokuments

Dokumentsuche (V2)

Dokumentsuche (V2)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Conditions
Conditions string

Suchbedingungsformat: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". z.B.: [Zuletzt einchecken|Weniger|2021-12-31|Und],[Vorname|Gleich|Peter|Und],[Datum|Zwischen|2021-12-31; 2022-12-31|Und]

MaxSerchResults
MaxSerchResults string

Maximale Anzahl von Dokumentsuchergebnissen. Standard = 100

ResultProperties
ResultProperties string

Ergebniseigenschaftenliste, kommagetrennt. Kann eigenschaftsname oder ID sein, z. B. "Name,Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a"

Kultur
Culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...). Default = de

Speicher
Stores string

Durch Trennzeichen getrennte Liste von InfoStores, in die gesucht werden soll. Der Name oder die ID kann gespeichert werden, z. B. "Standard,9cd306e3-7e96-486c-8280-65d9f0239776"

Gibt zurück

Name Pfad Typ Beschreibung
Urkunden
documents array of object

Ergebnis der Dokumentsuche

name
documents.name string

Dokumentname

id
documents.id string

Dokument-ID

folderElementId
documents.folderElementId string

Folder-Element-ID

checkOutStateEnum
documents.checkOutStateEnum string

Status-Enumeration auschecken

hasSignature
documents.hasSignature boolean

Hat Signatur

hasBlog
documents.hasBlog boolean

Hat Blog

hasAnnotation
documents.hasAnnotation boolean

Hat Anmerkung

hasLinks
documents.hasLinks boolean

Enthält Links

Eigenschaften
documents.properties array of object

Eigenschaften

propertyTypeId
documents.properties.propertyTypeId string

PropertyType-ID

values
documents.properties.values array of string

Eigenschaftstypwerte

globalValues
documents.properties.globalValues array of object

Globale Werte

values
documents.properties.globalValues.values array of object

values

Kultur
documents.properties.globalValues.values.culture string

Globale Wertekultur

Text
documents.properties.globalValues.values.text string

Text für globale Werte

propertyTypeName
documents.properties.propertyTypeName string

PropertyType-Name

Eigenschaftsname
documents.properties.propertyName string

Eigenschaftsname

hasTempAccess
documents.hasTempAccess boolean

Hat temporären Zugriff

accessRightsEnumList
documents.accessRightsEnumList array of string

Liste der Zugriffsberechtigungen

mainFileLength
documents.mainFileLength integer

Hauptdateilänge

versionId
documents.versionId string

Versions-ID

hasReminders
documents.hasReminders boolean

Enthält Erinnerungen

hasAbonnement
documents.hasAbonnement boolean

Hat Abonnement

hasOverlay
documents.hasOverlay boolean

Oas-Überlagerung

hasMehr
hasMore boolean

Hat mehr

resumePoint
resumePoint string

Fortsetzungspunkt

Dokumentsuche (veraltet) [VERALTET]

Dokumentsuche (veraltet)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Conditions
Conditions string

Suchbedingungsformat: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". z.B.: [Zuletzt einchecken|Weniger|2021-12-31|Und],[Vorname|Gleich|Peter|Und]

Kultur
Culture string

Kultur (de,en,fr,...). Default = de

FulltextWords
FulltextWords string

Wörter, die durchsucht werden sollen, mit Volltext

FulltextWordRelation
FulltextWordRelation string

Bezug von Volltextwörtern (UND, ODER). Standard = UND

MaxSerchResults
MaxSerchResults string

Maximale Anzahl von Dokumentsuchergebnissen. Standard = 100

Gibt zurück

Name Pfad Typ Beschreibung
Urkunden
documents array of object

Urkunden

Abonnements
documents.abonnements string

Liste der Abonnements

accessRightsEnumList
documents.accessRightsEnumList array of string

accessRightsEnumList

AnnotationManager
documents.annotationManager string

Anmerkungen für die Hauptdokumentdatei

Bloggen
documents.blogs string

Liste aller Blogelemente

CheckOutState
documents.checkOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
documents.checkOutUserId string

ID des Benutzers, für das das Dokument ausgecheckt ist

DocumentData
documents.documentData string

Dokumentdatenliste

HasOverlay
documents.hasOverlay boolean

Definiert, ob das Dokument mit einer Überlagerung angezeigt werden soll.

Id
documents.id string

ID des Dokuments

ImportTemplateId
documents.importTemplateId string

ID der Importvorlage für dieses Dokument

InfoStoreId
documents.infoStoreId string

ID des Informationsspeichers

LifeCycleManager
documents.lifeCycleManager string

Lebenszyklusinformationen

MainFileLength
documents.mainFileLength integer

Hauptdateigröße

Name
documents.name string

Name des Dokuments

PageCount
documents.pageCount integer

Seitenanzahl der Hauptdatei

Eigenschaften
documents.properties array of

Eigenschaften

ProtectionDomainId
documents.protectionDomainId string

ID der Schutzdomäne

Erinnerungen
documents.reminders string

Liste aller Erinnerungen

SessionCount
documents.sessionCount integer

Sitzungsanzahl

SigningProfileId
documents.signingProfileId string

ID des Signaturprofils

VersionId
documents.versionId string

Versions-ID des Dokuments

HasMore
hasMore boolean

Gibt an, ob mehr Ergebnisse vorhanden sind oder nicht. Das Kennzeichen ist auf "true" festgelegt, wenn weitere Ergebnisse verfügbar sind.

ResumePoint
resumePoint string

Der Fortsetzungspunkt aus dem vorherigen Suchvorgang. Festlegen von NULL für den ersten Suchvorgang

Einfügen von Zeilen in eine Benutzertabelle

Importieren von Tabellenzeilen in eine Benutzertabelle

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

UserTable
UserTable True string

Name der Benutzertabelle

Werte
Values True string

Liste der einzufügenden Zeilen- und Spaltenwerte (z. B.: [John; Hirschkuh; New York],[Peter; Musterung; Bern])

DeleteAllValues
DeleteAllValues boolean

Definiert, ob alle Werte in UserTable gelöscht werden sollen (Standard = false)

FirstRowContainsColumnHeaders
FirstRowContainsColumnHeaders boolean

Definiert, ob die erste Zeile des Werteparameters Spaltenüberschriften enthält (Standard = false)

Gibt zurück

Name Pfad Typ Beschreibung
Benutzertabelle
userTable string

Name der Benutzertabelle

Eingefügte Zeilen
insertedRows integer

Anzahl eingefügter Zeilen

Erstellen einer Benutzertabelle

Erstellen einer Benutzertabelle

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

UserTable
UserTable True string

Name der Benutzertabelle (z.B.: Adresse)

ColumnHeaders
ColumnHeaders True string

Eine Liste der Spaltenüberschriften (z. B.: Vorname,Nachname,Ort)

Gibt zurück

Name Pfad Typ Beschreibung
Benutzertabelle
userTable string

Name der Benutzertabelle

Erstellen von Prozessen

Erstellen von Prozessen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

ProcessProperties
ProcessProperties string

Aktualisierungsformat der Prozesseigenschaften: Vorname=Peter|Nachname=Muller|InvoiceNo=4711; 4712; 4713

CustomProperties
CustomProperties string

Benutzerdefinierte Eigenschaften. Format: [<PropertyName>|<PropertyValue>|PropertyType] (z. B. [Lieferant|Muster|Zeichenfolge][Rechnungsdatum|2021-01-29T13:05:45 |Datum][InvoiceNo|4711|Zahl])

DocumentIds
DocumentIds string

Liste aller anzufügenden Dokument-IDs

ProcessTemplateName
ProcessTemplateName True string

Name der Prozessvorlage

Fälligkeitsdatum
DueDate string

Fälligkeitsdatum für den Prozess. Datumsformat: yyyy-MM-ddTHH:mm:ss. Standard = aktuelles Datum

Priority
Priority string

Priorität des Prozesses (z. B. Niedrig, Normal, Hoch). Default = Normal

Kommentar
Comment string

Prozesskommentar

Kultur
Culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...). Default = de

Gibt zurück

Name Pfad Typ Beschreibung
accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

CheckOutState
checkOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
checkOutUserId string

ID des Benutzers, für den der Prozess ausgecheckt ist

comments
comments array of object

comments

Datum
comments.date string

Datum des Kommentars

Id
comments.id string

ID des Kommentars

Text
comments.text string

Benutzerdefinierter Kommentar

UserId
comments.userId string

Benutzer-ID

CompletedDate
completedDate string

Abschlussdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

completedTasks
completedTasks array of string

completedTasks

CreatedDate
createdDate string

Erstellungsdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

Maßnahme
currentTask.action string

Aktionstext für den Benutzer. Dem Endbenutzer angezeigt

assignedUserIds
currentTask.assignedUserIds array of string

assignedUserIds

comments
currentTask.comments array of string

comments

CompletedDate
currentTask.completedDate string

Abschlussdatum für den aktuellen Vorgang. Datumsformat: jjjj-MM-ddTHH:mm:ss

completedUserIds
currentTask.completedUserIds array of string

completedUserIds

CreatedDate
currentTask.createdDate string

Erstellungsdatum für den aktuellen Vorgang. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
currentTask.creatorId string

Benutzer-ID des Erstellers für aktuelle Aufgabe

Description
currentTask.description string

Beschreibung des aktuellen Vorgangs

Fälligkeitsdatum
currentTask.dueDate string

Fälligkeitsdatum des aktuellen Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

intendedUserIds
currentTask.intendedUserIds array of string

intendedUserIds

ReminderDate
currentTask.reminderDate string

Datum für Erinnerung an den aktuellen Vorgang. Datumsformat: jjjj-MM-ddTHH:mm:ss

RequiresAllRecipients
currentTask.requiresAllRecipients boolean

Definiert, ob alle Empfänger diese Aufgabe schließen müssen.

ShowCloseTaskDialog
currentTask.showCloseTaskDialog boolean

Dialogfeld "Aufgabe schließen" am Aufgabenende anzeigen

StatusEnum
currentTask.statusEnum string

Aktuelle Aufgabe status (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
currentTask.taskTemplateId string

Vorlagen-ID der aktuellen Aufgabe

customProperties
customProperties array of object

customProperties

CustomPropertyTypeEnum
customProperties.customPropertyTypeEnum string

Enumerationswert des benutzerdefinierten Eigenschaftstyps (Zeichenfolge, Datum, Zahl)

Name
customProperties.name string

Name der benutzerdefinierten Eigenschaft

Wert
customProperties.value string

Wert der benutzerdefinierten Eigenschaft

documentIds
documentIds array of string

documentIds

Fälligkeitsdatum
dueDate string

Fälligkeitsdatum für den Prozess. Datumsformat: jjjj-MM-ddTHH:mm:ss

FolderElementId
folderElementId string

ID des Dokuments als Ordnerelement

HasLinks
hasLinks boolean

ID des Dokuments als Ordnerelement

Id
id string

Prozess-ID

values
name.values array of object

values

Kultur
name.values.culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...)

Text
name.values.text string

Der Text für diese Sprache

PriorityEnum
priorityEnum string

Priorität des Prozesses (Hoch, Normal, Niedrig). Default = Normal

PluginStream
pluginStream string
ProcessTemplateId
processTemplateId string

Prozessvorlagen-ID

Eigenschaften
properties array of object

Eigenschaften

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

Kultur
properties.globalValues.values.culture string

Kultur

Text
properties.globalValues.values.text string

Text

Eigenschaftsname
properties.propertyName string

Name der Prozesseigenschaft

PropertyTypeId
properties.propertyTypeId string

ID der Prozesseigenschaft

values
properties.values array of string

values

ProtectionDomainId
protectionDomainId string

Schutzdomänen-ID des Prozesses

StatusEnum
statusEnum string

Status des Prozesses (Open, InProcess, Complete, PreparedToComplete, Error)

Logoff

Logoff

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Gibt zurück

Name Pfad Typ Beschreibung
LogoffResult
LogoffResult string

Ergebnis der Abmeldung

Logon

Logon

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

Benutzername
Username True string

Benutzername für die Anmeldung

Kennwort
Password True string

Kennwort

Mandantenname
Tenantname string

Mandantenname für die Anmeldung bei

Gibt zurück

Name Pfad Typ Beschreibung
ConnectionId
connectionId string

Enthält die Verbindungs-ID, wenn sie erfolgreich angemeldet wurde.

ConnectionTimeoutSeconds
connectionTimeoutSeconds integer

Timeout für die Verbindung

IsApplicationLicence
isApplicationLicence string

Ist Anwendungslizenztyp

IsConcurrentLicence
isConcurrentLicence string

Ist gleichzeitiger Lizenztyp

IsNamedLicence
isNamedLicence string

Benannter Lizenztyp

IsVerificationCodeNeeded
isVerificationCodeNeeded string

Ist Überprüfungscode erforderlich

PossibleTwoWayAuthenticationType
possibleTwoWayAuthenticationType string

Möglicher Zwei-Wege-Authentifizierungstyp (None, Mail, SMS)

TwoWayAuthenticationTargetMail
twoWayAuthenticationTargetMail string

Die maskierte E-Mail-Adresse, an die zweiWayAuthentication E-Mails an

Löschen von Benutzertabellenzeilen

Löschen von Benutzertabellenzeilen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

UserTable
UserTable True string

Name der Benutzertabelle

WhereClause
WhereClause string

Eine Liste der SQL-Klauselelemente. Format: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (z. B.: [Vorname|Gleich|Jon|UND],[Nachname|Gleich|Doe|OR])

Gibt zurück

Name Pfad Typ Beschreibung
userTableDeleteRecordsResult
userTableDeleteRecordsResult integer

userTableDeleteRecordsResult

PDF-Dokumente zusammenführen

Zusammenführen von zwei oder mehr PDF-Dokumenten in einem Dokument

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

DokumentID
DocumentId True string

ID des ersten PDF-Dokuments, eine neue Version wird mit neuen zusammengeführten Inhalten erstellt.

DocumentIdToAppend
DocumentIdToAppend True string

Dokument-IDs, die an das erste Semikolon angefügt (zusammengeführt) werden, d. h. '77b3c69d-7a9a-4083-9d75-83a5e6f3deca; 82514f19-057c-484f-8ee2-c21df811a928'

ForceUndoCheckout
ForceUndoCheckout boolean

Rückgängigmachen eines Auscheckens im ersten PDF-Dokument nach Bedarf. Default = false

Gibt zurück

Name Pfad Typ Beschreibung
name
name string

Dokumentname

id
id string

Dokument-ID

versionId
versionId string

Dokumentversions-ID

currentVersionId
currentVersionId string

Aktuelle Versions-ID des Dokuments

protectionDomainId
protectionDomainId string

Dokumentschutz-Domänen-ID

infoStoreId
infoStoreId string

InfoStore-ID

checkOutStateEnum
checkOutStateEnum string

Status-Enumeration auschecken

checkOutUserId
checkOutUserId string

Benutzer-ID auschecken

Eigenschaften
properties array of object

Eigenschaften

propertyTypeId
properties.propertyTypeId string

PropertyType-ID

values
properties.values array of string

PropertyType-Werte

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

Kultur
properties.globalValues.values.culture string

Globale Wertekultur

Text
properties.globalValues.values.text string

Text für globale Werte

propertyTypeName
properties.propertyTypeName string

PropertyType-Name

Eigenschaftsname
properties.propertyName string

Eigenschaftsname

importTemplateId
importTemplateId string

Vorlagen-ID importieren

Blogs
blogs array of object

Bloggen

Erstellungsdatum
blogs.createdDate string

Erstellungsdatum des Blogs

creatorId
blogs.creatorId string

Blog creator Id

Text
blogs.text string

Blogtext

id
blogs.id string

Blog-ID

accessRightsEnumList
accessRightsEnumList array of string

Liste der Zugriffsberechtigungen

Erinnerungen
reminders array of

Erinnerungen

pageCount
pageCount integer

Seitenanzahl

mainFileLength
mainFileLength integer

Hauptdateilänge

Abonnements
abonnements array of

Abonnements

textAnnotations
annotationManager.textAnnotations array of

Textanmerkungen

rectangleAnnotations
annotationManager.rectangleAnnotations array of

Rechteckanmerkungen

postItAnnotations
annotationManager.postItAnnotations array of

PostIt-Anmerkungen

stampAnnotations
annotationManager.stampAnnotations array of

Stempelanmerkungen

documentData
documentData array of object

Dokumentdaten

id
documentData.id string

Dokumentdaten-ID

name
documentData.name string

Dokumentdatenname

Wiedergaben
documentData.renditions array of object

Wiedergaben

id
documentData.renditions.id string

Darstellungs-ID

size
documentData.renditions.size string

Formatvariantengröße

files
documentData.renditions.files array of object

Formatvariantendateien

blobStoreId
documentData.renditions.files.blobStoreId string

Id des Blobspeichers der Formatvariante

blobPath (englisch)
documentData.renditions.files.blobPath string

Blobpfad der Formatvariante

pageCount
documentData.renditions.pageCount string

Seitenanzahl der Formatvariante

Erweiterung
documentData.renditions.extension string

Darstellungserweiterung

hashValue
documentData.renditions.hashValue array of integer

Hashwert der Formatvariante

contentProtections
documentData.renditions.contentProtections array of

Schutz von Inhaltsdarstellungen

signingProfileId
signingProfileId string

Signaturprofil-ID

lifeCycleId
lifeCycleManager.lifeCycleId string

Lebenszyklus-ID

lifeCycleStateId
lifeCycleManager.lifeCycleStateId string

Lebenszyklusstatus-ID

lifeCycleStartDate
lifeCycleManager.lifeCycleStartDate string

Startdatum des Lebenszyklus

lifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

Enddatum des Lebenszyklus

nextLifeCycleStates
lifeCycleManager.nextLifeCycleStates array of

Nächste Lebenszykluszustände

checkOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

Auschecken der Lebenszyklusstatus-ID

nextAutomaticLifeCycleStateId
lifeCycleManager.nextAutomaticLifeCycleStateId string

Nächste id des automatischen Lebenszyklusstatus

lifeCycleProtections
lifeCycleManager.lifeCycleProtections array of object

Lebenszyklusschutz

id
lifeCycleManager.lifeCycleProtections.id string

Lebenszyklusschutz-ID

protectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

Lebenszyklusschutz dauer Ticks

protectCheckOut
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

Lebenszyklusschutz auschecken

protectContentChange
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

Änderung des Lebenszyklusschutzinhalts

protectPropertyChange
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

Lebenszyklusschutzeigenschaftenänderung

protectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

Änderung der Lebenszyklusschutzanmerkung

protectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

Lebenszyklusschutzschutz-Domänenänderung

protectDelete
lifeCycleManager.lifeCycleProtections.protectDelete boolean

Lebenszyklusschutz löschen

deleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

Lebenszyklusschutzlöschung nach Ablauf

hasOverlay
hasOverlay boolean

Hat Überlagerung

sessionCount
sessionCount integer

Sitzungsanzahl

hasSignature
hasSignature boolean

Hat Signatur

hasBlog
hasBlog boolean

Hat Blog

hasAnnotation
hasAnnotation boolean

Hat Anmerkung

hasTempAccess
hasTempAccess boolean

Hat temporären Zugriff

hasReminders
hasReminders boolean

Enthält Erinnerungen

hasLinks
hasLinks boolean

Enthält Links

hasAbonnement
hasAbonnement boolean

Hat Abonnement

Prozess abrufen

Prozess abrufen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
connectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Prozess-ID
processId True string

ID des Prozesses (Guid)

Gibt zurück

Name Pfad Typ Beschreibung
AccessRightsEnumList
GetProcessResult.AccessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
GetProcessResult.CheckOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
GetProcessResult.CheckOutUserId string

ID des Benutzers, für den der Prozess ausgecheckt ist

Kommentare
GetProcessResult.Comments array of object

Kommentare

Datum
GetProcessResult.Comments.Date string

Datum des Kommentars

Id
GetProcessResult.Comments.Id string

ID des Kommentars

Text
GetProcessResult.Comments.Text string

Benutzerdefinierter Kommentar

UserId
GetProcessResult.Comments.UserId string

ID des Benutzers, der den Kommentar festgelegt hat

CompletedDate
GetProcessResult.CompletedDate string

Abschlussdatum des Prozesses. Datumsformat: jjjj-MM-ddTHH:mm:ss

CompletedTasks
GetProcessResult.CompletedTasks array of object

CompletedTasks

Maßnahme
GetProcessResult.CompletedTasks.Action string

Aktionstext für den Benutzer. Dem Endbenutzer angezeigt

AssignedUserIds
GetProcessResult.CompletedTasks.AssignedUserIds array of

assignedUserIds

Kommentare
GetProcessResult.CompletedTasks.Comments array of object

Kommentare

Datum
GetProcessResult.CompletedTasks.Comments.Date string

Datum des Kommentars

Id
GetProcessResult.CompletedTasks.Comments.Id string

ID des Kommentars

Text
GetProcessResult.CompletedTasks.Comments.Text string

Benutzerdefinierter Kommentar

UserId
GetProcessResult.CompletedTasks.Comments.UserId string

ID des Benutzers, der den Kommentar festgelegt hat

CompletedDate
GetProcessResult.CompletedTasks.CompletedDate string

Abschlussdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CompletedUserIds
GetProcessResult.CompletedTasks.CompletedUserIds array of string

completedUserIds

CreatedDate
GetProcessResult.CompletedTasks.CreatedDate string

Erstellungsdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
GetProcessResult.CompletedTasks.CreatorId string

Benutzer-ID des Erstellers

Description
GetProcessResult.CompletedTasks.Description string

Aufgabenbeschreibung

Fälligkeitsdatum
GetProcessResult.CompletedTasks.DueDate string

Fälligkeitsdatum des Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

IntendedUserIds
GetProcessResult.CompletedTasks.IntendedUserIds array of

intendedUserIds

ReminderDate
GetProcessResult.CompletedTasks.ReminderDate string

Datum für Erinnerung. Datumsformat: jjjj-MM-ddTHH:mm:ss

RequiresAllRecipients
GetProcessResult.CompletedTasks.RequiresAllRecipients boolean

Definiert, ob alle Empfänger diese Aufgabe schließen müssen.

ShowCloseTaskDialog
GetProcessResult.CompletedTasks.ShowCloseTaskDialog boolean

Dialogfeld "Aufgabe schließen" am Aufgabenende anzeigen

Der Status
GetProcessResult.CompletedTasks.StatusEnum string

Vorgangsstatus (Öffnen, InProcess, Abgeschlossen, PreparedToComplete, Fehler)

TaskTemplateId
GetProcessResult.CompletedTasks.TaskTemplateId string

Aufgabenvorlagen-ID

CreatedDate
GetProcessResult.CreatedDate string

Erstellungsdatum des Prozesses. Datumsformat: jjjj-MM-ddTHH:mm:ss

Maßnahme
GetProcessResult.CurrentTask.Action string

Aktionstext für den Benutzer. Dem Endbenutzer angezeigt

AssignedUserIds
GetProcessResult.CurrentTask.AssignedUserIds array of string

AssignedUserIds

Kommentare
GetProcessResult.CurrentTask.Comments array of string

Kommentare

CompletedDate
GetProcessResult.CurrentTask.CompletedDate string

Abschlussdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CompletedUserIds
GetProcessResult.CurrentTask.CompletedUserIds array of string

CompletedUserIds

CreatedDate
GetProcessResult.CurrentTask.CreatedDate string

Erstellungsdatum. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
GetProcessResult.CurrentTask.CreatorId string

Benutzer-ID des Erstellers

Description
GetProcessResult.CurrentTask.Description string

Aufgabenbeschreibung

Fälligkeitsdatum
GetProcessResult.CurrentTask.DueDate string

Fälligkeitsdatum des Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

Id
GetProcessResult.CurrentTask.Id string

ID des Vorgangs

IntendedUserIds
GetProcessResult.CurrentTask.IntendedUserIds array of string

IntendedUserIds

ReminderDate
GetProcessResult.CurrentTask.ReminderDate string

Datum für Erinnerung. Datumsformat: jjjj-MM-ddTHH:mm:ss

RequiresAllRecipients
GetProcessResult.CurrentTask.RequiresAllRecipients boolean

Definiert, ob alle Empfänger diese Aufgabe schließen müssen.

ShowCloseTaskDialog
GetProcessResult.CurrentTask.ShowCloseTaskDialog boolean

Dialogfeld "Aufgabe schließen" am Aufgabenende anzeigen

StatusEnum
GetProcessResult.CurrentTask.StatusEnum string

Vorgangsstatus (Öffnen, InProcess, Abgeschlossen, PreparedToComplete, Fehler)

TaskTemplateId
GetProcessResult.CurrentTask.TaskTemplateId string

Aufgabenvorlagen-ID

CustomProperties
GetProcessResult.CustomProperties array of object

CustomProperties

CustomPropertyTypeEnum
GetProcessResult.CustomProperties.CustomPropertyTypeEnum string

Liste des benutzerdefinierten Eigenschaftendatentyps (Zeichenfolge, Datum, Zahl)

Name
GetProcessResult.CustomProperties.Name string

Name des benutzerdefinierten Eigenschaftentyps

Wert
GetProcessResult.CustomProperties.Value string

Wert des benutzerdefinierten Eigenschaftentyps

DocumentIds
GetProcessResult.DocumentIds array of string

DocumentIds

Fälligkeitsdatum
GetProcessResult.DueDate string

Fälligkeitsdatum für den Prozess. Datumsformat: jjjj-MM-ddTHH:mm:ss

Id
GetProcessResult.Id string

ID des Prozesses

Werte
GetProcessResult.Name.Values array of object

Werte

Kultur
GetProcessResult.Name.Values.Culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...)

Text
GetProcessResult.Name.Values.Text string

Text

PluginStream
GetProcessResult.PluginStream array of

PluginStream

PriorityEnum
GetProcessResult.PriorityEnum string

Priorität des Prozesses (Hoch, Normal, Niedrig)

ProcessTemplateId
GetProcessResult.ProcessTemplateId string

Prozessvorlagen-ID

Eigenschaften
GetProcessResult.Properties array of object

Eigenschaften

GlobalValues
GetProcessResult.Properties.GlobalValues array of object

GlobalValues

Werte
GetProcessResult.Properties.GlobalValues.Values array of object

Werte

Kultur
GetProcessResult.Properties.GlobalValues.Values.Culture string

Kultur

Text
GetProcessResult.Properties.GlobalValues.Values.Text string

Text

PropertyTypeId
GetProcessResult.Properties.PropertyTypeId string

Eigenschaftstyp-ID

Werte
GetProcessResult.Properties.Values array of string

Werte

ProtectionDomainId
GetProcessResult.ProtectionDomainId string

Schutzdomänen-ID des Prozesses

SessionCount
GetProcessResult.SessionCount integer

Sitzungsanzahl

StatusEnum
GetProcessResult.StatusEnum string

Status des Prozesses (Open, InProcess, Complete, PreparedToComplete, Error)

Prozesssuche

Prozesssuche

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Conditions
Conditions string

Suchbedingungsformat: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". z.B.: [Zuletzt einchecken|Weniger|2021-12-31|Und],[Vorname|Gleich|Peter|Und],[Datum|Zwischen|2021-12-31; 2022-12-31|Und]

ResultProperties
ResultProperties string

Ergebniseigenschaftenliste, kommagetrennt. Kann eigenschaftsname oder ID sein, z. B. "Name,Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a"

MaxSerchResults
MaxSerchResults string

Maximale Anzahl von Dokumentsuchergebnissen. Standard = 100

Kultur
Culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...). Default = de

Gibt zurück

Name Pfad Typ Beschreibung
processes
processes array of object

Ergebnis der Prozesssuche

values
processes.name.values array of object

Immobilienwerte

Kultur
processes.name.values.culture string

Eigenschaftskultur

Text
processes.name.values.text string

Eigenschaftstext

id
processes.id string

Prozess-ID

folderElementId
processes.folderElementId string

Folder-Element-ID

checkOutStateEnum
processes.checkOutStateEnum string

Status-Enumeration auschecken

Eigenschaften
processes.properties array of object

Eigenschaften

propertyTypeId
processes.properties.propertyTypeId string

PropertyType-ID

values
processes.properties.values array of string

Immobilienwerte

globalValues
processes.properties.globalValues array of object

Globale Werte

values
processes.properties.globalValues.values array of object

values

Kultur
processes.properties.globalValues.values.culture string

Globale Wertkultur

Text
processes.properties.globalValues.values.text string

Globaler Werttext

propertyTypeName
processes.properties.propertyTypeName string

PropertyType-Name

Eigenschaftsname
processes.properties.propertyName string

Eigenschaftsname

priorityEnum
processes.priorityEnum string

Prioritätsenumerung

statusEnum
processes.statusEnum string

Status-Enumeration

fälliges Datum
processes.dueDate string

Fälligkeitsdatum

hasLinks
processes.hasLinks boolean

Enthält Links

accessRightsEnumList
processes.accessRightsEnumList array of string

Liste der Zugriffsberechtigungen

hasMehr
hasMore boolean

Hat mehr

resumePoint
resumePoint string

Fortsetzungspunkt

Schließen eines geöffneten Prozesses

Schließen eines geöffneten Prozesses

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
connectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Prozess-ID
processId True string

ID des Prozesses (Guid)

Kommentar
comment string

Hinzuzufügenden Kommentar

Gibt zurück

Name Pfad Typ Beschreibung
AccessRightsEnumList
CloseProcessResult.AccessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
CloseProcessResult.CheckOutStateEnum string

Auschecken des Dokuments (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
CloseProcessResult.CheckOutUserId string

ID des Benutzers, für den der Prozess ausgecheckt ist

Kommentare
CloseProcessResult.Comments array of object

Kommentare

Datum
CloseProcessResult.Comments.Date string

Datum des Kommentars

Id
CloseProcessResult.Comments.Id string

ID des Kommentars

Text
CloseProcessResult.Comments.Text string

Benutzerdefinierter Kommentar

UserId
CloseProcessResult.Comments.UserId string

Benutzer-ID

CompletedDate
CloseProcessResult.CompletedDate string

Abschlussdatum des Prozesses. Datumsformat: jjjj-MM-ddTHH:mm:ss

CompletedTasks
CloseProcessResult.CompletedTasks array of object

CompletedTasks

Maßnahme
CloseProcessResult.CompletedTasks.Action string

Aktionstext für den Benutzer

AssignedUserIds
CloseProcessResult.CompletedTasks.AssignedUserIds array of

AssignedUserIds

Kommentare
CloseProcessResult.CompletedTasks.Comments array of object

Kommentare

Datum
CloseProcessResult.CompletedTasks.Comments.Date string

Datum des Kommentars

Id
CloseProcessResult.CompletedTasks.Comments.Id string

ID des Kommentars

Text
CloseProcessResult.CompletedTasks.Comments.Text string

Benutzerdefinierter Kommentar

UserId
CloseProcessResult.CompletedTasks.Comments.UserId string

ID des Benutzers, der den Kommentar festgelegt hat

CompletedDate
CloseProcessResult.CompletedTasks.CompletedDate string

Abschlussdatum des abgeschlossenen Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

CompletedUserIds
CloseProcessResult.CompletedTasks.CompletedUserIds array of string

CompletedUserIds

CreatedDate
CloseProcessResult.CompletedTasks.CreatedDate string

Erstellungsdatum der abgeschlossenen Aufgabe. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
CloseProcessResult.CompletedTasks.CreatorId string

Benutzer-ID des Erstellers der abgeschlossenen Aufgabe

Description
CloseProcessResult.CompletedTasks.Description string

Aufgabenbeschreibung des abgeschlossenen Vorgangs

Fälligkeitsdatum
CloseProcessResult.CompletedTasks.DueDate string

Fälligkeitsdatum des Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

Id
CloseProcessResult.CompletedTasks.Id string

ID des Vorgangs

IntendedUserIds
CloseProcessResult.CompletedTasks.IntendedUserIds array of

IntendedUserIds

ReminderDate
CloseProcessResult.CompletedTasks.ReminderDate string

Datum für die Erinnerung an den abgeschlossenen Vorgang. Datumsformat: jjjj-MM-ddTHH:mm:ss

RequiresAllRecipients
CloseProcessResult.CompletedTasks.RequiresAllRecipients boolean

Definiert, ob alle Empfänger diese Aufgabe schließen müssen.

ShowCloseTaskDialog
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog boolean

Dialogfeld "Aufgabe schließen" am Aufgabenende anzeigen

StatusEnum
CloseProcessResult.CompletedTasks.StatusEnum string

Vorgangsstatus (Öffnen, InProcess, Abgeschlossen, PreparedToComplete, Fehler)

TaskTemplateId
CloseProcessResult.CompletedTasks.TaskTemplateId string

Aufgabenvorlagen-ID

CreatedDate
CloseProcessResult.CreatedDate string

Erstellungsdatum des Prozessdatumsformats: jjjj-MM-ddTHH:mm:ss

Maßnahme
CloseProcessResult.CurrentTask.Action string

Aktionstext für den Benutzer

AssignedUserIds
CloseProcessResult.CurrentTask.AssignedUserIds array of string

AssignedUserIds

Kommentare
CloseProcessResult.CurrentTask.Comments array of object

Kommentare

Datum
CloseProcessResult.CurrentTask.Comments.Date string

Datum des Kommentars

Id
CloseProcessResult.CurrentTask.Comments.Id string

ID des Kommentars

Text
CloseProcessResult.CurrentTask.Comments.Text string

Benutzerdefinierter Kommentar

UserId
CloseProcessResult.CurrentTask.Comments.UserId string

ID des Benutzers, der den Kommentar festgelegt hat

CompletedDate
CloseProcessResult.CurrentTask.CompletedDate string

Abschlussdatum des aktuellen Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

CompletedUserIds
CloseProcessResult.CurrentTask.CompletedUserIds array of string

CompletedUserIds

CreatedDate
CloseProcessResult.CurrentTask.CreatedDate string

Erstellungsdatum des aktuellen Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

CreatorId
CloseProcessResult.CurrentTask.CreatorId string

Benutzer-ID des Erstellers der aktuellen Aufgabe

Description
CloseProcessResult.CurrentTask.Description string

Vorgangsbeschreibung des aktuellen Vorgangs

Fälligkeitsdatum
CloseProcessResult.CurrentTask.DueDate string

Fälligkeitsdatum des aktuellen Vorgangs. Datumsformat: jjjj-MM-ddTHH:mm:ss

Id
CloseProcessResult.CurrentTask.Id string

ID des aktuellen Vorgangs

IntendedUserIds
CloseProcessResult.CurrentTask.IntendedUserIds array of string

IntendedUserIds

ReminderDate
CloseProcessResult.CurrentTask.ReminderDate string

Datum für Erinnerung an den aktuellen Vorgang. Datumsformat: jjjj-MM-ddTHH:mm:ss

RequiresAllRecipients
CloseProcessResult.CurrentTask.RequiresAllRecipients boolean

Definiert, ob alle Empfänger die aktuelle Aufgabe schließen müssen.

ShowCloseTaskDialog
CloseProcessResult.CurrentTask.ShowCloseTaskDialog boolean

Dialogfeld "Vorgang schließen" bei der aktuellen Aufgabe anzeigen

StatusEnum
CloseProcessResult.CurrentTask.StatusEnum string

Status des aktuellen Vorgangs (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
CloseProcessResult.CurrentTask.TaskTemplateId string

Vorgangsvorlagen-ID des aktuellen Vorgangs

CustomProperties
CloseProcessResult.CustomProperties array of object

CustomProperties

CustomPropertyTypeEnum
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum string

Benutzerdefinierter Enumerationswert der benutzerdefinierten Eigenschaft (String, Date, Number)

Name
CloseProcessResult.CustomProperties.Name string

Name der benutzerdefinierten Eigenschaft

Wert
CloseProcessResult.CustomProperties.Value string

Wert der benutzerdefinierten Eigenschaft

DocumentIds
CloseProcessResult.DocumentIds array of string

DocumentIds

Fälligkeitsdatum
CloseProcessResult.DueDate string

Fälligkeitsdatum für den Prozess. Datumsformat: jjjj-MM-ddTHH:mm:ss

Id
CloseProcessResult.Id string

ID des Prozesses

Werte
CloseProcessResult.Name.Values array of object

Werte

Kultur
CloseProcessResult.Name.Values.Culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...)

Text
CloseProcessResult.Name.Values.Text string

Name des Prozesses

PluginStream
CloseProcessResult.PluginStream array of

PluginStream

PriorityEnum
CloseProcessResult.PriorityEnum string

Priorität des Prozesses (Hoch, Normal, Niedrig)

ProcessTemplateId
CloseProcessResult.ProcessTemplateId string

Prozessvorlagen-ID

Eigenschaften
CloseProcessResult.Properties array of object

Eigenschaften

GlobalValues
CloseProcessResult.Properties.GlobalValues array of object

GlobalValues

Werte
CloseProcessResult.Properties.GlobalValues.Values array of object

Werte

Kultur
CloseProcessResult.Properties.GlobalValues.Values.Culture string

Kultur

Text
CloseProcessResult.Properties.GlobalValues.Values.Text string

Text

PropertyTypeId
CloseProcessResult.Properties.PropertyTypeId string

Typ-ID des Indexfelds

Werte
CloseProcessResult.Properties.Values array of string

Werte

ProtectionDomainId
CloseProcessResult.ProtectionDomainId string

Schutzdomänen-ID des Prozesses

SessionCount
CloseProcessResult.SessionCount integer

Sitzungsanzahl

StatusEnum
CloseProcessResult.StatusEnum string

Status des Prozesses (Open, InProcess, Complete, PreparedToComplete, Error)

Updateprozess (V2)

Updateprozess (V2)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Prozess-ID
ProcessId True string

ID des Prozesses (Guid)

ProcessProperties
ProcessProperties string

Aktualisierungsformat der Prozesseigenschaften: Vorname=Peter|Nachname=Muller|InvoiceNo=4711; 4712; 4713

RemoveProcessProperties
RemoveProcessProperties string

Liste der durch Semikolons getrennten Eigenschaftsnamen oder IDs, die aus dem Prozess entfernt werden sollen, z. B. "FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680ddd; Abteilungen"

CustomProperties
CustomProperties string

Benutzerdefinierte Eigenschaften. Format: [<PropertyName>|<PropertyValue>|PropertyType] (z. B. [Lieferant|Muster|Zeichenfolge][Rechnungsdatum|2021-01-29T13:05:45 |Datum][InvoiceNo|4711|Zahl])

Kommentar
Comment string

Hinzufügen eines Prozesskommentartexts

AssignUserLoginNames
AssignUserLoginNames string

Die zugewiesenen Benutzernamen, getrennt durch Semikolon, z. B. "user1"; user2

AddDocumentIds
AddDocumentIds string

Durch Semikolons getrennte Liste der Dokument-IDs, die dem Prozess hinzugefügt werden sollen, z. B. "1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16'

RemoveDocumentIds
RemoveDocumentIds string

Durch Semikolons getrennte Liste der Dokument-IDs, die aus dem Prozess entfernt werden sollen, z. B. "1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16'

Fälligkeitsdatum
DueDate string

Fälligkeitsdatum für den Prozess. Datumsformat: yyyy-MM-ddTHH:mm:ss. Standard = aktuelles Datum

Priority
Priority string

Priorität des Prozesses (z. B. Niedrig, Normal, Hoch). Default = Normal

Kultur
Culture string

Die Kultur, in der der Text gegeben wird (de, en, fr, ...). Default = de

ForceUndoCheckout
ForceUndoCheckout boolean

Erzwingen des Prozessrückcheckvorgangs bei Bedarf

Schutzdomäne
ProtectionDomain string

Schutzdomänen-ID oder -Name

Gibt zurück

Name Pfad Typ Beschreibung
values
name.values array of object

Immobilienwerte

Kultur
name.values.culture string

Eigenschaftskultur

Text
name.values.text string

Eigenschaftstext

values
description.values array of object

values

Kultur
description.values.culture string

Eigenschaftskultur

Text
description.values.text string

Eigenschaftstext

id
id string

Prozess-ID

protectionDomainId
protectionDomainId string

Prozessschutz-Domänen-ID

processTemplateId
processTemplateId string

Prozessvorlagen-ID

Eigenschaften
properties array of object

Eigenschaften

propertyTypeId
properties.propertyTypeId string

PropertyType-ID

values
properties.values array of string

Immobilienwerte

globalValues
properties.globalValues array of object

Globale Werte

values
properties.globalValues.values array of object

values

Kultur
properties.globalValues.values.culture string

Globale Wertkultur

Text
properties.globalValues.values.text string

Globaler Werttext

propertyTypeName
properties.propertyTypeName string

PropertyType-Name

Eigenschaftsname
properties.propertyName string

Eigenschaftsname

priorityEnum
priorityEnum string

Enumeration der Prozesspriorität

pluginStream
pluginStream string

Prozess-Plug-In-Stream

fälliges Datum
dueDate string

Fälligkeitsdatum des Prozesses

Erstellungsdatum
createdDate string

Erstellungsdatum des Prozesses

completedDate
completedDate string

Abschlussdatum des Prozesses

comments
comments array of object

Kommentare

id
comments.id string

Prozesskommentar-ID

date
comments.date string

Prozesskommentardatum

userId
comments.userId string

Prozesskommentar-Benutzer-ID

Text
comments.text string

Verarbeiten von Kommentartext

accessRightsEnumList
accessRightsEnumList array of string

Liste der Zugriffsberechtigungen

statusEnum
statusEnum string

Status-Enumeration

customProperties
customProperties array of object

Benutzerdefinierte Eigenschaften

name
customProperties.name string

Name der benutzerdefinierten Eigenschaft

value
customProperties.value string

Benutzerdefinierter Eigenschaftswert

customPropertyTypeEnum
customProperties.customPropertyTypeEnum string

Enumeration des benutzerdefinierten Eigenschaftentyps

id
currentTask.id string

Aktuelle Vorgangs-ID

Handlung
currentTask.action string

Aktuelle Vorgangsaktion

creatorId
currentTask.creatorId string

Aktuelle Ersteller-ID der Aufgabe

fälliges Datum
currentTask.dueDate string

Aktuelles Fälligkeitsdatum des Vorgangs

Erstellungsdatum
currentTask.createdDate string

Aktuelles Erstellungsdatum der Aufgabe

completedDate
currentTask.completedDate string

Aktuelles Abgeschlossenes Datum der Aufgabe

taskTemplateId
currentTask.taskTemplateId string

Id der aktuellen Vorgangsaufgabe

comments
currentTask.comments array of

Aktuelle Aufgabenkommentare

reminderDate
currentTask.reminderDate string

Aktuelles Vorgangserinnerungsdatum

statusEnum
currentTask.statusEnum string

Aktuelle Vorgangsstatus-Enumeration

Beschreibung
currentTask.description string

Aktuelle Vorgangsbeschreibung

requiresAllRecipients
currentTask.requiresAllRecipients boolean

Aktuelle Aufgabe erfordert alle Empfänger

assignedUserIds
currentTask.assignedUserIds array of string

Aktuelle zugewiesene Benutzer-IDs der Aufgabe

completedUserIds
currentTask.completedUserIds array of string

Aktuelle Aufgabe abgeschlossene Benutzer-IDs

showCloseTaskDialog
currentTask.showCloseTaskDialog boolean

Dialogfeld "Aktuelle Aufgabe schließen" anzeigen

intendedUserIds
currentTask.intendedUserIds array of

Aktuelle Aufgabe beabsichtigte Benutzer-IDs

values
currentTask.nameGlobal.values array of object

values

Kultur
currentTask.nameGlobal.values.culture string

Globale Namenskultur

Text
currentTask.nameGlobal.values.text string

Globaler Namenstext

values
currentTask.descriptionGlobal.values array of object

values

Kultur
currentTask.descriptionGlobal.values.culture string

Globale Beschreibungskultur

Text
currentTask.descriptionGlobal.values.text string

Globaler Beschreibungstext

assignedUserCCIds
currentTask.assignedUserCCIds array of

Zugewiesene Benutzer-Cc-IDs

Stellvertretende Vertretungen
currentTask.deputyRepresentations array of

Stellvertretende Vertretungen

taskActionEnum
currentTask.taskActionEnum string

Enumeration der Vorgangsaktion

completedTasks
completedTasks array of object

Abgeschlossene Aufgaben

id
completedTasks.id string

Abgeschlossene Vorgangs-ID

Handlung
completedTasks.action string

Abgeschlossene Aufgabenaktion

creatorId
completedTasks.creatorId string

Abgeschlossene Aufgabenersteller-ID

fälliges Datum
completedTasks.dueDate string

Fälligkeitsdatum der abgeschlossenen Aufgabe

Erstellungsdatum
completedTasks.createdDate string

Erstellungsdatum der abgeschlossenen Aufgabe

completedDate
completedTasks.completedDate string

Abgeschlossener Vorgang abgeschlossen am

taskTemplateId
completedTasks.taskTemplateId string

Id der Abgeschlossenen Aufgabenaufgabe

comments
completedTasks.comments array of

Abgeschlossene Aufgabenkommentare

reminderDate
completedTasks.reminderDate string

Erinnerungsdatum der abgeschlossenen Aufgabe

statusEnum
completedTasks.statusEnum string

Enumeration "Abgeschlossener Vorgangsstatus"

Beschreibung
completedTasks.description string

Beschreibung

requiresAllRecipients
completedTasks.requiresAllRecipients boolean

Abgeschlossene Aufgabe erfordert alle Empfänger

assignedUserIds
completedTasks.assignedUserIds array of string

Abgeschlossene Aufgabe zugewiesene Benutzer-IDs

completedUserIds
completedTasks.completedUserIds array of string

Abgeschlossene Aufgabe abgeschlossene Benutzer-IDs

showCloseTaskDialog
completedTasks.showCloseTaskDialog boolean

Abgeschlossene Aufgabe zeigt das Dialogfeld "Aufgabe schließen" an.

intendedUserIds
completedTasks.intendedUserIds array of

Abgeschlossene Aufgabe beabsichtigte Benutzer-IDs

values
completedTasks.nameGlobal.values array of object

values

Kultur
completedTasks.nameGlobal.values.culture string

Globale Namenskultur

Text
completedTasks.nameGlobal.values.text string

Globaler Namenstext

values
completedTasks.descriptionGlobal.values array of object

values

Kultur
completedTasks.descriptionGlobal.values.culture string

Globale Beschreibungskultur

Text
completedTasks.descriptionGlobal.values.text string

Globaler Beschreibungstext

assignedUserCCIds
completedTasks.assignedUserCCIds array of

Abgeschlossene Aufgabe zugewiesene Benutzer-Cc-IDs

Stellvertretende Vertretungen
completedTasks.deputyRepresentations array of

Abgeschlossene Aufgabenstellvertretungen

taskActionEnum
completedTasks.taskActionEnum string

Aufzählung abgeschlossener Aufgabenaufgaben

documentIds
documentIds array of string

Erledigte Aufgabendokument-IDs

checkOutStateEnum
checkOutStateEnum string

Abgeschlossene Aufgabe auschecken Status-Enumeration

checkOutUserId
checkOutUserId string

Abgeschlossene Aufgabe auschecken Benutzer-ID

sessionCount
sessionCount integer

Anzahl der abgeschlossenen Aufgabensitzungen

Updateprozess (veraltet) [VERALTET]

Updateprozess (veraltet)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ArchiveUrl
ArchiveUrl True string

URL der Archiv-API (z.B.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

Die Verbindungs-ID, um Ihre Verbindung zu identifizieren

Prozess-ID
ProcessId True string

ID des Prozesses (Guid)

AssignUserLoginNames
AssignUserLoginNames string

Weisen Sie der aktuellen Aufgabe Benutzernamen zu. (z.B.: peter.muster@kendox.com;megan.muster@kendox.com)

ProcessProperties
ProcessProperties string

Aktualisierungsformat der Prozesseigenschaften: Vorname=Peter|Nachname=Muller|InvoiceNo=4711; 4712; 4713

Benutzerdefinierte Eigenschaften
CustomProperties string

Benutzerdefinierte Eigenschaften. Format: [<PropertyName>|<PropertyValue>|PropertyType] (z. B. [Lieferant|Muster|Zeichenfolge][Rechnungsdatum|2021-01-29T13:05:45 |Datum][InvoiceNo|4711|Zahl])

Kommentar
Comment string

Kommentar

Kultur
Culture string

Die Kultur, in der die Eigenschaftsnamen angegeben werden (de, en, fr, ...). Default = de

Gibt zurück

Name Pfad Typ Beschreibung
values
name.values array of object

values

Kultur
name.values.culture string

Kultur

Text
name.values.text string

Text

values
description.values array of object

values

Kultur
description.values.culture string

Kultur

Text
description.values.text string

Text

id
id string

id

protectionDomainId
protectionDomainId string

protectionDomainId

processTemplateId
processTemplateId string

processTemplateId

Eigenschaften
properties array of object

Eigenschaften

propertyTypeId
properties.propertyTypeId string

propertyTypeId

values
properties.values array of string

values

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

Kultur
properties.globalValues.values.culture string

Kultur

Text
properties.globalValues.values.text string

Text

propertyTypeName
properties.propertyTypeName string

propertyTypeName

Eigenschaftsname
properties.propertyName string

Eigenschaftsname

priorityEnum
priorityEnum string

priorityEnum

pluginStream
pluginStream string

pluginStream

fälliges Datum
dueDate string

fälliges Datum

Erstellungsdatum
createdDate string

Erstellungsdatum

completedDate
completedDate string

completedDate

comments
comments array of object

comments

id
comments.id string

id

date
comments.date string

date

userId
comments.userId string

userId

Text
comments.text string

Text

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

statusEnum
statusEnum string

statusEnum

customProperties
customProperties array of object

customProperties

name
customProperties.name string

name

value
customProperties.value string

value

customPropertyTypeEnum
customProperties.customPropertyTypeEnum string

customPropertyTypeEnum

id
currentTask.id string

id

Handlung
currentTask.action string

Handlung

creatorId
currentTask.creatorId string

creatorId

fälliges Datum
currentTask.dueDate string

fälliges Datum

Erstellungsdatum
currentTask.createdDate string

Erstellungsdatum

completedDate
currentTask.completedDate string

completedDate

taskTemplateId
currentTask.taskTemplateId string

taskTemplateId

comments
currentTask.comments array of

comments

reminderDate
currentTask.reminderDate string

reminderDate

statusEnum
currentTask.statusEnum string

statusEnum

Beschreibung
currentTask.description string

Beschreibung

requiresAllRecipients
currentTask.requiresAllRecipients boolean

requiresAllRecipients

assignedUserIds
currentTask.assignedUserIds array of string

assignedUserIds

completedUserIds
currentTask.completedUserIds array of string

completedUserIds

showCloseTaskDialog
currentTask.showCloseTaskDialog boolean

showCloseTaskDialog

intendedUserIds
currentTask.intendedUserIds array of

intendedUserIds

values
currentTask.nameGlobal.values array of object

values

Kultur
currentTask.nameGlobal.values.culture string

Kultur

Text
currentTask.nameGlobal.values.text string

Text

values
currentTask.descriptionGlobal.values array of object

values

Kultur
currentTask.descriptionGlobal.values.culture string

Kultur

Text
currentTask.descriptionGlobal.values.text string

Text

assignedUserCCIds
currentTask.assignedUserCCIds array of

assignedUserCCIds

Stellvertretende Vertretungen
currentTask.deputyRepresentations array of

Stellvertretende Vertretungen

taskActionEnum
currentTask.taskActionEnum string

taskActionEnum

completedTasks
completedTasks array of object

completedTasks

id
completedTasks.id string

id

Handlung
completedTasks.action string

Handlung

creatorId
completedTasks.creatorId string

creatorId

fälliges Datum
completedTasks.dueDate string

fälliges Datum

Erstellungsdatum
completedTasks.createdDate string

Erstellungsdatum

completedDate
completedTasks.completedDate string

completedDate

taskTemplateId
completedTasks.taskTemplateId string

taskTemplateId

comments
completedTasks.comments array of

comments

reminderDate
completedTasks.reminderDate string

reminderDate

statusEnum
completedTasks.statusEnum string

statusEnum

Beschreibung
completedTasks.description string

Beschreibung

requiresAllRecipients
completedTasks.requiresAllRecipients boolean

requiresAllRecipients

assignedUserIds
completedTasks.assignedUserIds array of string

assignedUserIds

completedUserIds
completedTasks.completedUserIds array of string

completedUserIds

showCloseTaskDialog
completedTasks.showCloseTaskDialog boolean

showCloseTaskDialog

intendedUserIds
completedTasks.intendedUserIds array of

intendedUserIds

values
completedTasks.nameGlobal.values array of object

values

Kultur
completedTasks.nameGlobal.values.culture string

Kultur

Text
completedTasks.nameGlobal.values.text string

Text

values
completedTasks.descriptionGlobal.values array of object

values

Kultur
completedTasks.descriptionGlobal.values.culture string

Kultur

Text
completedTasks.descriptionGlobal.values.text string

Text

assignedUserCCIds
completedTasks.assignedUserCCIds array of

assignedUserCCIds

Stellvertretende Vertretungen
completedTasks.deputyRepresentations array of

Stellvertretende Vertretungen

taskActionEnum
completedTasks.taskActionEnum string

taskActionEnum

documentIds
documentIds array of string

documentIds

checkOutStateEnum
checkOutStateEnum string

checkOutStateEnum

checkOutUserId
checkOutUserId string

checkOutUserId

sessionCount
sessionCount integer

sessionCount