iManage-Arbeit
iManage Work Connector ermöglicht Es Benutzern, sich wiederholende Aufgaben und Genehmigungsprozesse zu automatisieren, während sie alle ihre Dateien in der iManage-Arbeitsumgebung sicher halten.
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 | iManage LLC |
| URL | https://docs.imanage.com |
| cloudsupport@imanage.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | iManage Power Platform Connector |
| Webseite | https://imanage.com |
| Datenschutzrichtlinie | https://imanage.com/about/privacy-notice/ |
| Kategorien | Inhalt und Dateien; Produktivität |
iManage-Arbeit
iManage ist der branchenführende Anbieter von Dokument- und E-Mail-Management-Lösungen für Wissensarbeiter. Die iManage-Plattform organisiert und sichert die Informationen in Dokumenten und E-Mails, sodass Experten nach dem gesuchten Gesuchten suchen, darauf reagieren und effektiver zusammenarbeiten können. Der iManage Work Connector ermöglicht Es Benutzern, sich wiederholende Aufgaben und Genehmigungsprozesse zu automatisieren, während sie alle ihre Dateien in der iManage Work-Umgebung sicher halten.
Voraussetzungen
Der Connector ist für alle iManage Work-Kunden verfügbar, die eine Verbindung mit cloudimanage.com herstellen. Zunächst muss die Power Automate-Anwendung von einem Administrator Ihrer iManage-Arbeitsumgebung aktiviert werden. Nach der Aktivierung benötigen Sie die spezifische URL für Ihre Umgebung sowie ein Anmeldekonto und ein Kennwort, unter dem der Connector Aktionen ausführen kann. Weitere Informationen finden Sie in den häufig gestellten Fragen .For more information, see the FAQ.
So erhalten Sie Anmeldeinformationen
Wenn Sie ein vorhandener iManage Work-Benutzer sind, geben Sie Ihre iManage Work-Anmeldeinformationen für die Anmeldung an. Wenden Sie sich andernfalls an den Systemadministrator, um Hilfe zu erhalten.
Erste Schritte mit iManage Work Connector
Führen Sie die folgenden Schritte aus, um mit dem iManage Work Connector zu beginnen:
- Erstellen Sie einen sofortigen Cloudfluss, und wählen Sie +Neuer Schritt aus.
- Suchen Sie nach "iManage Work ", um alle verfügbaren iManage-Arbeitsaktionen anzuzeigen.
- Wählen Sie die gewünschte iManage Work-Aktion aus.
- Wenn Sie noch nicht bei iManage Work angemeldet sind, werden Sie aufgefordert, sich anzumelden.
- Wählen Sie Anmelden aus.
- Geben Sie die URL ein, die Sie zum Herstellen einer Verbindung mit iManage Work verwenden, z. B. cloudimanage.com.
- Geben Sie Ihre iManage Work User ID ein.
- Geben Sie das Kennwort für das ausgewählte Konto ein, und wählen Sie "Anmelden" aus. Ab diesem Zeitpunkt stellen alle Flüsse, die iManage Work-Aktionen verwenden, mithilfe dieser Benutzeranmeldeinformationen eine Verbindung her. Ein anderes iManage-Benutzerkonto kann verwendet werden, indem eine neue Verbindung unter "Meine Verbindungen" hinzugefügt und zu diesem gewechselt wird.
Bekannte Probleme und Einschränkungen
Eine Liste der bekannten Probleme und Einschränkungen finden Sie unter https://docs.imanage.com/power-automate/index.html.
Häufige Fehler und Abhilfemaßnahmen
Eine Liste der häufig auftretenden Fehler und Abhilfemaßnahmen finden Sie unter https://docs.imanage.com/power-automate/index.html.
Häufig gestellte Fragen
Eine Liste der häufig gestellten Fragen finden Sie unter https://docs.imanage.com/power-automate/index.html.
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen der wichtigsten erweiterten Metadateneigenschaften eines Dokuments |
Ruft die wichtigsten erweiterten Metadateneigenschaften eines Dokuments ab. |
| Abrufen von Arbeitsbereichsvorlagen |
Ruft eine Liste der in einer Bibliothek verfügbaren Vorlagen ab. Eine Arbeitsbereichsvorlage ist ein vordefinierter Arbeitsbereich, dessen Struktur für den neuen Arbeitsbereich kopiert wird. |
| Abrufen von Benutzerdetails |
Ruft Informationen zu einem Benutzer aus der angegebenen Bibliothek ab. |
| Abrufen von Bibliotheken |
Ruft eine Liste der Bibliotheken ab, auf die der Benutzer Zugriff hat. |
| Abrufen von Dokumentversionen |
Ruft Profile für alle Versionen ab, auf die der aktuelle Benutzer zugriff auf ein angegebenes Dokument hat. |
| Abrufen von Kursen |
Ruft die Liste der in einer Bibliothek verfügbaren Dokumentklassen ab, die den angegebenen Kriterien entsprechen. |
| Abrufen von Unterklassen |
Ruft alle Bibliotheksunterklassen ab, die den angegebenen Kriterien entsprechen. |
| Aktualisieren der aktuellen oder Erstellen einer neuen Dokumentversion |
Aktualisiert die angegebene Version eines Dokuments oder erstellt eine neue Version. Diese Aktion kann das Profil und den Inhalt eines Dokuments aktualisieren. Wenn die Option "Aktuelle Version aktualisieren" angegeben ist, wird das Dokument durch ein neues ersetzt, und das Profil des vorherigen Dokuments wird beibehalten. Wenn "Neue Version erstellen" angegeben ist, wird eine neue Version des Dokuments erstellt, die das Profil des Ordners erbt. Nach erfolgreicher Ausführung des Vorgangs wird das Dokumentprofil zurückgegeben. |
| Aktualisieren der Standardsicherheit |
Aktualisiert die Standardsicherheit eines Dokuments, ordners oder Arbeitsbereichs. |
| Arbeitsbereich aktualisieren |
Aktualisiert Informationen des angegebenen Arbeitsbereichs. Um den vorhandenen Wert eines Zeichenfolgenfelds zu löschen, legen Sie den Wert des Felds auf eine leere Zeichenfolge fest, die in einfache oder doppelte Anführungszeichen eingeschlossen ist. |
| Arbeitsbereich erstellen |
Erstellt einen neuen Arbeitsbereich basierend auf der ausgewählten Vorlage. Eine Arbeitsbereichsvorlage ist ein vordefinierter Arbeitsbereich, dessen Struktur in den neuen Arbeitsbereich kopiert wird. Einschränkungen für die Arbeitsbereichsvorlage werden beim Erstellen des neuen Arbeitsbereichs automatisch erzwungen. |
| Arbeitsbereichsprofil abrufen |
Ruft das Arbeitsbereichsprofil und optional die Liste der zulässigen Vorgänge für den Arbeitsbereich ab. |
| Benutzer durchsuchen |
Sucht nach iManage Work-Benutzern, die den angegebenen Suchkriterien entsprechen. |
| Berechtigungen abrufen |
Ruft Benutzer- oder Gruppenzugriffsberechtigungseigenschaften eines Dokuments, ordners oder Arbeitsbereichs ab. Antworteigenschaften können mit Benutzer- oder Gruppenberechtigungen variieren. |
| Berechtigungen aktualisieren |
Aktualisiert berechtigungen eines Objekts. |
| Dokument herunterladen |
Lädt eine Version eines bestimmten Dokuments basierend auf der Dokument-ID herunter. Wenn die neueste Version zutrifft, wird die neueste Version dieses Dokuments heruntergeladen. Der Download ist ein Datenstrom und wird nicht lokal gespeichert. |
| Dokument hochladen |
Lädt eine Datei als neues Dokument in den angegebenen Ordner hoch. |
| Dokument kopieren |
Kopiert ein Dokument in den angegebenen Ordner. |
| Dokument löschen |
Löscht das angegebene Dokument. |
| Dokument verschieben |
Verschiebt ein Dokument in den angegebenen Ordner. |
| Dokumentbeziehung erstellen |
Erstellt eine Beziehung zwischen angegebenen Dokumenten in einer Bibliothek. |
| Dokumentbeziehung löschen |
Löscht eine Beziehung zwischen angegebenen Dokumenten in einer Bibliothek. |
| Dokumentprofil abrufen |
Ruft die Dokumenteigenschaften ab, die einer bestimmten Dokument-ID zugeordnet sind. |
| Dokumentprofil aktualisieren |
Führt Aktualisierungen für das Dokumentprofil aus. Ein Dokument darf nicht verwendet werden, während es sein Profil aktualisiert, und das Profil eines ausgecheckten Dokuments kann nicht aktualisiert werden. Gibt nach dem Vorgang ein aktualisiertes Dokumentprofil zurück. |
| Dokumentreferenz löschen |
Löscht den Dokumentverweis aus dem angegebenen Ordner. |
| Dokumentverweis hinzufügen |
Fügt Dokumentverweis oder Dokumentverknüpfung in einem anderen Ordner hinzu. |
| Festlegen von grundlegenden erweiterten Metadateneigenschaften für ein Dokument |
Legt die wichtigsten erweiterten Metadateneigenschaften für ein Dokument fest. |
| Gruppenmitglieder abrufen |
Rufen Sie Details von Benutzern ab, die zur angegebenen Gruppe gehören, und entsprechen Sie den angegebenen Kriterien. |
| Hinzufügen eines Dokumentverlaufseintrags |
Fügt einen Eintrag als Ereignis im Verlauf des Dokuments hinzu. |
| Höherstufen der Dokumentversion |
Höher stuft eine vorhandene Version eines Dokuments auf die neueste Version. Eine neue Version wird aus einer angegebenen Journal-ID oder -Version erstellt und dann auf neueste Höhergestuft. Sie müssen entweder journal-ID oder Version angeben, aber nicht beides. |
| Kopieren von Berechtigungen |
Kopiert die Zugriffsberechtigungen und optional die Standardsicherheit von einem iManage Work -Objekt in ein anderes. "Kopiertyp" bietet Ihnen Optionen zum Behandeln der Kombination aus Quell- und Zielberechtigungen. "Überschreiben" aktualisiert die Benutzer, Gruppen und Berechtigungsstufen des Zielobjekts so, dass sie exakt mit den Quellobjekten übereinstimmen. "Zusammenführen" behält alle Benutzer und Gruppen auf dem Zielobjekt bei und kombiniert sie mit der Quelle, aber im Falle eines Konflikts der Berechtigungsstufe für eine Einzelperson oder Gruppe: "Zusammenführen (Pessimistisch)" verwendet die niedrigere Berechtigung, während "Zusammenführen (Optimistisch)" die höhere Berechtigung für den widersprüchlichen Benutzer oder die Gruppe akzeptiert. |
| Nach Arbeitsbereichen suchen |
Suchen Sie nach Arbeitsbereichen. |
| Nach Ordnern suchen |
Suchen Sie nach Ordnern. |
| Namen-Wert-Paare bearbeiten |
Erstellt, aktualisiert oder löscht die Eigenschaften eines Namens-Wert-Paars eines Dokuments, eines Ordners oder eines Arbeitsbereichs. Um ein Name-Wert-Paar zu löschen, legen Sie den Wert des Schlüssels auf eine leere Zeichenfolge fest, die in einfache oder doppelte Anführungszeichen eingeschlossen ist. |
| Suchkernwerte für erweiterte Metadatentaxonomieknoten |
Sucht nach wichtigen Werten für erweiterte Metadatentaxonomieknoten, die den angegebenen Suchkriterien entsprechen. |
| Trustees abrufen |
Ruft eine Liste der Trustees mit bestimmten Berechtigungen für ein Dokument, einen Ordner oder einen Arbeitsbereich ab. Ein Trustee kann ein Benutzer oder eine Gruppe sein. |
| Workflowstatus aktualisieren |
Aktualisiert den Status einer Workflowausführung. Diese Aktion kann nur in einem Workflow verwendet werden, der erstellt wurde, um mit einem von iManage bereitgestellten Trigger zu beginnen. |
Abrufen der wichtigsten erweiterten Metadateneigenschaften eines Dokuments
Ruft die wichtigsten erweiterten Metadateneigenschaften eines Dokuments ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Aktuell
|
latest | boolean |
Gibt an, dass die neueste Version des Dokuments abgerufen wird. |
Abrufen von Arbeitsbereichsvorlagen
Ruft eine Liste der in einer Bibliothek verfügbaren Vorlagen ab. Eine Arbeitsbereichsvorlage ist ein vordefinierter Arbeitsbereich, dessen Struktur für den neuen Arbeitsbereich kopiert wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die Bibliotheks-ID des Zielarbeitsbereichs an. |
|
Benutzerdefiniert1
|
custom1 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten Wert übereinstimmen soll, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert2
|
custom2 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten2-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert3
|
custom3 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten3-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert4
|
custom4 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten4-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert5
|
custom5 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten Wert übereinstimmen soll, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert6
|
custom6 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten6-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert7
|
custom7 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten7-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert8
|
custom8 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten8-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert9
|
custom9 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten Wert übereinstimmen soll, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert10
|
custom10 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 10-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert1
|
custom11 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 11-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert12
|
custom12 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 12-Wert übereinstimmt, der der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert17
|
custom17 | double |
Gibt den Wert für custom17 an. |
|
|
Benutzerdefiniert18
|
custom18 | double |
Gibt den Wert für custom18 an. |
|
|
Benutzerdefiniert19
|
custom19 | double |
Gibt den Wert für custom19 an. |
|
|
Benutzerdefiniert20
|
custom20 | double |
Gibt den Wert für custom20 an. |
|
|
Custom21
|
custom21 | string |
Gibt den Wert (im ISO 8601-Datumstime-Format) an, nach dem in custom21 gesucht werden soll, das der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom22
|
custom22 | string |
Gibt den Wert (im ISO 8601-Datumstime-Format) an, nach dem in custom22 gesucht werden soll, das der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom23
|
custom23 | string |
Gibt den Wert (im ISO 8601-Datumstime-Format) an, nach dem in custom23 gesucht werden soll, das der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom24
|
custom24 | string |
Gibt den Wert (im ISO 8601-Datumstime-Format) an, nach dem in custom24 gesucht werden soll, das der Arbeitsbereichsvorlage zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom21 (Lower Limit)
|
custom21_from | string |
Gibt die untere Grenze von custom21 (im ISO 8601-Datumstimeformat) für die Suche an. Diese Eigenschaft ist nicht für iManage Work reserviert und kein überprüfter Wert. Es soll an die Anforderungen Ihres Unternehmens angepasst werden. |
|
|
Custom21 (Obergrenze)
|
custom21_to | string |
Gibt die obere Grenze von custom21 (im ISO 8601-Datumstime-Format) an, die durchsucht werden soll. Diese Eigenschaft ist nicht für iManage Work reserviert und kein überprüfter Wert. Es soll an die Anforderungen Ihres Unternehmens angepasst werden. |
|
|
Custom21 (Relativ)
|
custom21_relative | string |
Gibt einen zu durchsuchenden Datumsbereich relativ zum aktuellen Datum an. Dieser Parameter hat ein Format von [begin]:[end][time units (d, m oder y)]. Beispielsweise gibt -15:1d einen Datumsbereich von 15 Tagen vor dem aktuellen Datum bis zu einem Tag nach dem aktuellen Datum an (ein Tag in der Zukunft). |
|
|
Custom22 (Lower Limit)
|
custom22_from | string |
Gibt die untere Grenze von custom22 (im ISO 8601-Datumstime-Format) an, die durchsucht werden soll. Diese Eigenschaft ist nicht für iManage Work reserviert und kein überprüfter Wert. Es soll an die Anforderungen Ihres Unternehmens angepasst werden. |
|
|
Custom22 (Obergrenze)
|
custom22_to | string |
Gibt die obere Grenze von custom22 (im ISO 8601-Datumstime-Format) an, die durchsucht werden soll. Diese Eigenschaft ist nicht für iManage Work reserviert und kein überprüfter Wert. Es soll an die Anforderungen Ihres Unternehmens angepasst werden. |
|
|
Custom22 (Relativ)
|
custom22_relative | string |
Gibt einen zu durchsuchenden Datumsbereich relativ zum aktuellen Datum an. Dieser Parameter hat ein Format von [begin]:[end][time units (d, m oder y)]. Beispielsweise gibt -15:1d einen Datumsbereich von 15 Tagen vor dem aktuellen Datum bis zu einem Tag nach dem aktuellen Datum an (ein Tag in der Zukunft). |
|
|
Custom23 (Lower Limit)
|
custom23_from | string |
Gibt die untere Grenze von custom23 (im ISO 8601-Datumstime-Format) an, die durchsucht werden soll. Diese Eigenschaft ist nicht für iManage Work reserviert und kein überprüfter Wert. Es soll an die Anforderungen Ihres Unternehmens angepasst werden. |
|
|
Custom23 (Obergrenze)
|
custom23_to | string |
Gibt die obere Grenze von custom23 (im ISO 8601-Datumstime-Format) an, die durchsucht werden soll. Diese Eigenschaft ist nicht für iManage Work reserviert und kein überprüfter Wert. Es soll an die Anforderungen Ihres Unternehmens angepasst werden. |
|
|
Custom23 (Relativ)
|
custom23_relative | string |
Gibt einen zu durchsuchenden Datumsbereich relativ zum aktuellen Datum an. Dieser Parameter hat ein Format von [begin]:[end][time units (d, m oder y)]. Beispielsweise gibt -15:1d einen Datumsbereich von 15 Tagen vor dem aktuellen Datum bis zu einem Tag nach dem aktuellen Datum an (ein Tag in der Zukunft). |
|
|
Custom24 (Lower Limit)
|
custom24_from | string |
Gibt die untere Grenze von custom24 (im ISO 8601-Datumstime-Format) an, die durchsucht werden soll. Diese Eigenschaft ist nicht für iManage Work reserviert und kein überprüfter Wert. Es soll an die Anforderungen Ihres Unternehmens angepasst werden. |
|
|
Custom24 (Obergrenze)
|
custom24_to | string |
Gibt die obere Grenze von custom24 (im ISO 8601-Datumstime-Format) an, die durchsucht werden soll. Diese Eigenschaft ist nicht für iManage Work reserviert und kein überprüfter Wert. Es soll an die Anforderungen Ihres Unternehmens angepasst werden. |
|
|
Custom24 (Relativ)
|
custom24_relative | string |
Gibt einen zu durchsuchenden Datumsbereich relativ zum aktuellen Datum an. Dieser Parameter hat ein Format von [begin]:[end][time units (d, m oder y)]. Beispielsweise gibt -15:1d einen Datumsbereich von 15 Tagen vor dem aktuellen Datum bis zu einem Tag nach dem aktuellen Datum an (ein Tag in der Zukunft). |
|
|
Custom25
|
custom25 | boolean |
Gibt den benutzerdefinierten 25-Wert an, nach dem gesucht werden soll. |
|
|
Custom26
|
custom26 | boolean |
Gibt den benutzerdefinierten26-Wert an, nach dem gesucht werden soll. |
|
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt den benutzerdefinierten27-Wert an, nach dem gesucht werden soll. |
|
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt den benutzerdefinierten28-Wert an, nach dem gesucht werden soll. |
|
|
Benutzerdefiniert29
|
custom29 | string |
Gibt einen Wert an, der mit custom29 übereinstimmen soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Custom30
|
custom30 | string |
Gibt einen Wert an, der mit custom30 übereinstimmen soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
Abrufen von Benutzerdetails
Ruft Informationen zu einem Benutzer aus der angegebenen Bibliothek ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die Bibliotheks-ID des Zielbenutzers an. |
|
Benutzer-ID
|
userId | True | string |
Gibt die ID des Benutzers an, für den detaillierte Profilinformationen abgerufen werden sollen. Beispiel: "JSMITH". |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Daten
|
data | UserProfile |
Gibt Informationen zu einem Benutzer an. |
Abrufen von Bibliotheken
Ruft eine Liste der Bibliotheken ab, auf die der Benutzer Zugriff hat.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Daten
|
data | array of object |
Gibt die Liste der Bibliotheken an, auf die der Benutzer Zugriff hat. |
|
ID
|
data.id | string |
Gibt den Namen der Bibliothek an. |
|
Name
|
data.display_name | string |
Gibt den Anzeigenamen der Bibliothek an. |
|
Typ
|
data.type | string |
Gibt den Typ der Bibliothek an. Mögliche Werte sind "Worksite" oder "linksite". |
|
Ist ausgeblendet
|
data.is_hidden | boolean |
Gibt an, ob die Bibliothek ausgeblendet ist. |
Abrufen von Dokumentversionen
Ruft Profile für alle Versionen ab, auf die der aktuelle Benutzer zugriff auf ein angegebenes Dokument hat.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumentprofile
|
data | array of MinimalDocumentProfileInArray |
Abrufen von Kursen
Ruft die Liste der in einer Bibliothek verfügbaren Dokumentklassen ab, die den angegebenen Kriterien entsprechen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die Bibliotheks-ID der Zielklasse an. |
|
Klassen-ID
|
alias | string |
Gibt die ID einer klasse oder klassen an, nach der gesucht werden soll. Dies kann eine durch Trennzeichen getrennte Liste sein. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden unterstützt. |
|
|
Standardsicherheit
|
default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. |
|
|
Description
|
description | string |
Gibt den Text an, der im Beschreibungsfeld übereinstimmen soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) wird unterstützt. Partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Echo
|
echo | boolean |
Gibt an, ob Dokumente dieser Klasse Dokumente echoen können. |
|
|
HIPAA
|
hipaa | boolean |
Gibt an, ob Dokumente dieser Klasse HIPAA-kompatible Verschlüsselung verwenden. |
|
|
Lösbaren
|
indexable | boolean |
Gibt an, ob Dokumente dieser Klasse vom Volltextindexer des Systems indiziert werden. |
|
|
Query
|
query | string |
Gibt den Text an, der mit den Feldern "ID" oder "Beschreibung" übereinstimmen soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden unterstützt. |
|
|
Unterklasse erforderlich
|
subclass_required | boolean |
Gibt an, ob die Klasse über eine erforderliche Unterklasse verfügt. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Top Matching Class ID
|
data.topMatchingId | string |
Gibt die ID der obersten übereinstimmenden Klasse an. Beispiel: "PETITION". |
|
Beschreibung der besten übereinstimmenden Klasse
|
data.topMatchingDescription | string |
Gibt die Beschreibung der obersten übereinstimmenden Klasse an. |
|
results
|
data.results | array of object |
Gibt die Liste der klassen an, die in einer Bibliothek verfügbar sind, die den angegebenen Kriterien entsprechen. |
|
Description
|
data.results.description | string |
Gibt weitere Informationen zur Klasse an. |
|
Ist HIPAA
|
data.results.hipaa | boolean |
Gibt an, ob das Dokument verschlüsselt ist. |
|
ID
|
data.results.id | string |
Gibt die ID der Klasse an. Beispiel: "PETITION". |
|
Ist indiziert
|
data.results.indexable | boolean |
Gibt an, ob das Dokument vom System indiziert wird. |
|
Standardsicherheit
|
data.results.default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. Mögliche Werte sind "public", "view", "private". |
|
Retain
|
data.results.retain | integer |
Gibt die Anzahl der Tage an, bevor inaktive Dokumente dieser Klasse als abgelaufen markiert werden. |
|
Pflichtfelder
|
data.results.required_fields | array of string |
Gibt die obligatorischen benutzerdefinierten Eigenschaften an, die beim Erstellen oder Aktualisieren eines Dokuments dieser Klasse eingegeben werden sollen. |
|
Ist schattiert
|
data.results.shadow | boolean |
Gibt an, ob ein Dokument dieser Klasse nach dem Einchecken auf dem lokalen Computer eines Benutzers schattiert (aufbewahrt) wird. |
|
Ist Unterklasse erforderlich
|
data.results.subclass_required | boolean |
Gibt an, ob für diese Klasse eine Unterklasse erforderlich ist. |
Abrufen von Unterklassen
Ruft alle Bibliotheksunterklassen ab, die den angegebenen Kriterien entsprechen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die Bibliotheks-ID der Zielunterklasse an. |
|
Klassen-ID
|
classId | True | string |
Gibt die ID der Klasse an, die das übergeordnete Element dieser Unterklasse ist. Beispiel: "PETITION". |
|
Unterklassen-ID
|
alias | string |
Gibt die ID der zu suchden Unterklassen an. Dies kann eine durch Trennzeichen getrennte Liste sein. Das Platzhalterzeichen (*) wird unterstützt. Partielle Übereinstimmungen werden unterstützt, wenn das Wildcardzeichen verwendet wird. |
|
|
Standardsicherheit
|
default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. |
|
|
Description
|
description | string |
Gibt den Text an, der im Beschreibungsfeld übereinstimmen soll. Das Platzhalterzeichen (*) wird unterstützt. Partielle Übereinstimmungen werden unterstützt, wenn das Wildcardzeichen verwendet wird. |
|
|
Echo
|
echo | boolean |
Gibt an, ob die Unterklassen auf die lokale Festplatte eines Benutzers echoen können. Dies ist die Erleichterung der Offlinearbeit. |
|
|
HIPAA
|
hipaa | boolean |
Gibt an, ob HIPAA-kompatible Unterklassen zurückgegeben werden sollen. |
|
|
Query
|
query | string |
Gibt den Text an, der mit den Feldern "Unterklassen-ID" oder "Beschreibung" übereinstimmen soll. Das Platzhalterzeichen (*) wird unterstützt. Partielle Übereinstimmungen werden unterstützt. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Top Matching Subclass ID
|
data.topMatchingId | string |
Gibt die ID der obersten übereinstimmenden Unterklasse an. |
|
Beschreibung der wichtigsten übereinstimmenden Unterklassen
|
data.topMatchingDescription | string |
Gibt eine Beschreibung der obersten übereinstimmenden Unterklasse an. |
|
results
|
data.results | array of object | |
|
Standardsicherheit
|
data.results.default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. Mögliche Werte sind "public", "view", "private". |
|
Description
|
data.results.description | string |
Gibt zusätzliche Informationen zur Unterklasse an. Die maximale Länge beträgt 255 Zeichen. |
|
Ist HIPAA
|
data.results.hipaa | boolean |
Gibt an, ob das Dokument verschlüsselt ist. |
|
ID
|
data.results.id | string |
Gibt die ID einer Unterklasse an, die zum Erstellen oder Ändern der Dokumentprofilinformationen verwendet wird. Beispiel: "WÄCHTERSCHAFT". |
|
Übergeordnete ID
|
data.results.parent.id | string |
Gibt die übergeordnete Klassen-ID der Unterklasse an. |
|
Pflichtfelder
|
data.results.required_fields | array of string |
Gibt die obligatorischen benutzerdefinierten Eigenschaften an, die beim Erstellen oder Aktualisieren eines Dokuments dieser Unterklasse eingegeben werden sollen. |
|
Retain
|
data.results.retain | integer |
Gibt die Anzahl der Tage an, bevor inaktive Dokumente dieser Unterklasse als abgelaufen markiert werden. |
|
Ist schattiert
|
data.results.shadow | boolean |
Gibt an, ob ein Dokument dieser Unterklasse nach dem Einchecken auf dem lokalen Computer eines Benutzers schattiert (aufbewahrt) wird. |
Aktualisieren der aktuellen oder Erstellen einer neuen Dokumentversion
Aktualisiert die angegebene Version eines Dokuments oder erstellt eine neue Version. Diese Aktion kann das Profil und den Inhalt eines Dokuments aktualisieren. Wenn die Option "Aktuelle Version aktualisieren" angegeben ist, wird das Dokument durch ein neues ersetzt, und das Profil des vorherigen Dokuments wird beibehalten. Wenn "Neue Version erstellen" angegeben ist, wird eine neue Version des Dokuments erstellt, die das Profil des Ordners erbt. Nach erfolgreicher Ausführung des Vorgangs wird das Dokumentprofil zurückgegeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Aktualisieren oder Erstellen einer neuen Version
|
updateOrCreate | True | string |
Gibt an, die aktuelle Version des Dokuments zu aktualisieren oder eine neue Version zu erstellen. |
|
Vorhandene Dokument-ID
|
documentId | True | string |
Gibt die ID des vorhandenen Dokuments an. Beispiel: "ACTIVE_US!556.1". |
|
Sperrung beibehalten
|
keep_locked | boolean |
Gibt an, ob eine Dokumentsperre nach dem Upload beibehalten wird. |
|
|
Kommentar
|
comment | string |
Gibt zusätzliche Informationen zum Update an. |
|
|
Dokumentname
|
name | string |
Gibt den Namen des Dokuments an. |
|
|
Autor
|
author | string |
Gibt die iManage-Arbeits-ID des Benutzers an, der das Dokument erstellt hat. |
|
|
Bediener
|
operator | string |
Gibt die ID des Benutzers an, der das Dokument ausgecheckt hat oder derzeit das Profil des Dokuments bearbeitet. Beispiel: "JSMITH". |
|
|
Class
|
class | string |
Gibt die Klasse zum Identifizieren und Unterscheiden des Dokuments an. Die Dokumentklasse wird nach Genre, Abteilung, Region usw. kategorisiert. |
|
|
Unterklasse
|
subclass | string |
Gibt die Unterklasse zum Identifizieren und Unterscheiden des Dokuments an. Dokumentunterklassen werden nach Genre, Abteilung, Region usw. kategorisiert. |
|
|
Standardsicherheit
|
default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. Mögliche Werte sind "inherit", "private", "view", "public". |
|
|
Ist HIPAA
|
is_hipaa | boolean |
Gibt an, ob das Dokument verschlüsselt werden soll. |
|
|
Tage aufbewahren
|
retain_days | integer |
Gibt die Anzahl der Tage an, die ein Dokument inaktiv sein muss, bevor es für die Archivierung markiert wird. |
|
|
Dateiinhalte
|
file | True | file |
Gibt den Inhalt der Datei an. |
|
Erstellungsdatum der Datei
|
file_create_date | date-time |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das die Datei erstellt wurde. Die Datei könnte außerhalb des iManage Work-Systems erstellt worden sein. Dieses Datum kann sich von "create_date" unterscheiden. Die create_date ist das Datum, an dem die Datei vom iManage Work-System erstellt oder importiert wurde. |
|
|
Datum der Dateibearbeitung
|
file_edit_date | date-time |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung an der Datei an. Die Datei konnte vor dem Hochladen in das iManage Work-System geändert worden sein. |
|
|
Benutzerdefiniert1
|
custom1 | string |
Gibt den Wert für custom1 an. |
|
|
Benutzerdefiniert2
|
custom2 | string |
Gibt den Wert für custom2 an. Um einen Wert für custom2 anzugeben, müssen Sie auch einen Wert für "custom1" in derselben Anforderung angeben, der auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
|
|
Benutzerdefiniert3
|
custom3 | string |
Gibt den Wert für custom3 an. |
|
|
Benutzerdefiniert4
|
custom4 | string |
Gibt den Wert für custom4 an. |
|
|
Benutzerdefiniert5
|
custom5 | string |
Gibt den Wert für custom5 an. |
|
|
Benutzerdefiniert6
|
custom6 | string |
Gibt den Wert für custom6 an. |
|
|
Benutzerdefiniert7
|
custom7 | string |
Gibt den Wert für custom7 an. |
|
|
Benutzerdefiniert8
|
custom8 | string |
Gibt den Wert für custom8 an. |
|
|
Benutzerdefiniert9
|
custom9 | string |
Gibt den Wert für custom9 an. |
|
|
Benutzerdefiniert10
|
custom10 | string |
Gibt den Wert für custom10 an. |
|
|
Benutzerdefiniert1
|
custom11 | string |
Gibt den Wert für custom11 an. |
|
|
Benutzerdefiniert12
|
custom12 | string |
Gibt den Wert für custom12 an. |
|
|
Benutzerdefiniert13
|
custom13 | string |
Gibt den Wert für custom13 an. |
|
|
Benutzerdefiniert14
|
custom14 | string |
Gibt den Wert für custom14 an. |
|
|
Benutzerdefiniert15
|
custom15 | string |
Gibt den Wert für custom15 an. |
|
|
Benutzerdefiniert16
|
custom16 | string |
Gibt den Wert für custom16 an. |
|
|
Benutzerdefiniert17
|
custom17 | double |
Gibt den Wert für custom17 an. |
|
|
Benutzerdefiniert18
|
custom18 | double |
Gibt den Wert für custom18 an. |
|
|
Benutzerdefiniert19
|
custom19 | double |
Gibt den Wert für custom19 an. |
|
|
Benutzerdefiniert20
|
custom20 | double |
Gibt den Wert für custom20 an. |
|
|
Custom21
|
custom21 | string |
Gibt den Wert für custom21 im ISO 8601-Datumstime-Format an. |
|
|
Custom22
|
custom22 | string |
Gibt den Wert für custom22 im ISO 8601-Datumstime-Format an. |
|
|
Custom23
|
custom23 | string |
Gibt den Wert für custom23 im ISO 8601-Datumstime-Format an. |
|
|
Custom24
|
custom24 | string |
Gibt den Wert für custom24 im ISO 8601-Datumstime-Format an. |
|
|
Custom25
|
custom25 | boolean |
Gibt den Wert für custom25 an. |
|
|
Custom26
|
custom26 | boolean |
Gibt den Wert für custom26 an. |
|
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt den Wert für custom27 an. |
|
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt den Wert für custom28 an. |
|
|
Benutzerdefiniert29
|
custom29 | string |
Gibt den Wert für custom29 an. |
|
|
Custom30
|
custom30 | string |
Gibt den Wert für custom30 an. Um einen Wert für custom30 anzugeben, müssen Sie auch einen Wert für custom29 in derselben Anforderung angeben, was auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
Aktualisieren der Standardsicherheit
Aktualisiert die Standardsicherheit eines Dokuments, ordners oder Arbeitsbereichs.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekttyp
|
objectType | True | string |
Gibt den Objekttyp an. |
|
Objekt-ID
|
objectId | True | string |
Gibt die ID des Dokuments, des Ordners oder des Arbeitsbereichs an. Ein Beispiel für eine Dokument-ID ist "ACTIVE_US!453.1". Ein Beispiel für eine Ordner- oder Arbeitsbereichs-ID ist "ACTIVE_US!123". |
|
Standardsicherheit
|
default_security | True | string |
Gibt die Standardsicherheit für das Objekt an. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Standardsicherheit
|
data.default_security | string |
Gibt die Standardsicherheit des Objekts an. Mögliche Werte sind "inherit", "public", "view" oder "private". |
|
Zugriffsberechtigungen
|
data.acl | AccessPermissions |
Gibt eine Sammlung von Zugriffsberechtigungen für einen oder mehrere Benutzer und/oder Gruppen an. |
Arbeitsbereich aktualisieren
Aktualisiert Informationen des angegebenen Arbeitsbereichs. Um den vorhandenen Wert eines Zeichenfolgenfelds zu löschen, legen Sie den Wert des Felds auf eine leere Zeichenfolge fest, die in einfache oder doppelte Anführungszeichen eingeschlossen ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Arbeitsbereichs-ID
|
id | True | string |
Gibt die ID des arbeitsbereichs an, der aktualisiert werden soll. Beispiel: "ACTIVE_US!427". |
|
Name
|
name | string |
Gibt den Namen des Arbeitsbereichs an. |
|
|
Arbeitsbereichsbesitzer
|
owner | string |
Gibt den Besitzer des Arbeitsbereichs an. |
|
|
Benutzerdefiniert1
|
custom1 | string |
Gibt den Wert von custom1 an. |
|
|
Benutzerdefiniert2
|
custom2 | string |
Gibt den Wert von custom2 an. Um einen Wert für custom2 anzugeben, müssen Sie auch einen Wert für "custom1" in derselben Anforderung angeben, der auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
|
|
Benutzerdefiniert3
|
custom3 | string |
Gibt den Wert von custom3 an. |
|
|
Benutzerdefiniert4
|
custom4 | string |
Gibt den Wert von custom4 an. |
|
|
Benutzerdefiniert5
|
custom5 | string |
Gibt den Wert von custom5 an. |
|
|
Benutzerdefiniert6
|
custom6 | string |
Gibt den Wert von custom6 an. |
|
|
Benutzerdefiniert7
|
custom7 | string |
Gibt den Wert von custom7 an. |
|
|
Benutzerdefiniert8
|
custom8 | string |
Gibt den Wert von custom8 an. |
|
|
Benutzerdefiniert9
|
custom9 | string |
Gibt den Wert von custom9 an. |
|
|
Benutzerdefiniert10
|
custom10 | string |
Gibt den Wert von custom10 an. |
|
|
Benutzerdefiniert1
|
custom11 | string |
Gibt den Wert von custom11 an. |
|
|
Benutzerdefiniert12
|
custom12 | string |
Gibt den Wert von custom12 an. |
|
|
Benutzerdefiniert13
|
custom13 | string |
Gibt den Wert von custom13 an. |
|
|
Benutzerdefiniert14
|
custom14 | string |
Gibt den Wert von custom14 an. |
|
|
Benutzerdefiniert15
|
custom15 | string |
Gibt den Wert von custom15 an. |
|
|
Benutzerdefiniert16
|
custom16 | string |
Gibt den Wert von custom16 an. |
|
|
Benutzerdefiniert17
|
custom17 | double |
Gibt den Wert von custom17 an. |
|
|
Benutzerdefiniert18
|
custom18 | double |
Gibt den Wert von custom18 an. |
|
|
Benutzerdefiniert19
|
custom19 | double |
Gibt den Wert von custom19 an. |
|
|
Benutzerdefiniert20
|
custom20 | double |
Gibt den Wert von custom20 an. |
|
|
Custom21
|
custom21 | string |
Gibt den Wert von custom21 im ISO 8601-Datumstime-Format an. |
|
|
Custom22
|
custom22 | string |
Gibt den Wert von custom22 im ISO 8601-Datumstime-Format an. |
|
|
Custom23
|
custom23 | string |
Gibt den Wert von custom23 im ISO 8601-Datumstime-Format an. |
|
|
Custom24
|
custom24 | string |
Gibt den Wert von custom24 im ISO 8601-Datumstime-Format an. |
|
|
Custom25
|
custom25 | boolean |
Gibt den Wert von custom25 an. |
|
|
Custom26
|
custom26 | boolean |
Gibt den Wert von custom26 an. |
|
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt den Wert von custom27 an. |
|
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt den Wert von custom28 an. |
|
|
Benutzerdefiniert29
|
custom29 | string |
Gibt den Wert von custom29 an. |
|
|
Custom30
|
custom30 | string |
Gibt den Wert von custom30 an. Um einen Wert für custom30 anzugeben, müssen Sie auch einen Wert für custom29 in derselben Anforderung angeben, was auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
|
|
Standardsicherheit
|
default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. |
|
|
Description
|
description | string |
Gibt zusätzliche Informationen zum Arbeitsbereich an. |
|
|
Ist extern als normal
|
is_external_as_normal | boolean |
Gibt an, ob der Arbeitsbereich als öffentlicher Arbeitsbereich behandelt werden kann. Wenn "true" und "default_security" nicht "privat" ist, wird "is_external" auf "true" festgelegt. |
|
|
Projekt benutzerdefiniert1
|
project_custom1 | string |
Gibt zusätzliche Informationen zum Arbeitsbereich an. Dieses Feld unterscheidet sich von dem benutzerdefinierten Metadatenfeld, das Inhaltselementen zugeordnet ist, z. B. Dokumente, Arbeitsbereiche oder Ordner. Dies ist beschreibender Text, der nicht formatiert werden muss und nicht überprüft wird. |
|
|
Projekt benutzerdefiniert2
|
project_custom2 | string |
Gibt zusätzliche Informationen zum Arbeitsbereich an. Dieses Feld unterscheidet sich von dem benutzerdefinierten Metadatenfeld, das Inhaltselementen zugeordnet ist, z. B. Dokumente, Arbeitsbereiche oder Ordner. Dies ist beschreibender Text, der nicht formatiert werden muss und nicht überprüft wird. |
|
|
Projekt benutzerdefiniert3
|
project_custom3 | string |
Gibt zusätzliche Informationen zum Arbeitsbereich an. Dieses Feld unterscheidet sich von dem benutzerdefinierten Metadatenfeld, das Inhaltselementen zugeordnet ist, z. B. Dokumente, Arbeitsbereiche oder Ordner. Dies ist beschreibender Text, der nicht formatiert werden muss und nicht überprüft wird. |
|
|
Arbeitsbereich-Unterklasse
|
subclass | string |
Gibt die Unterklasse des Arbeitsbereichs basierend auf der Unterklasse des darin enthaltenen Dokuments an. |
Arbeitsbereich erstellen
Erstellt einen neuen Arbeitsbereich basierend auf der ausgewählten Vorlage. Eine Arbeitsbereichsvorlage ist ein vordefinierter Arbeitsbereich, dessen Struktur in den neuen Arbeitsbereich kopiert wird. Einschränkungen für die Arbeitsbereichsvorlage werden beim Erstellen des neuen Arbeitsbereichs automatisch erzwungen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die Bibliotheks-ID des Zielarbeitsbereichs an. |
|
Template
|
templateId | True | string |
Gibt die Arbeitsbereichsvorlage an, die zum Erstellen des Arbeitsbereichs und der untergeordneten Elemente verwendet werden soll. |
|
Name
|
name | True | string |
Gibt den Namen des Arbeitsbereichs an. |
|
Untergeordnete Elemente erstellen
|
createChildren | True | string |
Gibt an, dass alle Ordner (optional und erforderlich) oder nur die erforderlichen Ordner erstellt werden sollen. |
|
Arbeitsbereichsbesitzer
|
owner | string |
Gibt den Besitzer des Arbeitsbereichs an. Sie müssen ein iManage Work-Systemadministrator sein, um den Besitzer eines Arbeitsbereichs festzulegen. |
|
|
Standardsicherheit
|
default_security | string |
Gibt die Standardzugriffsebene an. Wenn sie nicht angegeben ist, wird die Standardzugriffsebene der ausgewählten Vorlage verwendet. |
|
|
Description
|
description | string |
Gibt zusätzliche Informationen zum Arbeitsbereich an. |
|
|
Benutzerdefiniert1
|
custom1 | string |
Gibt den Wert von custom1 an, der dem neu erstellten Arbeitsbereich zugeordnet werden soll. Dieser Wert setzt den benutzerdefinierten Wert des ausgewählten Vorlagenarbeitsbereichs außer Kraft, falls vorhanden. Wenn die untergeordneten Ordner einen benutzerdefinierten Wert festgelegt haben, wird der benutzerdefinierte1-Wert dieser untergeordneten Ordner nicht überschrieben. |
|
|
Benutzerdefiniert2
|
custom2 | string |
Gibt den Wert von custom2 an, der dem neu erstellten Arbeitsbereich zugeordnet werden soll. Um einen Wert für custom2 anzugeben, müssen Sie auch einen Wert für "custom1" in derselben Anforderung angeben, der auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. Dieser Wert setzt den benutzerdefinierten2-Wert des ausgewählten Vorlagenarbeitsbereichs außer Kraft, falls vorhanden. Wenn die untergeordneten Ordner einen benutzerdefinierten2-Wert festgelegt haben, wird der benutzerdefinierte2-Wert dieser untergeordneten Ordner nicht überschrieben. |
|
|
Benutzerdefiniert3
|
custom3 | string |
Gibt den Wert von custom3 an. |
|
|
Benutzerdefiniert4
|
custom4 | string |
Gibt den Wert von custom4 an. |
|
|
Benutzerdefiniert5
|
custom5 | string |
Gibt den Wert von custom5 an. |
|
|
Benutzerdefiniert6
|
custom6 | string |
Gibt den Wert von custom6 an. |
|
|
Benutzerdefiniert7
|
custom7 | string |
Gibt den Wert von custom7 an. |
|
|
Benutzerdefiniert8
|
custom8 | string |
Gibt den Wert von custom8 an. |
|
|
Benutzerdefiniert9
|
custom9 | string |
Gibt den Wert von custom9 an. |
|
|
Benutzerdefiniert10
|
custom10 | string |
Gibt den Wert von custom10 an. |
|
|
Benutzerdefiniert1
|
custom11 | string |
Gibt den Wert von custom11 an. |
|
|
Benutzerdefiniert12
|
custom12 | string |
Gibt den Wert von custom12 an. |
|
|
Benutzerdefiniert13
|
custom13 | string |
Gibt den Wert von custom13 an. |
|
|
Benutzerdefiniert14
|
custom14 | string |
Gibt den Wert von custom14 an. |
|
|
Benutzerdefiniert15
|
custom15 | string |
Gibt den Wert von custom15 an. |
|
|
Benutzerdefiniert16
|
custom16 | string |
Gibt den Wert von custom16 an. |
|
|
Benutzerdefiniert17
|
custom17 | double |
Gibt den Wert von custom17 an. |
|
|
Benutzerdefiniert18
|
custom18 | double |
Gibt den Wert von custom18 an. |
|
|
Benutzerdefiniert19
|
custom19 | double |
Gibt den Wert von custom19 an. |
|
|
Benutzerdefiniert20
|
custom20 | double |
Gibt den Wert von custom20 an. |
|
|
Custom21
|
custom21 | string |
Gibt den Wert von custom21 im ISO 8601-Datumstime-Format an. |
|
|
Custom22
|
custom22 | string |
Gibt den Wert von custom22 im ISO 8601-Datumstime-Format an. |
|
|
Custom23
|
custom23 | string |
Gibt den Wert von custom23 im ISO 8601-Datumstime-Format an. |
|
|
Custom24
|
custom24 | string |
Gibt den Wert von custom24 im ISO 8601-Datumstime-Format an. |
|
|
Custom25
|
custom25 | boolean |
Gibt den Wert von custom25 an. |
|
|
Custom26
|
custom26 | boolean |
Gibt den Wert von custom26 an. |
|
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt den Wert von custom27 an. |
|
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt den Wert von custom28 an. |
|
|
Benutzerdefiniert29
|
custom29 | string |
Gibt den Wert von custom29 an. |
|
|
Custom30
|
custom30 | string |
Gibt den Wert von custom30 an. Um einen Wert für custom30 anzugeben, müssen Sie auch einen Wert für custom29 in derselben Anforderung angeben, was auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
|
|
Ist extern als normal
|
is_external_as_normal | boolean |
Gibt an, dass der Arbeitsbereich als öffentlicher Arbeitsbereich behandelt werden kann. Wenn "true" und "default_security" nicht "privat" ist, wird "is_external" auf "true" festgelegt. |
|
|
Projekt benutzerdefiniert1
|
project_custom1 | string |
Gibt zusätzliche Informationen zum Arbeitsbereich an. Dieses Feld unterscheidet sich von dem benutzerdefinierten Metadatenfeld, das Inhaltselementen zugeordnet ist, z. B. Dokumente, Arbeitsbereiche oder Ordner. Dies ist beschreibender Text, der nicht formatiert werden muss und nicht überprüft wird. |
|
|
Projekt benutzerdefiniert2
|
project_custom2 | string |
Gibt zusätzliche Informationen zum Arbeitsbereich an. Dieses Feld unterscheidet sich von dem benutzerdefinierten Metadatenfeld, das Inhaltselementen zugeordnet ist, z. B. Dokumente, Arbeitsbereiche oder Ordner. Dies ist beschreibender Text, der nicht formatiert werden muss und nicht überprüft wird. |
|
|
Projekt benutzerdefiniert3
|
project_custom3 | string |
Gibt zusätzliche Informationen zum Arbeitsbereich an. Dieses Feld unterscheidet sich von dem benutzerdefinierten Metadatenfeld, das Inhaltselementen zugeordnet ist, z. B. Dokumente, Arbeitsbereiche oder Ordner. Dies ist beschreibender Text, der nicht formatiert werden muss und nicht überprüft wird. |
|
|
Arbeitsbereich-Unterklasse
|
subclass | string |
Gibt die Unterklasse des Arbeitsbereichs basierend auf der Unterklasse des darin enthaltenen Dokuments an. |
Arbeitsbereichsprofil abrufen
Ruft das Arbeitsbereichsprofil und optional die Liste der zulässigen Vorgänge für den Arbeitsbereich ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Arbeitsbereichs-ID
|
workspaceId | True | string |
Gibt die ID des Arbeitsbereichs an. Beispiel: "ACTIVE_US!427". |
Benutzer durchsuchen
Sucht nach iManage Work-Benutzern, die den angegebenen Suchkriterien entsprechen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
string |
Gibt die E-Mail-ID an, nach der gesucht werden soll. Beispiel: 'JSMITH@XYZ.COM'. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anmeldung zulassen
|
data.topMatchingUser.allow_logon | boolean |
Gibt an, ob der Benutzer sich anmelden darf. |
|
Benutzerdefiniert1
|
data.topMatchingUser.custom1 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Benutzerdefiniert2
|
data.topMatchingUser.custom2 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Benutzerdefiniert3
|
data.topMatchingUser.custom3 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Verzeichniskennung
|
data.topMatchingUser.directory_id | string |
Gibt die ID aus einem externen Verzeichnis (z. B. ADFS) an, die für die Benutzerprofilsynchronisierung verwendet wird. |
|
Unterscheidungsname
|
data.topMatchingUser.distinguished_name | string |
Gibt den Namen des Objekts an, das den vollqualifizierten Pfad von Namen darstellt, der den Eintrag zurück zum Stamm der LDAP-Struktur zurückverfolgt. |
|
Datum bearbeiten
|
data.topMatchingUser.edit_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung am Benutzerprofil an. |
|
Email
|
data.topMatchingUser.email | string |
Gibt die E-Mail-ID des Benutzers an. |
|
Exchange-URL für die automatische Erkennung
|
data.topMatchingUser.exch_autodiscover | string |
Gibt die Exchange-Serverdetails des Benutzers an. |
|
Extension
|
data.topMatchingUser.extension | string |
Gibt die Telefonnummernerweiterung des Benutzers an. |
|
Fehlgeschlagene Anmeldeversuche
|
data.topMatchingUser.failed_logins | integer |
Gibt die aktuelle Anzahl der fehlgeschlagenen Anmeldeversuche des Benutzers an. |
|
Faxnummer
|
data.topMatchingUser.fax | string |
Gibt die Faxnummer des Benutzers an. |
|
Kennwortänderung erzwingen
|
data.topMatchingUser.force_password_change | boolean |
Gibt an, dass der Benutzer sein Kennwort bei der nächsten Anmeldung ändern muss. Gilt nur für virtuelle Benutzer, die durch den Wert "user_nos" "2" angegeben sind. |
|
Vollständiger Name
|
data.topMatchingUser.full_name | string |
Gibt den vollständigen Namen des Benutzers an. |
|
Allgemein
|
data.topMatchingUser.general | string |
Gibt allgemeine Informationen zum Benutzer an. |
|
ID
|
data.topMatchingUser.id | string |
Gibt die ID des Benutzers an. Beispiel: "JSMITH". |
|
Ist extern
|
data.topMatchingUser.is_external | boolean |
Gibt einen externen Benutzer an. Ein externer Benutzer hat eingeschränkten Zugriff und wird häufig für temporäre Teammitglieder, Berater oder personen außerhalb der Organisation verwendet. |
|
Zeitpunkt der letzten Synchronisierung
|
data.topMatchingUser.last_sync_ts | string |
Gibt die letzte Synchronisierungszeit (im ISO 8601-Datumstime-Format) des Benutzerprofils mit einem externen Verzeichnis an, z. B. LDAP oder Microsoft Active Directory (ADFS). |
|
Standort
|
data.topMatchingUser.location | string |
Gibt den geografischen Standort des Benutzers an. |
|
Kennwort läuft nie ab
|
data.topMatchingUser.password_never_expire | boolean |
Gibt an, ob das Kennwort des Benutzers nie abläuft. |
|
Telefonnummer
|
data.topMatchingUser.phone | string |
Gibt die Telefonnummer des Benutzers an. |
|
Bevorzugte Bibliothek
|
data.topMatchingUser.preferred_library | string |
Gibt die bevorzugte Bibliothek an. Eine bevorzugte Bibliothek ist die Standardbibliothek des Benutzers. Jeder Benutzer muss über eine bevorzugte Bibliothek verfügen. |
|
Kennwortänderungszeit
|
data.topMatchingUser.pwd_changed_ts | string |
Gibt die Uhrzeit (im ISO 8601-Datumsformat) an, zu der das Kennwort des Benutzers zuletzt geändert wurde. Dies gilt nur für virtuelle Benutzer (deren Benutzer-NOS 2 ist). |
|
SSID
|
data.topMatchingUser.ssid | string |
Gibt die eindeutige, vom System generierte ID für den Benutzer an. |
|
Domäne
|
data.topMatchingUser.user_domain | string |
Gibt den vollqualifizierten Domänennamen für den Verzeichnisdienst des Benutzers an. |
|
Erweiterte ID
|
data.topMatchingUser.user_id_ex | string |
Gibt den ursprünglichen Wert der Benutzer-ID an, die von einem externen Verzeichnis wie Microsoft Active Directory (ADFS) empfangen wird. |
|
NOS
|
data.topMatchingUser.user_nos | integer |
Gibt den Typ des Betriebssystems an, von dem der Benutzer synchronisiert wird. Mögliche Werte sind 2 (virtueller Benutzer) und 6 (Enterprise-Benutzer). Wenden Sie sich an Ihren iManage Work-Systemadministrator, um weitere Informationen zu erfahren. |
|
Number
|
data.topMatchingUser.user_num | integer |
Gibt die numerische System-ID des Benutzers an. |
|
results
|
data.results | array of UserProfileInArray |
Berechtigungen abrufen
Ruft Benutzer- oder Gruppenzugriffsberechtigungseigenschaften eines Dokuments, ordners oder Arbeitsbereichs ab. Antworteigenschaften können mit Benutzer- oder Gruppenberechtigungen variieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekttyp
|
objectType | True | string |
Gibt den Objekttyp an. |
|
Objekt-ID
|
objectId | True | string |
Gibt die ID des Dokuments, des Ordners oder des Arbeitsbereichs an. Ein Beispiel für eine Dokument-ID ist "ACTIVE_US!453.1". Ein Beispiel für eine Ordner- oder Arbeitsbereichs-ID ist "ACTIVE_US!123". |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Standardsicherheit
|
data.default_security | string |
Gibt die Standardsicherheit des Objekts an. Mögliche Werte sind "inherit", "public", "view" oder "private". |
|
Geerbte Standardsicherheit
|
data.inherited_default_security | string |
Gibt die geerbte Standardsicherheit eines Ordners an, wenn die Standardsicherheit auf "erben" festgelegt ist. Mögliche Werte sind "public", "view" oder "private". |
|
Zugriffsberechtigungen
|
data.acl | AccessPermissions |
Gibt eine Sammlung von Zugriffsberechtigungen für einen oder mehrere Benutzer und/oder Gruppen an. |
|
Alle Benutzer-IDs
|
data.all_user_ids | string |
Gibt eine Liste aller Benutzer-IDs an, verkettet als Zeichenfolge und durch Semikolons getrennt. |
|
Alle Gruppen-IDs
|
data.all_group_ids | string |
Gibt eine Liste aller Gruppen-IDs an, verkettet als Zeichenfolge und durch Semikolons getrennt. |
Berechtigungen aktualisieren
Aktualisiert berechtigungen eines Objekts.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekttyp
|
objectType | True | string |
Gibt den Objekttyp an. |
|
Objekt-ID
|
objectId | True | string |
Gibt die ID des Dokuments, des Ordners oder des Arbeitsbereichs an. Ein Beispiel für eine Dokument-ID ist "ACTIVE_US!453.1". Ein Beispiel für eine Ordner- oder Arbeitsbereichs-ID ist "ACTIVE_US!123". |
|
Zugriffsebene
|
access_level | True | string |
Gibt die Zugriffsebene an. |
|
Benutzer
|
users | string |
Gibt einen oder mehrere Benutzer an, um die Zugriffsebene festzulegen, getrennt durch ein Semikolon. |
|
|
Gruppen
|
groups | string |
Gibt eine oder mehrere Gruppen an, um die Zugriffsebene festzulegen, getrennt durch ein Semikolon. |
Gibt zurück
Dokument herunterladen
Lädt eine Version eines bestimmten Dokuments basierend auf der Dokument-ID herunter. Wenn die neueste Version zutrifft, wird die neueste Version dieses Dokuments heruntergeladen. Der Download ist ein Datenstrom und wird nicht lokal gespeichert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_USE!453.1". |
|
Neueste Version abrufen
|
latest | boolean |
Gibt an, dass die neueste Version des Dokuments heruntergeladen werden soll. |
Gibt zurück
Gibt den Inhalt der Datei an.
- Inhalt der Datei
- binary
Dokument hochladen
Lädt eine Datei als neues Dokument in den angegebenen Ordner hoch.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die ID der Zielbibliothek an. |
|
Ordner-ID
|
folderId | True | string |
Gibt die Ordner-ID des Zielordners an. Beispiel: "ACTIVE_US!987". |
|
Ordnerprofil erben
|
inherit_profile_from_folder | True | boolean |
Gibt an, ob die Profildaten vom übergeordneten Ordner geerbt werden. |
|
Sperrung beibehalten
|
keep_locked | boolean |
Gibt an, ob eine Dokumentsperre nach dem Upload beibehalten wird. |
|
|
Kommentar
|
comment | string |
Gibt zusätzliche Informationen zum Update an. |
|
|
Autor
|
author | string |
Gibt die iManage-Arbeits-ID des Benutzers an, der das Dokument erstellt hat. |
|
|
Bediener
|
operator | string |
Gibt die ID des Benutzers an, der das Dokument ausgecheckt hat oder derzeit das Profil des Dokuments bearbeitet. Beispiel: "JSMITH". |
|
|
Class
|
class | string |
Gibt die Klasse zum Identifizieren und Unterscheiden des Dokuments an. Die Dokumentklasse wird nach Genre, Abteilung, Region usw. kategorisiert. |
|
|
Unterklasse
|
subclass | string |
Gibt die Unterklasse zum Identifizieren und Unterscheiden des Dokuments an. Dokumentunterklassen werden nach Genre, Abteilung, Region usw. kategorisiert. |
|
|
Standardsicherheit
|
default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. Mögliche Werte sind "inherit", "private", "view", "public". |
|
|
Ist HIPAA
|
is_hipaa | boolean |
Gibt an, ob das Dokument verschlüsselt werden soll. |
|
|
Tage aufbewahren
|
retain_days | integer |
Gibt die Anzahl der Tage an, die ein Dokument inaktiv sein muss, bevor es für die Archivierung markiert wird. |
|
|
Dateiinhalte
|
file | True | file |
Gibt den Inhalt der Datei an. |
|
Erstellungsdatum der Datei
|
file_create_date | date-time |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das die Datei erstellt wurde. Die Datei könnte außerhalb des iManage Work-Systems erstellt worden sein. Dieses Datum kann sich von "create_date" unterscheiden. Die create_date ist das Datum, an dem die Datei vom iManage Work-System erstellt oder importiert wurde. |
|
|
Datum der Dateibearbeitung
|
file_edit_date | date-time |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung an der Datei an. Die Datei konnte vor dem Hochladen in das iManage Work-System geändert worden sein. |
|
|
Benutzerdefiniert1
|
custom1 | string |
Gibt den Wert für custom1 an. |
|
|
Benutzerdefiniert2
|
custom2 | string |
Gibt den Wert für custom2 an. Um einen Wert für custom2 anzugeben, müssen Sie auch einen Wert für "custom1" in derselben Anforderung angeben, der auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
|
|
Benutzerdefiniert3
|
custom3 | string |
Gibt den Wert für custom3 an. |
|
|
Benutzerdefiniert4
|
custom4 | string |
Gibt den Wert für custom4 an. |
|
|
Benutzerdefiniert5
|
custom5 | string |
Gibt den Wert für custom5 an. |
|
|
Benutzerdefiniert6
|
custom6 | string |
Gibt den Wert für custom6 an. |
|
|
Benutzerdefiniert7
|
custom7 | string |
Gibt den Wert für custom7 an. |
|
|
Benutzerdefiniert8
|
custom8 | string |
Gibt den Wert für custom8 an. |
|
|
Benutzerdefiniert9
|
custom9 | string |
Gibt den Wert für custom9 an. |
|
|
Benutzerdefiniert10
|
custom10 | string |
Gibt den Wert für custom10 an. |
|
|
Benutzerdefiniert1
|
custom11 | string |
Gibt den Wert für custom11 an. |
|
|
Benutzerdefiniert12
|
custom12 | string |
Gibt den Wert für custom12 an. |
|
|
Benutzerdefiniert13
|
custom13 | string |
Gibt den Wert für custom13 an. |
|
|
Benutzerdefiniert14
|
custom14 | string |
Gibt den Wert für custom14 an. |
|
|
Benutzerdefiniert15
|
custom15 | string |
Gibt den Wert für custom15 an. |
|
|
Benutzerdefiniert16
|
custom16 | string |
Gibt den Wert für custom16 an. |
|
|
Benutzerdefiniert17
|
custom17 | double |
Gibt den Wert für custom17 an. |
|
|
Benutzerdefiniert18
|
custom18 | double |
Gibt den Wert für custom18 an. |
|
|
Benutzerdefiniert19
|
custom19 | double |
Gibt den Wert für custom19 an. |
|
|
Benutzerdefiniert20
|
custom20 | double |
Gibt den Wert für custom20 an. |
|
|
Custom21
|
custom21 | string |
Gibt den Wert für custom21 im ISO 8601-Datumstime-Format an. |
|
|
Custom22
|
custom22 | string |
Gibt den Wert für custom22 im ISO 8601-Datumstime-Format an. |
|
|
Custom23
|
custom23 | string |
Gibt den Wert für custom23 im ISO 8601-Datumstime-Format an. |
|
|
Custom24
|
custom24 | string |
Gibt den Wert für custom24 im ISO 8601-Datumstime-Format an. |
|
|
Custom25
|
custom25 | boolean |
Gibt den Wert für custom25 an. |
|
|
Custom26
|
custom26 | boolean |
Gibt den Wert für custom26 an. |
|
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt den Wert für custom27 an. |
|
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt den Wert für custom28 an. |
|
|
Benutzerdefiniert29
|
custom29 | string |
Gibt den Wert für custom29 an. |
|
|
Custom30
|
custom30 | string |
Gibt den Wert für custom30 an. Um einen Wert für custom30 anzugeben, müssen Sie auch einen Wert für custom29 in derselben Anforderung angeben, was auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
Dokument kopieren
Kopiert ein Dokument in den angegebenen Ordner.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Zielordner-ID
|
folderId | True | string |
Gibt die Zielordner-ID an, in die das Dokument kopiert werden soll. Beispiel: "ACTIVE_US!987". |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumentzugriff
|
data.access | string |
Gibt den Berechtigungssatz der Zugriffsstufe für ein Dokument oder einen Container an. Die Zugriffsebene wird vom Autor oder einem Benutzer mit vollem Zugriff auf das Element festgelegt. Mögliche Werte sind "no_access", "read", "read_write", "full_access". |
|
Alias
|
data.alias | string |
Gibt den Alias dieses Dokuments an. |
|
Autor
|
data.author | string |
Gibt die ID des Benutzers an, der das Dokument erstellt hat. Beispiel: "JSMITH". |
|
Beschreibung des Autors
|
data.author_description | string |
Gibt weitere Informationen zum Autor des Dokuments an. |
|
Cc
|
data.cc | string |
Gibt Empfänger an, in die die E-Mail kopiert wird. Gilt nur für E-Mails. |
|
Dokumentklasse
|
data.class | string |
Gibt die Klasse des Dokuments an. |
|
Dokumentklassenbeschreibung
|
data.class_description | string |
Gibt zusätzliche Informationen zur Dokumentklasse an. |
|
Inhaltstyp
|
data.content_type | string |
Gibt den Dokumentinhaltstyp an. |
|
Erstellungsdatum des Dokuments
|
data.create_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das das Dokument in das iManage Work-System importiert wurde. Dieses Datum kann sich von "file_create_date" unterscheiden. |
|
Datenbank
|
data.database | string |
Gibt die Bibliothek an, in der das Dokument gespeichert ist. |
|
Dokumentstandardsicherheit
|
data.default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. Mögliche Werte sind "inherit", "private", "view", "public". |
|
Dokumentnummer
|
data.document_number | integer |
Gibt die Dokumentnummer eines Dokuments an. |
|
Dokument-URL
|
data.document_url | string |
Gibt den freigabefähigen Link für das Dokument an. |
|
Datum der Dokumentbearbeitung
|
data.edit_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung an dem Dokument an. |
|
Profilbearbeitungsdatum
|
data.edit_profile_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung am Dokumentprofil an. |
|
Dokumenterweiterung
|
data.extension | string |
Gibt die Dateinamenerweiterung an, die auch als Anwendungserweiterung bezeichnet wird, des Dokuments. |
|
Erstellungsdatum der Datei
|
data.file_create_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das die Datei erstellt wurde. Die Datei wurde möglicherweise außerhalb des iManage Work-Systems erstellt. Dieses Datum kann sich von "create_date" unterscheiden. |
|
Datum der Dateibearbeitung
|
data.file_edit_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung an der Datei an. Die Datei wurde möglicherweise geändert, bevor sie in das iManage Work-System hochgeladen wird. |
|
Von
|
data.from | string |
Gibt den Absender der E-Mail an. Gilt nur für E-Mails. |
|
Vollständiger Dateiname
|
data.full_file_name | string |
Gibt den vollständigen Dateinamen des Dokuments an. Enthält die Dateinamenerweiterung. |
|
Hat Anlage
|
data.has_attachment | boolean |
Gibt an, ob E-Mails Anlagen enthalten. Gilt nur für E-Mails. |
|
Grundlegende Dokumenteigenschaften
|
data.basic_properties | string |
Gibt ein einbettbares '' Element an, das grundlegende Dokumenteigenschaften enthält. |
|
Dokument-ID
|
data.id | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Ist indiziert
|
data.indexable | boolean |
Gibt an, ob das Dokument vom System indiziert wird. |
|
Ist ausgecheckt
|
data.is_checked_out | boolean |
Gibt an, ob das Dokument ausgecheckt ist. |
|
Wird deklariert
|
data.is_declared | boolean |
Gibt an, ob das Dokument als Datensatz deklariert wird. Ein Dokument, das als Datensatz deklariert ist, kann nicht bearbeitet oder gelöscht werden, außer von einem iManage Work-Systemadministrator. |
|
Ist extern
|
data.is_external | boolean |
Gibt an, ob das Dokument für externe Benutzer freigegeben wird. |
|
Ist extern als normal
|
data.is_external_as_normal | boolean |
Gibt an, ob das Dokument normal extern ist. |
|
Ist HIPAA
|
data.is_hipaa | boolean |
Gibt an, ob das Dokument verschlüsselt ist. |
|
Ist in Gebrauch
|
data.is_in_use | boolean |
Gibt an, ob das Dokument verwendet wird. |
|
Dokumentlink
|
data.iwl | string |
Gibt die iManage Work Link (iWL) für das Dokument an. Die iWL wird verwendet, um das Dokument im geschützten Ansichtsmodus von dem Benutzer zu öffnen, der über "read_write" oder "full_access" verfügt. |
|
Letzter Benutzer
|
data.last_user | string |
Gibt die ID des Benutzers an, der das Dokument zuletzt bearbeitet hat. Beispiel: "JSMITH". |
|
Letzte Benutzerbeschreibung
|
data.last_user_description | string |
Gibt zusätzliche Informationen zum letzten Benutzer an, der das Dokument zuletzt bearbeitet hat. |
|
Dokumentname
|
data.name | string |
Gibt den Dateinamen des Dokuments an. |
|
Bediener
|
data.operator | string |
Gibt die ID des Benutzers an, der das Dokument ausgecheckt hat oder aktuell sein Profil bearbeitet. Beispiel: "JSMITH". |
|
Operatorbeschreibung
|
data.operator_description | string |
Gibt zusätzliche Informationen zum Operator an. |
|
Empfangsdatum
|
data.received_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das die E-Mail empfangen wurde. Gilt nur für E-Mails. |
|
Tage aufbewahren
|
data.retain_days | integer |
Gibt die Anzahl der Tage an, bevor das Dokument zur Archivierung berechtigt ist. Gilt nur für inaktive Dokumente. |
|
Sendedatum
|
data.sent_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das die E-Mail gesendet wurde. Gilt nur für E-Mails. |
|
Dokumentgröße
|
data.size | integer |
Gibt die Größe des Dokuments in Byte an. |
|
Unterklasse
|
data.subclass | string |
Gibt die Unterklasse des Dokuments an. |
|
Beschreibung der Unterklasse
|
data.subclass_description | string |
Gibt zusätzliche Informationen zur Unterklasse des Dokuments an. |
|
Bis
|
data.to | string |
Gibt den Empfänger der E-Mail an. Gilt nur für E-Mails. |
|
Typ
|
data.type | string |
Gibt den Dokumenttyp an. Beispiel: WORD für Microsoft Word. Wenden Sie sich für eine aktuelle Liste der Typen an Ihren iManage Work-Systemadministrator. |
|
Typbeschreibung
|
data.type_description | string |
Gibt zusätzliche Informationen zum Dokumenttyp an. |
|
Dokumentversion
|
data.version | integer |
Gibt die Versionsnummer des Dokuments an. |
|
Arbeitsbereichs-ID
|
data.workspace_id | string |
Gibt die ID des Arbeitsbereichs des Dokuments an. Beispiel: "ACTIVE_US!427". |
|
Arbeitsbereichname
|
data.workspace_name | string |
Gibt den Namen des Arbeitsbereichs des Dokuments an. |
|
Wstype
|
data.wstype | string |
Gibt den iManage Work-Typ des Objekts an. Mögliche Werte sind "document", "folder", "workspace", "email", "document_shortcut", "folder_shortcut", "workspace_shortcut", "user". |
|
Benutzerdefiniert13
|
data.custom13 | string |
Gibt den Wert von custom13 an. |
|
Benutzerdefiniert14
|
data.custom14 | string |
Gibt den Wert von custom14 an. |
|
Benutzerdefiniert15
|
data.custom15 | string |
Gibt den Wert von custom15 an. |
|
Benutzerdefiniert16
|
data.custom16 | string |
Gibt den Wert von custom16 an. |
|
Custom21
|
data.custom21 | string |
Gibt den Wert der custom21-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
Custom22
|
data.custom22 | string |
Gibt den Wert der custom22-Eigenschaft im ISO 8601-Datumstime-Format an. |
Dokument löschen
Löscht das angegebene Dokument.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Alle Versionen löschen
|
deleteAllVersions | True | boolean |
Gibt an, dass alle Versionen des Dokuments gelöscht werden. |
Dokument verschieben
Verschiebt ein Dokument in den angegebenen Ordner.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Übergeordneter Ordner-ID
|
folderId | True | string |
Gibt die Ordner-ID des übergeordneten Ordners an. Beispiel: "ACTIVE_US!987". |
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Zielordner-ID
|
destination_folder_id | True | string |
Gibt die Zielordner-ID an, in die das Dokument verschoben werden soll. Beispiel: "ACTIVE_US!987". |
|
Zielprofil anwenden
|
update_profile | boolean |
Gibt an, ob das Dokumentprofil mit dem Zielordnerprofil aktualisiert werden soll. |
|
|
Zielsicherheit anwenden
|
update_security | boolean |
Gibt an, ob die Dokumentsicherheit mit der Zielordnersicherheit aktualisiert werden soll. Dieser Parameter gilt nur, wenn "Update Profile" auf "true" festgelegt ist. |
|
|
Zeitachsenkommentare
|
comments | string |
Gibt zusätzliche Informationen zum Vorgang an. Diese Kommentare sind in der Zeitachse des Dokuments sichtbar. |
Dokumentbeziehung erstellen
Erstellt eine Beziehung zwischen angegebenen Dokumenten in einer Bibliothek.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Primäre Dokument-ID
|
primaryDocumentId | True | string |
Gibt die ID des primären Dokuments an, das in Beziehung stehen soll. Beispiel: "ACTIVE_US!453.1". |
|
Zugehörige Dokument-ID
|
relatedDocumentId | True | string |
Gibt die ID des zu verknüpfenden Dokuments an. Beispiel: "ACTIVE_US!453.1". |
Gibt zurück
- response
- object
Dokumentbeziehung löschen
Löscht eine Beziehung zwischen angegebenen Dokumenten in einer Bibliothek.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Primäre Dokument-ID
|
primaryDocumentId | True | string |
Gibt die ID des primären Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Zugehörige Dokument-ID
|
relatedDocumentId | True | string |
Gibt die ID des verknüpften Dokuments an. Beispiel: "ACTIVE_US!453.1". |
Gibt zurück
- response
- object
Dokumentprofil abrufen
Ruft die Dokumenteigenschaften ab, die einer bestimmten Dokument-ID zugeordnet sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Neueste Version abrufen
|
latest | boolean |
Gibt an, dass die neueste Version des Dokuments abgerufen wird. |
Dokumentprofil aktualisieren
Führt Aktualisierungen für das Dokumentprofil aus. Ein Dokument darf nicht verwendet werden, während es sein Profil aktualisiert, und das Profil eines ausgecheckten Dokuments kann nicht aktualisiert werden. Gibt nach dem Vorgang ein aktualisiertes Dokumentprofil zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Alias
|
alias | string |
Gibt den Alias dieses Dokuments an. |
|
|
Autor
|
author | string |
Gibt die ID des Benutzers an, der das Dokument erstellt hat. Beispiel: "JSMITH". |
|
|
Kommentar
|
comment | string |
Gibt zusätzliche Informationen zum Dokument an. |
|
|
Dokumentstandardsicherheit
|
default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. |
|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Wird deklariert
|
is_declared | boolean |
Gibt an, ob das Dokument als Datensatz deklariert werden soll. Ein Dokument, das als Datensatz deklariert ist, kann nicht bearbeitet oder gelöscht werden, außer von einem iManage Work-Systemadministrator. |
|
|
Ist HIPAA
|
is_hipaa | boolean |
Gibt an, ob das Dokument verschlüsselt werden soll. |
|
|
Überwachungskommentar
|
audit_comment | string |
Gibt zusätzliche Informationen zur Dokumentprofilaktualisierung an. |
|
|
Dokumentklasse
|
class | string |
Gibt die Dokumentklasse an. |
|
|
Dokumentname
|
name | string |
Gibt den Dateinamen des Dokuments an. |
|
|
Bediener
|
operator | string |
Gibt die ID des Benutzers an, dass das Dokument ausgecheckt ist oder das Dokument zurzeit das Profil des Dokuments bearbeitet. Beispiel: "JSMITH". |
|
|
Tage aufbewahren
|
retain_days | integer |
Gibt die Anzahl von Tagen an, bevor das inaktive Dokument zur Archivierung berechtigt ist. |
|
|
Unterklasse
|
subclass | string |
Gibt die Unterklasse des Dokuments an. |
|
|
Benutzerdefiniert1
|
custom1 | string |
Gibt den Wert von custom1 an. |
|
|
Benutzerdefiniert2
|
custom2 | string |
Gibt den Wert von custom2 an. Um einen Wert für custom2 anzugeben, müssen Sie auch einen Wert für "custom1" in derselben Anforderung angeben, der auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
|
|
Benutzerdefiniert3
|
custom3 | string |
Gibt den Wert von custom3 an. |
|
|
Benutzerdefiniert4
|
custom4 | string |
Gibt den Wert von custom4 an. |
|
|
Benutzerdefiniert5
|
custom5 | string |
Gibt den Wert von custom5 an. |
|
|
Benutzerdefiniert6
|
custom6 | string |
Gibt den Wert von custom6 an. |
|
|
Benutzerdefiniert7
|
custom7 | string |
Gibt den Wert von custom7 an. |
|
|
Benutzerdefiniert8
|
custom8 | string |
Gibt den Wert von custom8 an. |
|
|
Benutzerdefiniert9
|
custom9 | string |
Gibt den Wert von custom9 an. |
|
|
Benutzerdefiniert10
|
custom10 | string |
Gibt den Wert von custom10 an. |
|
|
Benutzerdefiniert1
|
custom11 | string |
Gibt den Wert von custom11 an. |
|
|
Benutzerdefiniert12
|
custom12 | string |
Gibt den Wert von custom12 an. |
|
|
Benutzerdefiniert13
|
custom13 | string |
Gibt den Wert von custom13 an. |
|
|
Benutzerdefiniert14
|
custom14 | string |
Gibt den Wert von custom14 an. |
|
|
Benutzerdefiniert15
|
custom15 | string |
Gibt den Wert von custom15 an. |
|
|
Benutzerdefiniert16
|
custom16 | string |
Gibt den Wert von custom16 an. |
|
|
Benutzerdefiniert17
|
custom17 | double |
Gibt den Wert von custom17 an. |
|
|
Benutzerdefiniert18
|
custom18 | double |
Gibt den Wert von custom18 an. |
|
|
Benutzerdefiniert19
|
custom19 | double |
Gibt den Wert von custom19 an. |
|
|
Benutzerdefiniert20
|
custom20 | double |
Gibt den Wert von custom20 an. |
|
|
Custom21
|
custom21 | string |
Gibt den Wert der custom21-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
|
Custom22
|
custom22 | string |
Gibt den Wert der custom22-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
|
Custom23
|
custom23 | string |
Gibt den Wert der custom23-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
|
Custom24
|
custom24 | string |
Gibt den Wert der custom24-Eigenschaft im ISO 8601-Datetime-Format an. |
|
|
Custom25
|
custom25 | boolean |
Gibt den Wert von custom25 an. |
|
|
Custom26
|
custom26 | boolean |
Gibt den Wert von custom26 an. |
|
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt den Wert von custom27 an. |
|
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt den Wert von custom28 an. |
|
|
Benutzerdefiniert29
|
custom29 | string |
Gibt den Wert von custom29 an. |
|
|
Custom30
|
custom30 | string |
Gibt den Wert von custom30 an. Um einen Wert für custom30 anzugeben, müssen Sie auch einen Wert für custom29 in derselben Anforderung angeben, was auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
Dokumentreferenz löschen
Löscht den Dokumentverweis aus dem angegebenen Ordner.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Ordner-ID
|
folderId | True | string |
Gibt die ID des Ordners an. Beispiel: "ACTIVE_US!773". |
Gibt zurück
- response
- object
Dokumentverweis hinzufügen
Fügt Dokumentverweis oder Dokumentverknüpfung in einem anderen Ordner hinzu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Ordner-ID
|
folderId | True | string |
Gibt die ID des Ordners an. Beispiel: "ACTIVE_US!773". |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumentreferenz-ID
|
data.id | string |
Gibt Dokumentreferenz und document_shortcut an. |
|
Wstype
|
data.wstype | string |
Gibt den iManage Work-Typ des Objekts an. Mögliche Werte sind "document", "document_shortcut", "email". |
Festlegen von grundlegenden erweiterten Metadateneigenschaften für ein Dokument
Legt die wichtigsten erweiterten Metadateneigenschaften für ein Dokument fest.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Name
|
key | True | string |
Gibt den Namen der erweiterten Kernmetadateneigenschaft an. |
|
Wert
|
value | True | string |
Gibt einen oder mehrere Werte an, die für die erweiterte Kernmetadateneigenschaft festgelegt werden sollen, getrennt durch Semikolons. Wenn Sie den Wert aufheben möchten, legen Sie den Wert des Schlüssels auf eine leere Zeichenfolge fest, die in einfache oder doppelte Anführungszeichen eingeschlossen ist. |
Gruppenmitglieder abrufen
Rufen Sie Details von Benutzern ab, die zur angegebenen Gruppe gehören, und entsprechen Sie den angegebenen Kriterien.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die Bibliotheks-ID der Zielgruppe an. |
|
Gruppen-ID
|
groupId | True | string |
Gibt die ID der Gruppe an. Beispiel: "MARKETING". |
|
Anmeldestatus
|
logon_status | string |
Gibt einen Filter für Benutzer basierend auf dem aktuellen Wert der Eigenschaft "allow_logon" für jeden Benutzer an. |
|
|
Limit
|
limit | integer |
Gibt die maximale Anzahl von Mitgliedern an, die unabhängig von der Gesamtanzahl der Mitglieder in der Gruppe zurückgegeben werden sollen. |
|
|
Bevorzugte Bibliothek
|
preferred_library | string |
Gibt an, dass nur Benutzer, deren bevorzugte Bibliothek mit dem angegebenen Wert übereinstimmt, zurückgegeben werden. |
|
|
Standort
|
location | string |
Gibt den Standort an, der verwendet werden soll, um Benutzer basierend auf ihrem geografischen Standort zu finden. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) wird nicht unterstützt. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Daten
|
data | array of UserProfileInArray |
Gibt die Liste der Benutzer an, die zur angegebenen Gruppe gehören und den angegebenen Kriterien entsprechen. |
Hinzufügen eines Dokumentverlaufseintrags
Fügt einen Eintrag als Ereignis im Verlauf des Dokuments hinzu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Activity
|
activity_code | True | integer |
Gibt den Typ der Aktivität an, die für das Dokument ausgeführt wurde. |
|
Kommentare
|
comments | string |
Gibt alle zusätzlichen Informationen zur Aktivität an. |
|
|
Dauer
|
duration | integer |
Gibt die Anzahl der Sekunden an, die der Benutzer für die Arbeit am Dokument aufgewendet hat. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Daten
|
data | object |
Höherstufen der Dokumentversion
Höher stuft eine vorhandene Version eines Dokuments auf die neueste Version. Eine neue Version wird aus einer angegebenen Journal-ID oder -Version erstellt und dann auf neueste Höhergestuft. Sie müssen entweder journal-ID oder Version angeben, aber nicht beides.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Version
|
version | integer |
Gibt die Versionsnummer an, die als Grundlage für die neue höhergestufte Version verwendet werden soll. |
|
|
Journal-ID
|
journalId | string |
Gibt die Journal-ID an, die als Grundlage für die neue höhergestufte Version verwendet werden soll. |
|
|
Kommentar
|
comment | string |
Gibt zusätzliche Informationen zum Dokument an. |
|
|
Alias
|
alias | string |
Gibt den Alias dieses Dokuments an. |
|
|
Autor
|
author | string |
Gibt die ID des Benutzers an, der das Dokument erstellt hat. Beispiel: "JSMITH". |
|
|
Dokumentklasse
|
class | string |
Gibt die Dokumentklasse an. |
|
|
Dokumentstandardsicherheit
|
default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. |
|
|
Wird deklariert
|
is_declared | boolean |
Gibt an, ob die neue Version des Dokuments als Datensatz deklariert werden soll. Ein Dokument, das als Datensatz deklariert ist, kann nicht bearbeitet oder gelöscht werden, außer von einem iManage Work-Systemadministrator. |
|
|
Ist HIPAA
|
is_hipaa | boolean |
Gibt an, ob die neue Version des Dokuments verschlüsselt werden soll. |
|
|
Dokumentname
|
name | string |
Gibt den Dateinamen des Dokuments an. |
|
|
Bediener
|
operator | string |
Gibt die ID des Benutzers an, der das Dokument ausgecheckt hat oder derzeit das Profil des Dokuments bearbeitet. Beispiel: "JSMITH". |
|
|
Tage aufbewahren
|
retain_days | integer |
Gibt die Anzahl von Tagen an, bevor das inaktive Dokument zur Archivierung berechtigt ist. |
|
|
Unterklasse
|
subclass | string |
Gibt die Unterklasse des Dokuments an. |
|
|
Benutzerdefiniert1
|
custom1 | string |
Gibt den Wert von custom1 an. |
|
|
Benutzerdefiniert2
|
custom2 | string |
Gibt den Wert von custom2 an. Um einen Wert für custom2 anzugeben, müssen Sie auch einen Wert für "custom1" in derselben Anforderung angeben, der auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
|
|
Benutzerdefiniert3
|
custom3 | string |
Gibt den Wert von custom3 an. |
|
|
Benutzerdefiniert4
|
custom4 | string |
Gibt den Wert von custom4 an. |
|
|
Benutzerdefiniert5
|
custom5 | string |
Gibt den Wert von custom5 an. |
|
|
Benutzerdefiniert6
|
custom6 | string |
Gibt den Wert von custom6 an. |
|
|
Benutzerdefiniert7
|
custom7 | string |
Gibt den Wert von custom7 an. |
|
|
Benutzerdefiniert8
|
custom8 | string |
Gibt den Wert von custom8 an. |
|
|
Benutzerdefiniert9
|
custom9 | string |
Gibt den Wert von custom9 an. |
|
|
Benutzerdefiniert10
|
custom10 | string |
Gibt den Wert von custom10 an. |
|
|
Benutzerdefiniert1
|
custom11 | string |
Gibt den Wert von custom11 an. |
|
|
Benutzerdefiniert12
|
custom12 | string |
Gibt den Wert von custom12 an. |
|
|
Benutzerdefiniert13
|
custom13 | string |
Gibt den Wert von custom13 an. |
|
|
Benutzerdefiniert14
|
custom14 | string |
Gibt den Wert von custom14 an. |
|
|
Benutzerdefiniert15
|
custom15 | string |
Gibt den Wert von custom15 an. |
|
|
Benutzerdefiniert16
|
custom16 | string |
Gibt den Wert von custom16 an. |
|
|
Benutzerdefiniert17
|
custom17 | double |
Gibt den Wert von custom17 an. |
|
|
Benutzerdefiniert18
|
custom18 | double |
Gibt den Wert von custom18 an. |
|
|
Benutzerdefiniert19
|
custom19 | double |
Gibt den Wert von custom19 an. |
|
|
Benutzerdefiniert20
|
custom20 | double |
Gibt den Wert von custom20 an. |
|
|
Custom21
|
custom21 | string |
Gibt den Wert der custom21-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
|
Custom22
|
custom22 | string |
Gibt den Wert der custom22-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
|
Custom23
|
custom23 | string |
Gibt den Wert der custom23-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
|
Custom24
|
custom24 | string |
Gibt den Wert der custom24-Eigenschaft im ISO 8601-Datetime-Format an. |
|
|
Custom25
|
custom25 | boolean |
Gibt den Wert von custom25 an. |
|
|
Custom26
|
custom26 | boolean |
Gibt den Wert von custom26 an. |
|
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt den Wert von custom27 an. |
|
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt den Wert von custom28 an. |
|
|
Benutzerdefiniert29
|
custom29 | string |
Gibt den Wert von custom29 an. |
|
|
Custom30
|
custom30 | string |
Gibt den Wert von custom30 an. Um einen Wert für custom30 anzugeben, müssen Sie auch einen Wert für custom29 in derselben Anforderung angeben, was auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
Kopieren von Berechtigungen
Kopiert die Zugriffsberechtigungen und optional die Standardsicherheit von einem iManage Work -Objekt in ein anderes. "Kopiertyp" bietet Ihnen Optionen zum Behandeln der Kombination aus Quell- und Zielberechtigungen. "Überschreiben" aktualisiert die Benutzer, Gruppen und Berechtigungsstufen des Zielobjekts so, dass sie exakt mit den Quellobjekten übereinstimmen. "Zusammenführen" behält alle Benutzer und Gruppen auf dem Zielobjekt bei und kombiniert sie mit der Quelle, aber im Falle eines Konflikts der Berechtigungsstufe für eine Einzelperson oder Gruppe: "Zusammenführen (Pessimistisch)" verwendet die niedrigere Berechtigung, während "Zusammenführen (Optimistisch)" die höhere Berechtigung für den widersprüchlichen Benutzer oder die Gruppe akzeptiert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Quellobjekttyp
|
sourceObjectType | True | string |
Gibt den Typ des Quellobjekts an. |
|
Quellobjekt-ID
|
sourceObjectId | True | string |
Gibt die ID des Objekts an, aus dem die Berechtigungen kopiert werden. Ein Beispiel für eine Dokument-ID ist "ACTIVE_US!453.1". Ein Beispiel für eine Ordner- oder Arbeitsbereichs-ID ist "ACTIVE_US!123". |
|
Zielobjekttyp
|
targetObjectType | True | string |
Gibt den Typ des Zielobjekts an. |
|
Zielobjekt-ID
|
targetObjectId | True | string |
Gibt die ID des Objekts an, in das die Berechtigungen kopiert werden. Ein Beispiel für eine Dokument-ID ist "ACTIVE_US!453.1". Ein Beispiel für eine Ordner- oder Arbeitsbereichs-ID ist "ACTIVE_US!123". |
|
Kopiertyp
|
copyType | True | string |
Gibt an, die Quellobjektberechtigungen mit Zielobjektberechtigungen zusammenzuführen oder Zielobjektberechtigungen mit Quellberechtigungen zu überschreiben. Ausführliche Informationen finden Sie in der Aktionsbeschreibung. |
|
Standardsicherheit kopieren
|
copyDefaultSecurity | True | boolean |
Gibt an, die Standardsicherheit des Quellobjekts in das Zielobjekt zu kopieren. Wenn die Standardsicherheit des Quellobjekts "inherit" lautet, wird die geerbte Standardsicherheit von der Quelle in das Zielobjekt kopiert. |
Gibt zurück
Nach Arbeitsbereichen suchen
Suchen Sie nach Arbeitsbereichen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die Bibliotheks-ID des Zielarbeitsbereichs an. |
|
Title
|
name | string |
Gibt die Zeichenfolge an, nach der in der Namenseigenschaft des Arbeitsbereichs gesucht werden soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. |
|
|
Besitzer
|
owner | string |
Gibt die Zeichenfolge an, die mit dem dem Arbeitsbereich verknüpften Besitzer übereinstimmt. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. |
|
|
Keyword
|
anywhere | string |
Gibt den Text an, der an einer beliebigen Stelle im Arbeitsbereichsprofil gesucht werden soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. |
|
|
Description
|
description | string |
Gibt den Text an, nach dem in der Beschreibungseigenschaft des Arbeitsbereichs gesucht werden soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. |
|
|
Unterklasse
|
subclass | string |
Gibt einen Wert an, der mit dem Dem Arbeitsbereich zugeordneten Unterklassenwert übereinstimmt. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. |
|
|
Benutzerdefiniert1
|
custom1 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten Wert übereinstimmen soll, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert2
|
custom2 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten2-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert3
|
custom3 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 3-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert4
|
custom4 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten4-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert5
|
custom5 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten5-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert6
|
custom6 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten6-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert7
|
custom7 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten7-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert8
|
custom8 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten8-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert9
|
custom9 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten Wert übereinstimmen soll, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert10
|
custom10 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 10-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert1
|
custom11 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten11-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert12
|
custom12 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 12-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert13
|
custom13 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 13-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden unterstützt. |
|
|
Benutzerdefiniert14
|
custom14 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 14-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden unterstützt. |
|
|
Benutzerdefiniert15
|
custom15 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 15-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden unterstützt. |
|
|
Benutzerdefiniert16
|
custom16 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 16-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden unterstützt. |
|
|
Benutzerdefiniert17
|
custom17 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 17-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert18
|
custom18 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 18-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert19
|
custom19 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 19-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Benutzerdefiniert20
|
custom20 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten 20-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Custom21 (Lower Limit)
|
custom21_from | string |
Gibt die untere Grenze (im ISO 8601-Datumstime-Format) an, nach der in der benutzerdefinierten21-Eigenschaft gesucht werden soll, die dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom21 (Obergrenze)
|
custom21_to | string |
Gibt die obere Grenze (im ISO 8601-Datumstime-Format) an, nach der in der benutzerdefinierten21-Eigenschaft gesucht werden soll, die dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom22 (Lower Limit)
|
custom22_from | string |
Gibt die untere Grenze (im ISO 8601-Datumstime-Format) an, nach der in der benutzerdefinierten22-Eigenschaft gesucht werden soll, die dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom22 (Obergrenze)
|
custom22_to | string |
Gibt die Obergrenze (im ISO 8601-Datumstime-Format) an, nach der in der benutzerdefinierten22-Eigenschaft gesucht werden soll, die dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom23 (Lower Limit)
|
custom23_from | string |
Gibt die untere Grenze (im ISO 8601-Datumstime-Format) an, nach der in der benutzerdefinierten23-Eigenschaft gesucht werden soll, die dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom23 (Obergrenze)
|
custom23_to | string |
Gibt die Obergrenze (im ISO 8601-Datumstime-Format) an, nach der in der benutzerdefinierten23-Eigenschaft gesucht werden soll, die dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom24 (Lower Limit)
|
custom24_from | string |
Gibt die untere Grenze (im ISO 8601-Datumstime-Format) an, nach der in der benutzerdefinierten24-Eigenschaft gesucht werden soll, die dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom24 (Obergrenze)
|
custom24_to | string |
Gibt die Obergrenze (im ISO 8601-Datumstime-Format) an, nach der in der benutzerdefinierten24-Eigenschaft gesucht werden soll, die dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Für Arbeitsbereiche wird die Verwendung dieser Eigenschaft für Ihre iManage Work-Installation angepasst. |
|
|
Custom25
|
custom25 | boolean |
Gibt einen Wert an, der mit dem benutzerdefinierten25-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. |
|
|
Custom26
|
custom26 | boolean |
Gibt einen Wert an, der mit dem benutzerdefinierten26-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. |
|
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt einen Wert an, der mit dem benutzerdefinierten27-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. |
|
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt einen Wert an, der mit dem benutzerdefinierten 28-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. |
|
|
Benutzerdefiniert29
|
custom29 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten29-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Custom30
|
custom30 | string |
Gibt einen Wert an, der mit dem benutzerdefinierten30-Wert übereinstimmt, der dem Arbeitsbereich zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Das Platzhalterzeichen (*) und partielle Übereinstimmungen werden nicht unterstützt. Um einen Wert für custom30 anzugeben, müssen Sie auch einen Wert für custom29 in derselben Anforderung angeben, was auf die Beziehung zwischen übergeordneten und untergeordneten Elementen zurückzuführen ist. |
Nach Ordnern suchen
Suchen Sie nach Ordnern.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die Bibliotheks-ID des Zielordners an. |
|
Container-ID
|
container_id | string |
Gibt die ID des Arbeitsbereichs oder Ordners an, aus dem Ordner zurückgegeben werden sollen. Beispiel: "ACTIVE_US!987". Wenn dieser Parameter bereitgestellt wird, werden Ordner nur aus dem angegebenen Arbeitsbereich oder Ordner zurückgegeben. |
|
|
Ordnerbeschreibung
|
description | string |
Gibt einen Wert an, der in der Beschreibungseigenschaft des Ordners gefunden werden soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Partielle Übereinstimmungen werden unterstützt. |
|
|
E-Mail-Adresse des Ordners
|
string |
Gibt die E-Mail-Adresse an, die mit der E-Mail-Adresse des Ordners übereinstimmen soll. Beispiel: 'email1234@ajubalaw.com'. |
||
|
Ordnername
|
name | string |
Gibt einen Wert an, der in der Namenseigenschaft des Ordners gefunden werden soll. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Partielle Übereinstimmungen werden unterstützt. |
|
|
Ordnerbesitzer
|
owner | string |
Gibt die Zeichenfolge an, die mit dem besitzer übereinstimmt, der dem Ordner zugeordnet ist. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Partielle Übereinstimmungen werden unterstützt. |
|
|
Arbeitsbereichname
|
workspace_name | string |
Gibt den Namen des übergeordneten Arbeitsbereichs an, zu dem der Ordner gehört. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Partielle Übereinstimmungen werden unterstützt. |
Namen-Wert-Paare bearbeiten
Erstellt, aktualisiert oder löscht die Eigenschaften eines Namens-Wert-Paars eines Dokuments, eines Ordners oder eines Arbeitsbereichs. Um ein Name-Wert-Paar zu löschen, legen Sie den Wert des Schlüssels auf eine leere Zeichenfolge fest, die in einfache oder doppelte Anführungszeichen eingeschlossen ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekttyp
|
objectType | True | string |
Gibt den Objekttyp an. Mögliche Werte sind "document", "folder", "workspace". |
|
Objekt-ID
|
objectId | True | string |
Gibt die ID des Dokuments, des Ordners oder des Arbeitsbereichs an. Ein Beispiel für eine Dokument-ID ist "ACTIVE_US!453.1". Ein Beispiel für eine Ordner- oder Arbeitsbereichs-ID ist "ACTIVE_US!123". |
|
Name-Wert-Paare
|
nameValuePairs | object |
Gibt den Freiformnamen und wertpaare für dieses Dokument an. |
Suchkernwerte für erweiterte Metadatentaxonomieknoten
Sucht nach wichtigen Werten für erweiterte Metadatentaxonomieknoten, die den angegebenen Suchkriterien entsprechen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die ID der Bibliothek an, für die die Suche ausgeführt werden soll. |
|
Taxonomieeigenschaft
|
taxonomyProperty | True | string |
Gibt die Taxonomieeigenschaft an, nach der Knotenwerte durchsucht werden sollen. |
|
ID
|
id | string |
Gibt den Anzeigebezeichner des Taxonomieknotenwerts an. Bei dieser Suche wird die Groß-/Kleinschreibung nicht beachtet. Partielle Übereinstimmungen werden nicht unterstützt. |
|
|
Query
|
query | string |
Gibt eine Abfrage für übereinstimmende Taxonomieknotenwerte mithilfe einer Platzhaltersuche (*) an, wobei partielle Übereinstimmungen für den Anzeigebezeichner oder die Beschreibung bereitgestellt werden. |
|
|
Knotenstatus
|
enabled_state | string |
Gibt an, dass nur Taxonomieknotenwerte zurückgegeben werden, die aktiviert oder deaktiviert oder beides sind. |
|
|
Pfad einschließen
|
include_path | boolean |
Gibt den vollständigen Pfad zum übereinstimmenden Knotenwert zurück. Ein Pfad ist eine sortierte Liste, die mit dem Knoten der obersten Ebene in der Taxonomie beginnt, und dann alle Knoten bis zum unmittelbar übergeordneten Knoten des übereinstimmenden Knotens. |
|
|
Vorgängerknoten-SSID
|
children_of_ssid | string |
Gibt die eindeutige, vom System generierte ID des Vorgängertaxonomieknotens an, auf den die Suche beschränkt werden soll. |
|
|
Nur sofortige Kinder
|
immediate_children_only | boolean |
Gibt an, dass die Suchergebnisse auf untergeordnete Elemente des Taxonomieknotens beschränkt werden sollen, der durch "Vorgängerknoten-SSID" angegeben wird. Die Suche kann auf die Stammebene der Taxonomie beschränkt werden, indem eine leere Zeichenfolge für "Übergeordnete Knoten-SSID" angegeben wird, die in einfache oder doppelte Anführungszeichen eingeschlossen ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
SSID
|
data.topMatchingResult.created_by.ssid | string |
Gibt die eindeutige, vom System generierte ID für den Benutzer an, der den obersten übereinstimmenden Knotenwert erstellt hat. |
|
Erstellungsdatum
|
data.topMatchingResult.create_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, der oberste übereinstimmende Knotenwert wurde erstellt. |
|
Description
|
data.topMatchingResult.description | string |
Gibt die Beschreibung des obersten übereinstimmenden Knotenwerts an. |
|
SSID
|
data.topMatchingResult.edited_by.ssid | string |
Gibt die eindeutige, vom System generierte ID für den Benutzer an, der zuletzt den obersten übereinstimmenden Knotenwert bearbeitet hat. |
|
Datum bearbeiten
|
data.topMatchingResult.edit_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, der oberste übereinstimmende Knotenwert wurde zuletzt bearbeitet. |
|
Ist aktiviert
|
data.topMatchingResult.enabled | boolean |
Gibt an, ob der Wert des obersten übereinstimmenden Knotens aktiviert ist. |
|
ID
|
data.topMatchingResult.id | string |
Gibt den Anzeigebezeichner für den oberen übereinstimmenden Knotenwert an. |
|
SSID
|
data.topMatchingResult.parent.ssid | string |
Gibt die eindeutige, vom System generierte ID für den unmittelbar übergeordneten Knoten des obersten übereinstimmenden Knotenwerts an. |
|
SSID
|
data.topMatchingResult.ssid | string |
Gibt die eindeutige, vom System generierte ID für den obersten übereinstimmenden Knotenwert an. |
|
Pfad
|
data.topMatchingResult.path | array of object |
Gibt den vollständigen Pfad zum obersten übereinstimmenden Knotenwert an. Ein Pfad ist eine sortierte Liste, die mit dem Knoten der obersten Ebene in der Taxonomie beginnt, und dann alle Knoten bis zum unmittelbar übergeordneten Knoten des übereinstimmenden Knotens. |
|
Jede ID
|
data.topMatchingResult.path.id | string |
Gibt den Anzeigebezeichner für einen Knotenwert im Pfad des obersten übereinstimmenden Knotens an. |
|
Jede SSID
|
data.topMatchingResult.path.ssid | string |
Gibt die eindeutige, vom System generierte ID für einen Knotenwert im Pfad des obersten übereinstimmenden Knotens an. |
|
Kernergebnisse für erweiterte Metadatentaxonomie
|
data.results | array of TaxonomyNodeValue |
Gibt einen oder mehrere kernige erweiterte Metadatentaxonomieknotenwerte an, die der Suche entsprechen. |
|
Alle Taxonomieknoten-SSIDs
|
data.all_taxonomy_ssids | string |
Gibt eine Liste aller Taxonomieknoten-SSIDs an, verkettet als Zeichenfolge und durch Semikolons getrennt. |
Trustees abrufen
Ruft eine Liste der Trustees mit bestimmten Berechtigungen für ein Dokument, einen Ordner oder einen Arbeitsbereich ab. Ein Trustee kann ein Benutzer oder eine Gruppe sein.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekttyp
|
objectType | True | string |
Gibt den Objekttyp an. |
|
Objekt-ID
|
objectId | True | string |
Gibt die ID des Dokuments, des Ordners oder des Arbeitsbereichs an. Ein Beispiel für eine Dokument-ID ist "ACTIVE_US!453.1". Ein Beispiel für eine Ordner- oder Arbeitsbereichs-ID ist "ACTIVE_US!123". |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Daten
|
data | array of object |
Gibt die Liste der Trustees mit bestimmten Berechtigungen für ein Dokument, einen Ordner oder einen Arbeitsbereich an. Ein Trustee kann ein Benutzer oder eine Gruppe sein. |
|
Vollständiger Name
|
data.full_name | string |
Gibt den vollständigen Namen des Trustee an. |
|
ID
|
data.id | string |
Gibt die ID des Trustee an. Dies kann eine Gruppen-ID oder Benutzer-ID sein. Beispielsweise "JSMITH" oder "MARKETING". |
|
SSID
|
data.ssid | string |
Gibt die eindeutige, vom System generierte ID des Trustee an. |
|
Typ
|
data.type | string |
Gibt den Typ der zurückgegebenen Entität an. Mögliche Werte sind "user" oder "group". |
Workflowstatus aktualisieren
Aktualisiert den Status einer Workflowausführung. Diese Aktion kann nur in einem Workflow verwendet werden, der erstellt wurde, um mit einem von iManage bereitgestellten Trigger zu beginnen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die ID der Bibliothek an, für die der Workflow definiert ist. |
|
Staat
|
state | True | string |
Gibt den aktuellen Status der Workflowausführung an. |
|
Der Status
|
status | string |
Gibt den aktuellen Status für die Workflowausführung an. Die maximale Länge beträgt 128 Zeichen. |
|
|
Statusmeldung
|
statusMessage | string |
Gibt die angepasste Nachricht für den aktuellen Status der Workflowausführung an. Die maximale Länge beträgt 256 Zeichen. |
Gibt zurück
- response
- object
Trigger
| Für ein ausgewähltes Dokument |
Mit diesem Trigger können Sie einen Workflow für ein ausgewähltes Dokument in einer iManage-Arbeitsbibliothek starten. Geben Sie einen Anzeigenamen an, der Benutzern in iManage Work-Anwendungen angezeigt wird. Wenn "Auf Abschluss warten" auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" in Ihrem Workflow verwenden, andernfalls werden Anwendungen irgendwann timeout ausgeführt, ohne den Abschlussstatus für den Benutzer anzugeben. |
| Für einen ausgewählten Arbeitsbereich |
Mit diesem Trigger können Sie einen Workflow für einen ausgewählten Arbeitsbereich in einer iManage-Arbeitsbibliothek starten. Geben Sie einen Anzeigenamen an, der Benutzern in iManage Work-Anwendungen angezeigt wird. Wenn "Auf Abschluss warten" auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" in Ihrem Workflow verwenden, andernfalls werden Anwendungen irgendwann timeout ausgeführt, ohne den Abschlussstatus für den Benutzer anzugeben. |
| Für mehrere ausgewählte Arbeitsbereiche |
Mit diesem Trigger können Sie einen Workflow für einen oder mehrere ausgewählte Arbeitsbereiche in iManage Work starten. Geben Sie einen Anzeigenamen an, der Benutzern in iManage Work-Anwendungen angezeigt wird. Wenn "Auf Abschluss warten" auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" in Ihrem Workflow verwenden, andernfalls werden Anwendungen irgendwann timeout ausgeführt, ohne den Abschlussstatus für den Benutzer anzugeben. |
| Für mehrere ausgewählte Dokumente |
Mit diesem Trigger können Sie einen Workflow für ein oder mehrere ausgewählte Dokumente in iManage Work starten. Geben Sie einen Anzeigenamen an, der Benutzern in iManage Work-Anwendungen angezeigt wird. Wenn "Auf Abschluss warten" auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" in Ihrem Workflow verwenden, andernfalls werden Anwendungen irgendwann timeout ausgeführt, ohne den Abschlussstatus für den Benutzer anzugeben. |
Für ein ausgewähltes Dokument
Mit diesem Trigger können Sie einen Workflow für ein ausgewähltes Dokument in einer iManage-Arbeitsbibliothek starten. Geben Sie einen Anzeigenamen an, der Benutzern in iManage Work-Anwendungen angezeigt wird. Wenn "Auf Abschluss warten" auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" in Ihrem Workflow verwenden, andernfalls werden Anwendungen irgendwann timeout ausgeführt, ohne den Abschlussstatus für den Benutzer anzugeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anzeigename des Workflows
|
workflowName | True | string |
Gibt den Anzeigenamen des Workflows an, der für iManage Work-Benutzer sichtbar ist. |
|
Description
|
description | True | string |
Gibt die Beschreibung des Workflows an. |
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die ID der Bibliothek an, in der der Workflow verfügbar ist. |
|
Formular-ID
|
formId | True | string |
Gibt die ID des Formulars an, das dem Benutzer angezeigt wird, um eingaben zu sammeln, die vom Workflow verwendet werden. |
|
Rückgabeordner-ID
|
inferFolderId | True | boolean |
Gibt an, ob die Ordner-ID des Dokuments vom Workflow benötigt wird. |
|
Für Benutzer verfügbar
|
users | string |
Gibt eine oder mehrere Benutzer-IDs an, getrennt durch Semikolons, für die der Workflow verfügbar ist. |
|
|
Für Gruppen verfügbar
|
groups | string |
Gibt eine oder mehrere Gruppen-IDs an, die durch Semikolons getrennt sind, für die der Workflow verfügbar ist. |
|
|
Verfügbar in Arbeitsbereichen
|
workspaces | string |
Gibt eine oder mehrere Arbeitsbereichs-IDs an, getrennt durch Semikolons, in denen der Workflow verfügbar ist. |
|
|
Dokumentklassen
|
classes | string |
Gibt eine oder mehrere Dokumentklassen-IDs an, die durch Semikolons getrennt sind, für die der Workflow verfügbar ist. |
|
|
Auf Abschluss warten
|
waitForCompletion | boolean |
Gibt an, ob Anwendungen warten, bis der Workflow die Ausführung abgeschlossen hat. Wenn sie auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" verwenden. |
Gibt zurück
Für einen ausgewählten Arbeitsbereich
Mit diesem Trigger können Sie einen Workflow für einen ausgewählten Arbeitsbereich in einer iManage-Arbeitsbibliothek starten. Geben Sie einen Anzeigenamen an, der Benutzern in iManage Work-Anwendungen angezeigt wird. Wenn "Auf Abschluss warten" auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" in Ihrem Workflow verwenden, andernfalls werden Anwendungen irgendwann timeout ausgeführt, ohne den Abschlussstatus für den Benutzer anzugeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anzeigename des Workflows
|
workflowName | True | string |
Gibt den Anzeigenamen des Workflows an, der für iManage Work-Benutzer sichtbar ist. |
|
Description
|
description | True | string |
Gibt die Beschreibung des Workflows an. |
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die ID der Bibliothek an, in der der Workflow verfügbar ist. |
|
Formular-ID
|
formId | True | string |
Gibt die ID des Formulars an, das dem Benutzer angezeigt wird, um eingaben zu sammeln, die vom Workflow verwendet werden. |
|
Für Benutzer verfügbar
|
users | string |
Gibt eine oder mehrere Benutzer-IDs an, getrennt durch Semikolons, für die der Workflow verfügbar ist. |
|
|
Für Gruppen verfügbar
|
groups | string |
Gibt eine oder mehrere Gruppen-IDs an, die durch Semikolons getrennt sind, für die der Workflow verfügbar ist. |
|
|
Auf Abschluss warten
|
waitForCompletion | boolean |
Gibt an, ob Anwendungen warten, bis der Workflow die Ausführung abgeschlossen hat. Wenn sie auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" verwenden. |
Gibt zurück
Für mehrere ausgewählte Arbeitsbereiche
Mit diesem Trigger können Sie einen Workflow für einen oder mehrere ausgewählte Arbeitsbereiche in iManage Work starten. Geben Sie einen Anzeigenamen an, der Benutzern in iManage Work-Anwendungen angezeigt wird. Wenn "Auf Abschluss warten" auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" in Ihrem Workflow verwenden, andernfalls werden Anwendungen irgendwann timeout ausgeführt, ohne den Abschlussstatus für den Benutzer anzugeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anzeigename des Workflows
|
workflowName | True | string |
Gibt den Anzeigenamen des Workflows an, der für iManage Work-Benutzer sichtbar ist. |
|
Description
|
description | True | string |
Gibt die Beschreibung des Workflows an. |
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die ID der Bibliothek an, in der der Workflow verfügbar ist. |
|
Formular-ID
|
formId | True | string |
Gibt die ID des Formulars an, das dem Benutzer angezeigt wird, um eingaben zu sammeln, die vom Workflow verwendet werden. |
|
Für Benutzer verfügbar
|
users | string |
Gibt eine oder mehrere Benutzer-IDs an, getrennt durch Semikolons, für die der Workflow verfügbar ist. |
|
|
Für Gruppen verfügbar
|
groups | string |
Gibt eine oder mehrere Gruppen-IDs an, die durch Semikolons getrennt sind, für die der Workflow verfügbar ist. |
|
|
Auf Abschluss warten
|
waitForCompletion | boolean |
Gibt an, ob Anwendungen warten, bis der Workflow die Ausführung abgeschlossen hat. Wenn sie auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" verwenden. |
Gibt zurück
Für mehrere ausgewählte Dokumente
Mit diesem Trigger können Sie einen Workflow für ein oder mehrere ausgewählte Dokumente in iManage Work starten. Geben Sie einen Anzeigenamen an, der Benutzern in iManage Work-Anwendungen angezeigt wird. Wenn "Auf Abschluss warten" auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" in Ihrem Workflow verwenden, andernfalls werden Anwendungen irgendwann timeout ausgeführt, ohne den Abschlussstatus für den Benutzer anzugeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anzeigename des Workflows
|
workflowName | True | string |
Gibt den Anzeigenamen des Workflows an, der für iManage Work-Benutzer sichtbar ist. |
|
Description
|
description | True | string |
Gibt die Beschreibung des Workflows an. |
|
Bibliotheks-ID
|
libraryId | True | string |
Gibt die ID der Bibliothek an, in der der Workflow verfügbar ist. |
|
Formular-ID
|
formId | True | string |
Gibt die ID des Formulars an, das dem Benutzer angezeigt wird, um eingaben zu sammeln, die vom Workflow verwendet werden. |
|
Rückgabeordner-ID
|
inferFolderId | True | boolean |
Gibt an, ob die Ordner-ID des Dokuments vom Workflow benötigt wird. |
|
Für Benutzer verfügbar
|
users | string |
Gibt eine oder mehrere Benutzer-IDs an, getrennt durch Semikolons, für die der Workflow verfügbar ist. |
|
|
Für Gruppen verfügbar
|
groups | string |
Gibt eine oder mehrere Gruppen-IDs an, die durch Semikolons getrennt sind, für die der Workflow verfügbar ist. |
|
|
Formular für jedes Dokument anzeigen
|
showFormPerObject | boolean |
Gibt an, ob das Formular für jedes ausgewählte Objekt einzeln oder nur einmal für alle ausgewählten Objekte dargestellt wird. |
|
|
Auf Abschluss warten
|
waitForCompletion | boolean |
Gibt an, ob Anwendungen warten, bis der Workflow die Ausführung abgeschlossen hat. Wenn sie auf "Ja" festgelegt ist, müssen Sie die Aktion "Workflowstatus aktualisieren" verwenden. |
Gibt zurück
Definitionen
MinimalDocumentProfileInArray
Gibt das Profil jeder Version des Dokuments an.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Autor
|
author | string |
Gibt die ID des Benutzers an, der das Dokument erstellt hat. Beispiel: "JSMITH". |
|
Beschreibung des Autors
|
author_description | string |
Gibt weitere Informationen zum Autor des Dokuments an. |
|
Grundlegende Dokumenteigenschaften
|
basic_properties | string |
Gibt ein einbettbares '' Element an, das grundlegende Dokumenteigenschaften enthält. |
|
Dokumentklasse
|
class | string |
Gibt die Klasse des Dokuments an. |
|
Kommentar
|
comment | string |
Gibt zusätzliche Informationen zum Dokument an. |
|
Inhaltstyp
|
content_type | string |
Gibt den Dokumentinhaltstyp an. |
|
Erstellungsdatum des Dokuments
|
create_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das das Dokument in das iManage Work-System importiert wurde. Dieses Datum kann sich von "file_create_date" unterscheiden. |
|
Benutzerdefiniert1
|
custom1 | string |
Gibt den Wert von custom1 an. |
|
Benutzerdefinierte Beschreibung1
|
custom1_description | string |
Gibt zusätzliche Informationen zur eigenschaft custom1 an. |
|
Benutzerdefiniert2
|
custom2 | string |
Gibt den Wert von custom2 an. |
|
Custom2 Description
|
custom2_description | string |
Gibt zusätzliche Informationen zur custom2-Eigenschaft an. |
|
Benutzerdefiniert3
|
custom3 | string |
Gibt den Wert von custom3 an. |
|
Benutzerdefinierte Beschreibung 3
|
custom3_description | string |
Gibt zusätzliche Informationen zur custom3-Eigenschaft an. |
|
Benutzerdefiniert4
|
custom4 | string |
Gibt den Wert von custom4 an. |
|
Custom4 Description
|
custom4_description | string |
Gibt zusätzliche Informationen zur custom4-Eigenschaft an. |
|
Benutzerdefiniert5
|
custom5 | string |
Gibt den Wert von custom5 an. |
|
Custom5 Description
|
custom5_description | string |
Gibt zusätzliche Informationen zur benutzerdefinierten5-Eigenschaft an. |
|
Benutzerdefiniert6
|
custom6 | string |
Gibt den Wert von custom6 an. |
|
Custom6 Description
|
custom6_description | string |
Gibt zusätzliche Informationen zur custom6-Eigenschaft an. |
|
Benutzerdefiniert7
|
custom7 | string |
Gibt den Wert von custom7 an. |
|
Custom7 Description
|
custom7_description | string |
Gibt zusätzliche Informationen zur custom7-Eigenschaft an. |
|
Benutzerdefiniert8
|
custom8 | string |
Gibt den Wert von custom8 an. |
|
Custom8 Description
|
custom8_description | string |
Gibt zusätzliche Informationen zur benutzerdefinierten8-Eigenschaft an. |
|
Benutzerdefiniert9
|
custom9 | string |
Gibt den Wert von custom9 an. |
|
Custom9 Description
|
custom9_description | string |
Gibt zusätzliche Informationen zur custom9-Eigenschaft an. |
|
Benutzerdefiniert10
|
custom10 | string |
Gibt den Wert von custom10 an. |
|
Custom10 Description
|
custom10_description | string |
Gibt zusätzliche Informationen zur eigenschaft custom10 an. |
|
Benutzerdefiniert1
|
custom11 | string |
Gibt den Wert von custom11 an. |
|
Beschreibung von Custom11
|
custom11_description | string |
Gibt zusätzliche Informationen zur eigenschaft custom11 an. |
|
Benutzerdefiniert12
|
custom12 | string |
Gibt den Wert von custom12 an. |
|
Custom12 Description
|
custom12_description | string |
Gibt zusätzliche Informationen zur custom12-Eigenschaft an. |
|
Benutzerdefiniert13
|
custom13 | string |
Gibt den Wert von custom13 an. |
|
Benutzerdefiniert14
|
custom14 | string |
Gibt den Wert von custom14 an. |
|
Benutzerdefiniert15
|
custom15 | string |
Gibt den Wert von custom15 an. |
|
Benutzerdefiniert16
|
custom16 | string |
Gibt den Wert von custom16 an. |
|
Benutzerdefiniert17
|
custom17 | double |
Gibt den Wert von custom17 an. |
|
Benutzerdefiniert18
|
custom18 | double |
Gibt den Wert von custom18 an. |
|
Benutzerdefiniert19
|
custom19 | double |
Gibt den Wert von custom19 an. |
|
Benutzerdefiniert20
|
custom20 | double |
Gibt den Wert von custom20 an. |
|
Custom21
|
custom21 | string |
Gibt den Wert der custom21-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
Custom22
|
custom22 | string |
Gibt den Wert der custom22-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
Custom23
|
custom23 | string |
Gibt den Wert der custom23-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
Custom24
|
custom24 | string |
Gibt den Wert der custom24-Eigenschaft im ISO 8601-Datumstime-Format an. |
|
Custom25
|
custom25 | boolean |
Gibt den Wert von custom25 an. |
|
Custom26
|
custom26 | boolean |
Gibt den Wert von custom26 an. |
|
Benutzerdefiniert27
|
custom27 | boolean |
Gibt den Wert von custom27 an. |
|
Benutzerdefiniert28
|
custom28 | boolean |
Gibt den Wert von custom28 an. |
|
Benutzerdefiniert29
|
custom29 | string |
Gibt den Wert von custom29 an. |
|
Custom29 Description
|
custom29_description | string |
Gibt zusätzliche Informationen zur custom29-Eigenschaft an. |
|
Custom30
|
custom30 | string |
Gibt den Wert von custom30 an. |
|
Custom30 Description
|
custom30_description | string |
Gibt zusätzliche Informationen zur custom30-Eigenschaft an. |
|
Datenbank
|
database | string |
Gibt die Bibliothek an, in der das Dokument gespeichert ist. |
|
Dokumentstandardsicherheit
|
default_security | string |
Gibt die Standardmäßige Sicherheitszugriffsstufe an. Mögliche Werte sind "inherit", "private", "view", "public". |
|
Dokumentnummer
|
document_number | integer |
Gibt die Dokumentnummer eines Dokuments an. |
|
Dokument-URL
|
document_url | string |
Gibt den freigabefähigen Link für das Dokument an. |
|
Datum der Dokumentbearbeitung
|
edit_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung an dem Dokument an. |
|
Profilbearbeitungsdatum
|
edit_profile_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung am Dokumentprofil an. |
|
Dokumenterweiterung
|
extension | string |
Gibt die Dateinamenerweiterung an, die auch als Anwendungserweiterung bezeichnet wird, des Dokuments. |
|
Vollständiger Dateiname
|
full_file_name | string |
Gibt den vollständigen Dateinamen des Dokuments an. Enthält die Dateinamenerweiterung. |
|
Dokument-ID
|
id | string |
Gibt die ID des Dokuments an. Beispiel: "ACTIVE_US!453.1". |
|
Ist indiziert
|
indexable | boolean |
Gibt an, ob das Dokument vom System indiziert wird. |
|
Ist ausgecheckt
|
is_checked_out | boolean |
Gibt an, ob das Dokument ausgecheckt ist. |
|
Wird deklariert
|
is_declared | boolean |
Gibt an, ob das Dokument als Datensatz deklariert wird. Ein Dokument, das als Datensatz deklariert ist, kann nicht bearbeitet oder gelöscht werden, außer von einem iManage Work-Systemadministrator. |
|
Ist extern
|
is_external | boolean |
Gibt an, ob das Dokument für externe Benutzer freigegeben wird. |
|
Ist HIPAA
|
is_hipaa | boolean |
Gibt an, ob das Dokument verschlüsselt ist. |
|
Ist in Gebrauch
|
is_in_use | boolean |
Gibt an, ob das Dokument verwendet wird. |
|
Dokumentlink
|
iwl | string |
Gibt die iManage Work Link (iWL) für das Dokument an. Die iWL wird verwendet, um das Dokument im geschützten Ansichtsmodus von dem Benutzer zu öffnen, der über "read_write" oder "full_access" verfügt. |
|
Letzter Benutzer
|
last_user | string |
Gibt die ID des Benutzers an, der das Dokument zuletzt bearbeitet hat. Beispiel: "JSMITH". |
|
Letzte Benutzerbeschreibung
|
last_user_description | string |
Gibt zusätzliche Informationen zum letzten Benutzer an, der das Dokument zuletzt bearbeitet hat. |
|
Dokumentname
|
name | string |
Gibt den Dateinamen des Dokuments an. |
|
Bediener
|
operator | string |
Gibt die ID des Benutzers an, der das Dokument ausgecheckt hat oder aktuell sein Profil bearbeitet. Beispiel: "JSMITH". |
|
Operatorbeschreibung
|
operator_description | string |
Gibt zusätzliche Informationen zum Operator an. |
|
Ist verwandt
|
is_related | boolean |
Gibt an, ob das Dokument mit einem anderen Dokument verknüpft ist. |
|
Dokumentgröße
|
size | integer |
Gibt die Größe des Dokuments in Byte an. |
|
Typ
|
type | string |
Gibt den Dokumenttyp an. Beispiel: WORD für Microsoft Word. Wenden Sie sich für eine aktuelle Liste der Typen an Ihren iManage Work-Systemadministrator. |
|
Dokumentversion
|
version | integer |
Gibt die Versionsnummer des Dokuments an. |
|
Wstype
|
wstype | string |
Gibt den iManage Work-Typ des Objekts an. Mögliche Werte sind "document", "folder", "workspace", "email", "document_shortcut", "folder_shortcut", "workspace_shortcut", "user". |
Benutzerprofil
Gibt Informationen zu einem Benutzer an.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anmeldung zulassen
|
allow_logon | boolean |
Gibt an, ob der Benutzer sich anmelden darf. |
|
Benutzerdefiniert1
|
custom1 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Benutzerdefiniert2
|
custom2 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Benutzerdefiniert3
|
custom3 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Verzeichniskennung
|
directory_id | string |
Gibt die ID aus einem externen Verzeichnis (z. B. ADFS) an, die für die Benutzerprofilsynchronisierung verwendet wird. |
|
Unterscheidungsname
|
distinguished_name | string |
Gibt den Namen des Objekts an, das den vollqualifizierten Pfad von Namen darstellt, der den Eintrag zurück zum Stamm der LDAP-Struktur zurückverfolgt. |
|
Datum bearbeiten
|
edit_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung am Benutzerprofil an. |
|
Email
|
string |
Gibt die E-Mail-ID des Benutzers an. |
|
|
Exchange-URL für die automatische Erkennung
|
exch_autodiscover | string |
Gibt die Exchange-Serverdetails des Benutzers an. |
|
Extension
|
extension | string |
Gibt die Telefonnummernerweiterung des Benutzers an. |
|
Fehlgeschlagene Anmeldeversuche
|
failed_logins | integer |
Gibt die aktuelle Anzahl der fehlgeschlagenen Anmeldeversuche des Benutzers an. |
|
Faxnummer
|
fax | string |
Gibt die Faxnummer des Benutzers an. |
|
Kennwortänderung erzwingen
|
force_password_change | boolean |
Gibt an, dass der Benutzer sein Kennwort bei der nächsten Anmeldung ändern muss. Gilt nur für virtuelle Benutzer, die durch den Wert "user_nos" "2" angegeben sind. |
|
Vollständiger Name
|
full_name | string |
Gibt den vollständigen Namen des Benutzers an. |
|
Allgemein
|
general | string |
Gibt allgemeine Informationen zum Benutzer an. |
|
Benutzer-ID
|
id | string |
Gibt die ID des Benutzers an. Beispiel: "JSMITH". |
|
Ist externer Benutzer
|
is_external | boolean |
Gibt einen externen Benutzer an. Ein externer Benutzer hat eingeschränkten Zugriff und wird häufig für temporäre Teammitglieder, Berater oder personen außerhalb der Organisation verwendet. |
|
Zeitpunkt der letzten Synchronisierung
|
last_sync_ts | string |
Gibt die letzte Synchronisierungszeit (im ISO 8601-Datumstime-Format) des Benutzerprofils mit einem externen Verzeichnis an, z. B. LDAP oder Microsoft Active Directory (ADFS). |
|
Standort
|
location | string |
Gibt den geografischen Standort des Benutzers an. |
|
Kennwort läuft nie ab
|
password_never_expire | boolean |
Gibt an, ob das Kennwort des Benutzers nie abläuft. |
|
Telefonnummer
|
phone | string |
Gibt die Telefonnummer des Benutzers an. |
|
Bevorzugte Bibliothek
|
preferred_library | string |
Gibt die bevorzugte Bibliothek an. Eine bevorzugte Bibliothek ist die Standardbibliothek des Benutzers. Jeder Benutzer muss über eine bevorzugte Bibliothek verfügen. |
|
Kennwortänderungszeit
|
pwd_changed_ts | string |
Gibt die Uhrzeit (im ISO 8601-Datumsformat) an, zu der das Kennwort des Benutzers zuletzt geändert wurde. Dies gilt nur für virtuelle Benutzer (deren Benutzer-NOS 2 ist). |
|
SSID
|
ssid | string |
Gibt die eindeutige, vom System generierte ID für den Benutzer an. |
|
Benutzerdomäne
|
user_domain | string |
Gibt den vollqualifizierten Domänennamen für den Verzeichnisdienst des Benutzers an. |
|
Erweiterte Benutzer-ID
|
user_id_ex | string |
Gibt den ursprünglichen Wert der Benutzer-ID an, die von einem externen Verzeichnis wie Microsoft Active Directory (ADFS) empfangen wird. |
|
Benutzer-NOS
|
user_nos | integer |
Gibt den Typ des Betriebssystems an, von dem der Benutzer synchronisiert wird. Mögliche Werte sind 2 (virtueller Benutzer) und 6 (Enterprise-Benutzer). Wenden Sie sich an Ihren iManage Work-Systemadministrator, um weitere Informationen zu erfahren. |
|
Benutzernummer
|
user_num | integer |
Gibt die numerische System-ID des Benutzers an. |
UserProfileInArray
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anmeldung zulassen
|
allow_logon | boolean |
Gibt an, ob der Benutzer sich anmelden darf. |
|
Benutzerdefiniert1
|
custom1 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Benutzerdefiniert2
|
custom2 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Benutzerdefiniert3
|
custom3 | string |
Gibt zusätzliche Informationen zum Benutzer an. |
|
Verzeichniskennung
|
directory_id | string |
Gibt die ID aus einem externen Verzeichnis (z. B. ADFS) an, die für die Benutzerprofilsynchronisierung verwendet wird. |
|
Unterscheidungsname
|
distinguished_name | string |
Gibt den Namen des Objekts an, das den vollqualifizierten Pfad von Namen darstellt, der den Eintrag zurück zum Stamm der LDAP-Struktur zurückverfolgt. |
|
Datum bearbeiten
|
edit_date | string |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) der letzten Änderung am Benutzerprofil an. |
|
Email
|
string |
Gibt die E-Mail-ID des Benutzers an. |
|
|
Exchange-URL für die automatische Erkennung
|
exch_autodiscover | string |
Gibt die Exchange-Serverdetails des Benutzers an. |
|
Extension
|
extension | string |
Gibt die Telefonnummernerweiterung des Benutzers an. |
|
Fehlgeschlagene Anmeldeversuche
|
failed_logins | integer |
Gibt die aktuelle Anzahl der fehlgeschlagenen Anmeldeversuche des Benutzers an. |
|
Faxnummer
|
fax | string |
Gibt die Faxnummer des Benutzers an. |
|
Kennwortänderung erzwingen
|
force_password_change | boolean |
Gibt an, dass der Benutzer sein Kennwort bei der nächsten Anmeldung ändern muss. Gilt nur für virtuelle Benutzer, die durch den Wert "user_nos" "2" angegeben sind. |
|
Vollständiger Name
|
full_name | string |
Gibt den vollständigen Namen des Benutzers an. |
|
Allgemein
|
general | string |
Gibt allgemeine Informationen zum Benutzer an. |
|
ID
|
id | string |
Gibt die ID des Benutzers an. Beispiel: "JSMITH". |
|
Ist externer Benutzer
|
is_external | boolean |
Gibt einen externen Benutzer an. Ein externer Benutzer hat eingeschränkten Zugriff und wird häufig für temporäre Teammitglieder, Berater oder personen außerhalb der Organisation verwendet. |
|
Zeitpunkt der letzten Synchronisierung
|
last_sync_ts | string |
Gibt die letzte Synchronisierungszeit (im ISO 8601-Datumstime-Format) des Benutzerprofils mit einem externen Verzeichnis an, z. B. LDAP oder Microsoft Active Directory (ADFS). |
|
Standort
|
location | string |
Gibt den geografischen Standort des Benutzers an. |
|
Kennwort läuft nie ab
|
password_never_expire | boolean |
Gibt an, ob das Kennwort des Benutzers nie abläuft. |
|
Telefonnummer
|
phone | string |
Gibt die Telefonnummer des Benutzers an. |
|
Bevorzugte Bibliothek
|
preferred_library | string |
Gibt die bevorzugte Bibliothek an. Eine bevorzugte Bibliothek ist die Standardbibliothek des Benutzers. Jeder Benutzer muss über eine bevorzugte Bibliothek verfügen. |
|
Kennwortänderungszeit
|
pwd_changed_ts | string |
Gibt die Uhrzeit (im ISO 8601-Datumsformat) an, zu der das Kennwort des Benutzers zuletzt geändert wurde. Dies gilt nur für virtuelle Benutzer (deren Benutzer-NOS 2 ist). |
|
SSID
|
ssid | string |
Gibt die eindeutige, vom System generierte ID für den Benutzer an. |
|
Domäne
|
user_domain | string |
Gibt den vollqualifizierten Domänennamen für den Verzeichnisdienst des Benutzers an. |
|
Erweiterte Benutzer-ID
|
user_id_ex | string |
Gibt den ursprünglichen Wert der Benutzer-ID an, die von einem externen Verzeichnis wie Microsoft Active Directory (ADFS) empfangen wird. |
|
NOS
|
user_nos | integer |
Gibt den Typ des Betriebssystems an, von dem der Benutzer synchronisiert wird. Mögliche Werte sind 2 (virtueller Benutzer) und 6 (Enterprise-Benutzer). Wenden Sie sich an Ihren iManage Work-Systemadministrator, um weitere Informationen zu erfahren. |
|
Number
|
user_num | integer |
Gibt die numerische System-ID des Benutzers an. |
TaxonomyNodeValue
Gibt jeden Taxonomieknotenwert an.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
SSID
|
created_by.ssid | string |
Gibt die eindeutige, vom System generierte ID für den Benutzer an, der den Knotenwert erstellt hat. |
|
Erstellungsdatum
|
create_date | date-time |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das der Knotenwert erstellt wurde. |
|
Description
|
description | string |
Gibt die Beschreibung des Knotenwerts an. |
|
SSID
|
edited_by.ssid | string |
Gibt die eindeutige, vom System generierte ID für den Benutzer an, der den Knotenwert zuletzt bearbeitet hat. |
|
Datum bearbeiten
|
edit_date | date-time |
Gibt das Datum und die Uhrzeit (im ISO 8601-Format) an, das der Knotenwert zuletzt bearbeitet wurde. |
|
Ist aktiviert
|
enabled | boolean |
Gibt an, ob der Knotenwert aktiviert ist. |
|
ID
|
id | string |
Gibt den Anzeigebezeichner für den Knotenwert an. |
|
SSID
|
parent.ssid | string |
Gibt die eindeutige, vom System generierte ID für den unmittelbaren übergeordneten Knoten an. |
|
SSID
|
ssid | string |
Gibt die eindeutige, vom System generierte ID für den Knotenwert an. |
|
Pfad
|
path | array of object |
Gibt den vollständigen Pfad zum Knotenwert an. Ein Pfad ist eine sortierte Liste, die mit dem Knoten der obersten Ebene in der Taxonomie beginnt, und dann alle Knoten bis zum unmittelbar übergeordneten Knoten des übereinstimmenden Knotens. |
|
Jede ID
|
path.id | string |
Gibt den Anzeigebezeichner für einen Knotenwert im Pfad an. |
|
Jede SSID
|
path.ssid | string |
Gibt die eindeutige, vom System generierte ID für einen Knotenwert im Pfad an. |
UpdatePermissionsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Standardsicherheit
|
data.default_security | string |
Gibt die Standardsicherheit des Objekts an. Mögliche Werte sind "inherit", "public", "view" oder "private". |
|
Zugriffsberechtigungen
|
data.acl | AccessPermissions |
Gibt eine Sammlung von Zugriffsberechtigungen für einen oder mehrere Benutzer und/oder Gruppen an. |
|
Alle Benutzer-IDs
|
data.all_user_ids | string |
Gibt eine Liste aller Benutzer-IDs an, verkettet als Zeichenfolge und durch Semikolons getrennt. |
|
Alle Gruppen-IDs
|
data.all_group_ids | string |
Gibt eine Liste aller Gruppen-IDs an, verkettet als Zeichenfolge und durch Semikolons getrennt. |
AccessPermissions
Gibt eine Sammlung von Zugriffsberechtigungen für einen oder mehrere Benutzer und/oder Gruppen an.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Trustee Name
|
name | string |
Gibt den Namen des Trustee an. |
|
Trustee-ID
|
id | string |
Gibt die ID des Trustee an. Dies kann eine Benutzer-ID oder eine Gruppen-ID sein. |
|
Trustee SID
|
sid | string |
Gibt den Sicherheitsbezeichner des Benutzers oder der Gruppe an. |
|
Trustee-Typ
|
type | string |
Gibt den Typ des zurückgegebenen Trustee an. Mögliche Werte sind "user" oder "group". |
|
Zugriffsebene
|
access_level | string |
Gibt die Zugriffsberechtigung an, die der Benutzer oder die Gruppe für das Objekt besitzt. Mögliche Werte sind "no_access", "read", "read_write" oder "full_access". |
|
Anzeigename auf Zugriffsebene
|
access_level_display_name | string |
Gibt den Anzeigenamen auf benutzerlesbarer Zugriffsebene an, der dem Benutzer oder der Gruppe für dieses Objekt zugewiesen ist. Mögliche Werte sind "No Access", "Read Only", "Read/Write" oder "Full Access". |
|
Zugang
|
access | integer |
Gibt den numerischen Wert der Zugriffsberechtigung an, die der Benutzer oder die Gruppe für das Objekt besitzt. Mögliche Werte sind 0 (no_access), 1 (gelesen), 2 (read_write) oder 3 (full_access). |
|
Ist extern
|
is_external | boolean |
Gibt an, ob der Benutzer ein externer Benutzer ist oder ob die Gruppe auf externe Benutzer beschränkt ist. |
|
Anmeldung zulassen
|
allow_logon | boolean |
Gibt an, ob der Benutzer sich anmelden darf. Gilt nicht für Gruppen. |
|
Ist aktiviert
|
enabled | boolean |
Gibt an, ob die Gruppe aktiviert ist. Gilt nicht für Benutzer. |
|
Has Restricted Member
|
has_restricted_member | boolean |
Gibt an, ob die Gruppe mindestens einen Benutzer mit Zugriff auf dieses Objekt hat, das von iManage Security Policy Manager verweigert wurde. |
Objekt
Dies ist der Typ 'object'.
binär
Dies ist der grundlegende Datentyp "binary".