NetDocuments
NetDocuments ist ein Cloud Content Management Service für Unternehmen aller Größen, um ihre Dokumentarbeit überall und jederzeit sicher zu erstellen, zu speichern, zu verwalten und zu teilen.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Norm | 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 | Norm | 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 | Norm | 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 | |
|---|---|
| URL | https://support.netdocuments.com/hc/en-us |
| Connectormetadaten | |
|---|---|
| Herausgeber | NetDocuments Software, Inc. |
| Webseite | https://www.netdocuments.com/ |
| Datenschutzrichtlinie | https://www.netdocuments.com/privacy-policy/ |
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Region | Schnur | Region, in der sich Ihr Netzdokument befindet. | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen aktueller Benutzerinformationen |
Abrufen von Informationen zum aktuellen Benutzer, ID ist nicht erforderlich. |
| Abrufen eines Nachschlagetabelleneintrags oder Suchen nach untergeordneten Tabelleneinträgen |
Abrufen eines Nachschlagetabelleneintrags oder Suchen nach untergeordneten Tabelleneinträgen |
| Abrufen eines untergeordneten Nachschlagetabelleneintrags |
Abrufen eines untergeordneten Nachschlagetabelleneintrags |
| Abrufen oder Erstellen eines Arbeitsbereichs (mit einem einzelnen Attribut) |
Abrufen oder Erstellen eines Arbeitsbereichs (mit einem einzelnen Attribut) |
| Abrufen oder Erstellen eines Arbeitsbereichs (mit übergeordneten und untergeordneten Attributen) |
Abrufen oder Erstellen eines Arbeitsbereichs (mit übergeordneten und untergeordneten Attributen) |
| Abrufen von Arbeitsbereichsinformationen |
Abrufen von Arbeitsbereichsinformationen |
| Abrufen von benutzerdefinierten Cab-Attributen |
Abrufen von benutzerdefinierten Cab-Attributen |
| Abrufen von Benutzerinformationen |
Abrufen von Informationen zu einem Benutzer |
| Abrufen von Cab-Einstellungen |
Abrufen von Cab-Einstellungen |
| Abrufen von Cab-Informationen |
Abrufen von Cab-Informationen |
| Abrufen von Containerinhalten |
Abrufen des Inhalts des ausgewählten Containers |
| Abrufen von Dokumentinhalten |
Abrufen eines Dokuments |
| Abrufen von Dokumentversionen |
Abrufen von Dokumentversionen |
| Abrufen von Gruppeninformationen |
Abrufen von Gruppeninformationen |
| Abrufen von Ordnerelementen |
Abrufen des Inhalts eines Ordners, einschließlich Dokumenten und Unterordnern |
| Abrufen von Repositorybenutzern |
Abrufen von Repositorybenutzern |
| Abrufen von Repositorygruppen |
Abrufen von Repositorygruppen |
| Abrufen von Repositoryinformationen |
Abrufen von Repositoryinformationen |
| Abrufen von Zugriffsrechten für unhidden Cab-Gruppen |
Abrufen von Zugriffsrechten für unhidden Cab-Gruppen |
| Aktualisieren eines Arbeitsbereichs |
Aktualisieren eines Arbeitsbereichs |
| Benutzer erstellen |
Erstellen eines Benutzers in einem Repository |
| Benutzer zum Repository hinzufügen oder daraus entfernen |
Benutzer zum Repository hinzufügen oder daraus entfernen |
| Cab-Gruppen abrufen |
Abrufen aller Gruppen, die einer Kabinett hinzugefügt wurden |
|
Collab |
Erstellen eines neuen CollabSpace |
| Datei oder Aufheben der Datei des Dokuments im Ordner |
Datei eines Elements in einem Ordner oder Aufheben der Datei eines Elements aus einem Ordner. |
| Dokument aktualisieren |
Aktualisieren des Inhalts eines Dokuments |
| Dokument auschecken |
Auschecken eines Dokuments |
| Dokument entsperren |
Ausdocken des Dokuments |
| Dokument erstellen |
Ein neues Dokument erstellen |
| Dokument folgen |
Empfangen von Warnungen, wenn das Dokument aktualisiert wird |
| Dokument löschen |
Löschen eines Dokuments |
| Dokument sperren |
Dokument sperren |
| Dokument umbenennen |
Umbenennen eines Dokuments |
| Dokumentprofil abrufen |
Abrufen von Informationen zu einem Dokument |
| Dokumentverlauf |
Abrufen einer Liste von Aktionen für ein Dokument |
| Dokumentversion sperren |
Dokumentversion sperren |
| Durchsuchen einer Kabinett und Ändern von ACLs |
Durchsuchen einer Kabinett und Ändern von ACLs |
| Durchsuchen eines oder mehrerer Cabs |
Durchsuchen eines oder mehrerer Cabs |
| Einchecken eines Dokuments |
Einchecken eines ausgecheckten Dokuments |
| Erstellen des Ordners |
Erstellen eines neuen Ordners |
| Erstellen einer externen Cab-Gruppe |
Erstellen einer externen Cab-Gruppe |
| Erstellen einer neuen Version eines Dokuments |
Erstellen einer neuen Version eines Dokuments |
| Erstellen oder Aktualisieren eines Nachschlagetabelleneintrags |
Erstellen oder Aktualisieren eines Nachschlagetabelleneintrags |
| Erstellen oder Aktualisieren eines untergeordneten Nachschlagetabelleneintrags |
Erstellen oder Aktualisieren eines untergeordneten Nachschlagetabelleneintrags |
| Gesicherten Link erstellen |
Generieren eines Links zu einem Dokument, auf das von jedem Benutzer zugegriffen werden kann |
| Gruppenmitgliedschaft abrufen |
Gruppenmitgliedschaft abrufen |
| Hinzufügen oder Entfernen einer Gruppe aus cab |
Hinzufügen einer Gruppe zu Cab- und Standardzugriffsrechten |
| Hinzufügen oder Entfernen eines Gruppenmitglieds |
Hinzufügen oder Entfernen eines Gruppenmitglieds |
| Liste der Benutzerschränke abrufen |
Abrufen von Benutzerschränken |
| Löschen eines Nachschlagetabelleneintrags |
Löschen eines Nachschlagetabelleneintrags |
| Löschen eines untergeordneten Nachschlagetabelleneintrags |
Löschen eines untergeordneten Nachschlagetabelleneintrags |
| Nach Nachschlagetabelleneinträgen suchen |
Nach Nachschlagetabelleneinträgen suchen |
| Ordner folgen |
Empfangen von Benachrichtigungen, wenn einem Ordner neue Inhalte hinzugefügt werden |
| Ordner löschen |
Löschen eines Ordners |
| Ordner umbenennen |
Umbenennen eines Ordners |
| Repositorygruppe erstellen |
Erstellen einer Repositorygruppe |
| Repositorygruppe löschen |
Löschen einer Repositorygruppe |
| Repositoryprotokoll abrufen |
Repositoryprotokoll abrufen |
Abrufen aktueller Benutzerinformationen
Abrufen von Informationen zum aktuellen Benutzer, ID ist nicht erforderlich.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabGuid | string |
(Es beginnt mit NG-) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzeigename
|
displayName | string | |
|
E-Mail
|
|||
|
id
|
id | string | |
|
Organisation
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primaryCabinet
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
äußerlich
|
external | boolean |
Abrufen eines Nachschlagetabelleneintrags oder Suchen nach untergeordneten Tabelleneinträgen
Abrufen eines Nachschlagetabelleneintrags oder Suchen nach untergeordneten Tabelleneinträgen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Attribut-ID
|
attributeID | True | string |
(Entfernen Sie die führende "10". Um einen einzelnen Wert zurückzugeben, geben Sie die übergeordnete Attribut-ID ein, oder geben Sie die untergeordnete Attribut-ID ein, um nach untergeordneten Einträgen zu suchen.) |
|
Key
|
parentID | True | string |
(Um einen einzelnen Wert zurückzugeben, geben Sie den Schlüssel des einzelnen Attributs ein, oder um nach untergeordneten Einträgen zu suchen, geben Sie den Schlüssel des übergeordneten Elements ein.) |
|
Filter (nur bei der Suche)
|
$filter | string |
(Weitere Informationen finden Sie in der Dokumentation zu den verfügbaren Filtern) |
|
|
Abzurufende Felder
|
$select | string |
(Schließen Sie eine durch Trennzeichen getrennte Liste von: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user' und/oder 'access' ein) |
|
|
Anzahl der übereinstimmenden Datensätze, die übersprungen werden sollen
|
$skip | integer |
(Dies wird beim Abrufen mehrerer Ergebnisblöcke verwendet.) |
|
|
Maximale Anzahl der zurückzugebenden Datensätze
|
$top | integer |
Maximale Anzahl der zurückzugebenden Datensätze |
|
|
Sortieren der Ergebnisse nach
|
$orderby | string |
Sortieren der Ergebnisse nach |
Abrufen eines untergeordneten Nachschlagetabelleneintrags
Abrufen eines untergeordneten Nachschlagetabelleneintrags
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Untergeordnete Attribut-ID
|
childAttributeID | True | string |
(Entfernen sie die führende '10') |
|
Übergeordneter Schlüssel
|
parentID | True | string |
Übergeordneter Schlüssel |
|
Untergeordneter Schlüssel
|
childID | True | string |
Untergeordneter Schlüssel |
Abrufen oder Erstellen eines Arbeitsbereichs (mit einem einzelnen Attribut)
Abrufen oder Erstellen eines Arbeitsbereichs (mit einem einzelnen Attribut)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
|
Alleiniger Wert
|
parentID | True | string |
Der einzige Wert, der zum Definieren von Arbeitsbereichen im Kabinett verwendet wird. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
standardAttributes.id | string |
Abrufen oder Erstellen eines Arbeitsbereichs (mit übergeordneten und untergeordneten Attributen)
Abrufen oder Erstellen eines Arbeitsbereichs (mit übergeordneten und untergeordneten Attributen)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
|
Übergeordneter Wert
|
parentID | True | string |
Der übergeordnete Wert, der zum Definieren von Arbeitsbereichen im Kabinett verwendet wird. |
|
Untergeordneter Wert
|
childID | True | string |
Der untergeordnete Wert, der zum Definieren von Arbeitsbereichen im Cab-Bereich verwendet wird. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
standardAttributes.id | string |
Abrufen von Arbeitsbereichsinformationen
Abrufen von Arbeitsbereichsinformationen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Arbeitsbereichs-ID
|
workspaceID | True | string |
Arbeitsbereichs-ID |
Abrufen von benutzerdefinierten Cab-Attributen
Abrufen von benutzerdefinierten Cab-Attributen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
items
|
object |
Abrufen von Benutzerinformationen
Abrufen von Informationen zu einem Benutzer
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
id | True | string |
Die von NetDocuments zugewiesene Benutzer-ID. |
|
Cab-ID
|
cabGuid | string |
(Es beginnt mit NG-) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzeigename
|
displayName | string | |
|
E-Mail
|
|||
|
id
|
id | string | |
|
Organisation
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primaryCabinet
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
äußerlich
|
external | boolean |
Abrufen von Cab-Einstellungen
Abrufen von Cab-Einstellungen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
Abrufen von Cab-Informationen
Abrufen von Cab-Informationen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
Abrufen von Containerinhalten
Abrufen des Inhalts des ausgewählten Containers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Container-ID
|
containerID | True | string |
Container-ID |
|
Zurückzugebende Informationen
|
select | True | string |
(Lesen Sie die Dokumentation für das Rückgabeformat. |
|
Anzahl der zurückzugebenden Ergebnisse (Standardwert: 50)
|
top | integer |
(Maximal 500 pro Seite) |
|
|
Token zum Paginieren von Ergebnissen
|
skiptoken | string |
Token zum Paginieren von Ergebnissen |
|
|
Bestellung nach
|
orderby | string |
(Format: Feld#|Desc oder Feld#|asc) |
Abrufen von Dokumentinhalten
Abrufen eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Base64-codiert?
|
base64 | boolean |
Base64-codiert? |
Abrufen von Dokumentversionen
Abrufen von Dokumentversionen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentID | True | string |
12-stellige Dokument-ID. |
Abrufen von Gruppeninformationen
Abrufen von Gruppeninformationen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Gruppen-ID
|
groupID | True | string |
Gruppen-ID (beginnt mit UG-). |
|
Gruppenkabinettmitgliedschaft
|
cabMembership | boolean |
(Wenn diese Gruppe auf "true" festgelegt ist, sind diese Gruppen Mitglied, und die Standardberechtigungen für dokumentzugriffe für jede Kabinett werden einbezogen.) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
äußerlich
|
external | boolean | |
|
ausgeblendet
|
hidden | boolean | |
|
hideMembership
|
hideMembership | boolean | |
|
id
|
id | string | |
|
name
|
name | string | |
|
cabMembership
|
cabMembership | array of object | |
|
id
|
cabMembership.id | string | |
|
name
|
cabMembership.name | string | |
|
Rechte
|
cabMembership.rights | string |
Abrufen von Ordnerelementen
Abrufen des Inhalts eines Ordners, einschließlich Dokumenten und Unterordnern
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ordner-ID
|
id | True | string |
12-stellige Ordner-ID. |
|
Zurückzugebende Attribute
|
$select | string |
Eine durch Trennzeichen getrennte Liste von Attributwerten. Weitere Informationen finden Sie in der REST-API-Dokumentation. |
Abrufen von Repositorybenutzern
Abrufen von Repositorybenutzern
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Beginnt mit ca-) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
Anzeigename
|
displayName | string | |
|
E-Mail
|
string | ||
|
äußerlich
|
external | boolean | |
|
id
|
id | string | |
|
lastLogin
|
lastLogin | string | |
|
registriert
|
registered | string |
Abrufen von Repositorygruppen
Abrufen von Repositorygruppen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Filter
|
$filter | string |
(Siehe Dokumentation zu Filterkriterien) |
|
|
Ergebnisanzahl
|
$top | string |
(Standardwert ist 5.000. Maximal 10.000) |
|
|
Paging
|
paging | boolean |
(Gibt die Ergebnisse auf Seiten zurück; Der Standardwert ist false) |
|
|
Pagingtoken
|
$skiptoken | string |
(Für Pagingzwecke; von vorherigen Anrufen als "weiter" zurückgegeben) |
|
|
Rückgabeinformationen
|
returnInfo | string |
alle geben Gruppennamen zurück. Der Standardwert ist leer, um nur IDs zurückzugeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of string |
Abrufen von Repositoryinformationen
Abrufen von Repositoryinformationen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Beginnt mit ca-) |
Abrufen von Zugriffsrechten für unhidden Cab-Gruppen
Abrufen von Zugriffsrechten für unhidden Cab-Gruppen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
verwalten
|
administer | boolean | |
|
cabDefault
|
cabDefault | boolean | |
|
edit
|
edit | boolean | |
|
name
|
name | string | |
|
noAccess
|
noAccess | boolean | |
|
Haupt
|
principal | string | |
|
Freigeben
|
share | boolean | |
|
Ansicht
|
view | boolean |
Aktualisieren eines Arbeitsbereichs
Aktualisieren eines Arbeitsbereichs
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Arbeitsbereichs-ID
|
workspaceID | True | string |
Arbeitsbereichs-ID |
Benutzer erstellen
Erstellen eines Benutzers in einem Repository
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Nutzername
|
username | True |
(Identisch mit der E-Mail-Adresse des Benutzers) |
|
|
Vorname
|
displayFirstName | True | string |
Vorname |
|
Zweiter Vorname
|
displayMiddleName | string |
Zweiter Vorname |
|
|
Nachname
|
displayLastName | True | string |
Nachname |
|
E-Mail-Adresse
|
True |
E-Mail-Adresse |
||
|
Der Benutzer ist extern.
|
external | True | boolean |
(Gilt nur für add) |
|
Willkommens-E-Mail senden
|
sendWelcome | True | boolean |
Willkommens-E-Mail senden |
|
Repository-ID
|
repository | True | string |
(Beginnt mit ca-) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzeigename
|
displayName | string | |
|
E-Mail
|
|||
|
id
|
id | string | |
|
äußerlich
|
external | boolean |
Benutzer zum Repository hinzufügen oder daraus entfernen
Benutzer zum Repository hinzufügen oder daraus entfernen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Beginnt mit ca-) |
|
Benutzer hinzufügen oder entfernen
|
action | True | string |
Benutzer hinzufügen oder entfernen |
|
Benutzer-ID
|
member | True | string |
Benutzer-ID |
|
Der Benutzer ist extern.
|
external | True | boolean |
Der Benutzer ist extern. |
|
Benutzer löschen (wenn Partnerverbund)
|
deleteIfFederated | boolean |
(Gilt nur für entfernen) |
Cab-Gruppen abrufen
Abrufen aller Gruppen, die einer Kabinett hinzugefügt wurden
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
Id | string | |
|
Name
|
Name | string | |
|
External
|
External | boolean | |
|
Versteckt
|
Hidden | boolean |
CollabSpace erstellen
Erstellen eines neuen CollabSpace
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Arbeitsbereichs-ID
|
workspaceID | True | string |
Arbeitsbereichs-ID |
|
CollabSpace-Name
|
name | True | string |
CollabSpace-Name |
|
Description
|
description | string |
Description |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
Id | string | |
|
EnvUrl
|
EnvUrl | string |
Datei oder Aufheben der Datei des Dokuments im Ordner
Datei eines Elements in einem Ordner oder Aufheben der Datei eines Elements aus einem Ordner.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ordner-ID
|
id | True | string |
12-stellige Ordner-ID. |
|
Dokument-ID
|
item | True | string |
12-stellige Dokument-ID. |
|
Datei oder Datei aufheben
|
action | True | string |
Datei oder Datei aufheben |
Dokument aktualisieren
Aktualisieren des Inhalts eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Dokumenterweiterung
|
extension | string |
Nur erforderlich, wenn die Erweiterung des Dokuments geändert wird. Schließen Sie den vorangestellten Zeitraum nicht ein. |
|
|
Base64-codiert?
|
base64 | boolean |
Base64-codiert? |
|
|
Dokumentinhalt aktualisiert
|
body | True | byte |
Der Inhalt des Dokuments. |
Dokument auschecken
Auschecken eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Kommentar
|
comment | string |
Kommentar |
|
|
Dokument herunterladen
|
download | boolean |
Gibt den Dokumentinhalt zurück. |
|
|
Version zum Herunterladen
|
version | string |
Gibt an, welche Inhalte der Version heruntergeladen werden sollen. Standardmäßig wird die offizielle Version verwendet. |
|
|
Zu zuletzt hinzugefügt
|
addToRecent | boolean |
Zu zuletzt hinzugefügt |
Dokument entsperren
Ausdocken des Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
Dokument-ID |
Dokument erstellen
Ein neues Dokument erstellen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestimmungsort
|
destination | True | string |
Die 12-stellige ID oder EnvID des Ordners, Filters oder Arbeitsbereichs. |
|
Dokumentinhalt
|
file | True | file |
Fügen Sie den Dateinamen plus die Erweiterung im zugehörigen Dateinamenfeld ein. |
|
Zu zuletzt hinzugefügt
|
addToRecent | boolean |
Zu zuletzt hinzugefügt |
|
|
Dokumentprofil
|
profile | string |
Festlegen des Dokumentprofils (JSON-Format) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
Erweiterung
|
extension | string | |
|
name
|
name | string |
Dokument folgen
Empfangen von Warnungen, wenn das Dokument aktualisiert wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Empfänger
|
recipients | True | string |
Mindestens eine gültige E-Mail-Adresse, die durch Semikolons getrennt ist. Duplikate werden ignoriert. |
|
Send
|
send | string |
Welche Kategorie von Benutzern die Benachrichtigung erhalten soll. |
Dokument löschen
Löschen eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Dauerhaft löschen
|
permanent | boolean |
Gibt an, dass das Dokument dauerhaft gelöscht werden soll, anstatt in gelöschte Elemente verschoben zu werden. |
Dokument sperren
Dokument sperren
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
Dokument-iD |
|
Kommentar
|
comment | string |
Kommentar |
Dokument umbenennen
Umbenennen eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Neuer Name
|
name | True | string |
Dokumentprofil abrufen
Abrufen von Informationen zu einem Dokument
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
Dokumentverlauf
Abrufen einer Liste von Aktionen für ein Dokument
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
Dokumentversion sperren
Dokumentversion sperren
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Dokumentversion
|
version | True | integer |
Dokumentversion |
|
Versionsbeschreibung
|
description | string |
Versionsbeschreibung |
Durchsuchen einer Kabinett und Ändern von ACLs
Durchsuchen einer Kabinett und Ändern von ACLs
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
|
Query
|
q | True | string |
(Überprüfen Sie die Dokumentation für das Abfrageformat) |
|
ACL-Modus ändern
|
mode | True | string |
ACL-Modus ändern |
|
Neue ACL
|
newAcl | True | string |
(Lesen Sie die Dokumentation für das richtige JSON-Format. |
|
E-Mail-Adresse
|
(Stattdessen Benachrichtigung an diese Adresse senden) |
|||
|
Senden von Abschluss-E-Mails
|
completionEmail | string |
(true = immer senden (Standard), false = nicht senden, fail = nur bei Fehler senden) |
Durchsuchen eines oder mehrerer Cabs
Durchsuchen eines oder mehrerer Cabs
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kabinette
|
cabinets | True | string |
(durch Trennzeichen getrennt) |
|
Query
|
q | True | string |
(Überprüfen Sie die Dokumentation für das Abfrageformat) |
|
Zurückzugebende Informationen
|
select | True | string |
(Lesen Sie die Dokumentation für das Rückgabeformat. |
|
Bestellung nach
|
orderby | string |
(Format: Feld#|Desc oder Feld#|asc) |
|
|
Anzahl der zurückzugebenden Ergebnisse (Standardwert: 50)
|
top | integer |
(Maximal 500 pro Seite) |
|
|
Anzahl der zu überspringenden Ergebnisse
|
skip | integer |
Anzahl der zu überspringenden Ergebnisse |
|
|
Token zum Paginieren von Ergebnissen
|
skiptoken | string |
Token zum Paginieren von Ergebnissen |
Einchecken eines Dokuments
Einchecken eines ausgecheckten Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Dokumenterweiterung
|
extension | string |
Schließen Sie den vorangestellten Zeitraum nicht ein. |
|
|
Dokumentinhalt
|
file | file |
Das Dokument in mehrteiliger Form. |
|
|
Zu zuletzt hinzugefügt
|
addToRecent | boolean |
Zur Liste der zuletzt verwendeten Dokumente des Benutzers hinzufügen. |
Erstellen des Ordners
Erstellen eines neuen Ordners
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ordnername
|
name | True | string |
Ordnername. |
|
Übergeordnete ID
|
parent | string |
12-stellige ID oder EnvID des übergeordneten Containers des neuen Ordners. |
|
|
Cab-ID
|
cabinet | string |
(Es beginnt mit NG-) Kann weggelassen werden, wenn eine Ordner- oder Arbeitsbereichs-ID im übergeordneten Element angegeben ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
standardAttributes.id | string | |
|
name
|
standardAttributes.name | string |
Erstellen einer externen Cab-Gruppe
Erstellen einer externen Cab-Gruppe
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
|
Gruppenname
|
name | True | string |
Gruppenname |
|
Gruppenoptionen
|
options | string |
Gruppenoptionen |
|
|
Cab-Standardzugriff
|
access | string |
Cab-Standardzugriff |
|
|
CollabSpace-ID
|
collaborationSpaceId | string |
(Um dies zu einer CollabSpace-externen Gruppe zu machen) |
|
|
CollabSpace-Zugriff
|
collaborationspaceaccess | string |
CollabSpace-Zugriff |
|
|
Attributwert des obersten Arbeitsbereichs
|
topwsattributegroupkey | string |
(Bei regulären externen Cab-Gruppen; um die Gruppe einem bestimmten Attributwert des obersten Arbeitsbereichs zuzuordnen) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Typ
|
Type | integer | |
|
Id
|
Id | string | |
|
Name
|
Name | string | |
|
Options
|
Options | string | |
|
Zugang
|
Access | string |
Erstellen einer neuen Version eines Dokuments
Erstellen einer neuen Version eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Dokumenterweiterung
|
extension | string |
Schließen Sie den vorangestellten Zeitraum nicht ein. |
|
|
Versionsbeschreibung
|
version_description | string |
Versionsbeschreibung |
|
|
Name der neuen Version
|
verName | string |
Name der neuen Version |
|
|
Offizielle Version erstellen
|
official | boolean |
Die neue Version ist nicht die offizielle Version, wenn dieser Parameter nicht festgelegt ist. |
|
|
Zu zuletzt verwendeten Dokumenten hinzufügen
|
addToRecent | boolean |
Zu zuletzt verwendeten Dokumenten hinzufügen |
|
|
Quellversionsnummer
|
srcVer | string |
Wenn Sie den Inhalt aus einer früheren Version kopieren, welche Version des Dokuments kopiert werden soll. |
|
|
Als Unterversion erstellen
|
allocatesubversion | boolean |
Erstellen Sie als Subversion statt als Vollversion. |
|
|
Inhalt eines neuen Versionsdokuments
|
body | binary |
Der Inhalt der neuen Version, wenn keine andere Version oder die offizielle Version kopiert wird. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
latestVersionNumber
|
latestVersionNumber | integer | |
|
newVer
|
newVer | integer | |
|
newVersionLabel
|
newVersionLabel | string | |
|
officialVer
|
officialVer | integer | |
|
officialVerName
|
officialVerName | string | |
|
versions
|
versions | integer |
Erstellen oder Aktualisieren eines Nachschlagetabelleneintrags
Erstellen oder Aktualisieren eines Nachschlagetabelleneintrags
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Attribut-ID
|
attributeID | True | string |
(Entfernen sie die führende '10') |
|
Key
|
parentID | True | string |
Key |
|
Description
|
description | string | ||
|
Typ
|
defaulting | string | ||
|
Aufbewahrung für eventuelle Rechtsstreitigkeiten
|
hold | boolean | ||
|
Geschlossen am
|
closed | string |
Format '/Date(Anzahl der Millis vom 1. Januar 1970+-UTC', z. B.: '/Date(1582261200000-0500)/' |
|
|
Gefilterte Berechtigungen
|
filtered_permissions | True | boolean | |
|
Erzwingen von Permssionen
|
force_permissions | True | boolean | |
|
Ansicht
|
view | True | boolean | |
|
Bearbeiten
|
edit | True | boolean | |
|
Teilen
|
share | True | boolean | |
|
Verwalten
|
administer | True | boolean | |
|
Kein Zugriff
|
noAccess | True | boolean | |
|
Cab-Standard
|
cabDefault | True | boolean | |
|
Schulleiter
|
principal | True | string |
(Benutzer- oder Gruppen-ID) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
count
|
count | integer |
Erstellen oder Aktualisieren eines untergeordneten Nachschlagetabelleneintrags
Erstellen oder Aktualisieren eines untergeordneten Nachschlagetabelleneintrags
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Untergeordnete Attribut-ID
|
childAttributeID | True | string |
(Entfernen sie die führende '10') |
|
Übergeordneter Schlüssel
|
parentID | True | string |
Übergeordneter Schlüssel |
|
Untergeordneter Schlüssel
|
childID | True | string |
Untergeordneter Schlüssel |
|
Description
|
description | string | ||
|
Typ
|
defaulting | string | ||
|
Aufbewahrung für eventuelle Rechtsstreitigkeiten
|
hold | boolean | ||
|
Geschlossen am
|
closed | string |
Format '/Date(Anzahl der Millis vom 1. Januar 1970+-UTC', z. B.: '/Date(1582261200000-0500)/' |
|
|
Gefilterte Berechtigungen
|
filtered_permissions | True | boolean | |
|
Erzwingen von Permssionen
|
force_permissions | True | boolean | |
|
Ansicht
|
view | True | boolean | |
|
Bearbeiten
|
edit | True | boolean | |
|
Teilen
|
share | True | boolean | |
|
Verwalten
|
administer | True | boolean | |
|
Kein Zugriff
|
noAccess | True | boolean | |
|
Cab-Standard
|
cabDefault | True | boolean | |
|
Schulleiter
|
principal | True | string |
(Benutzer- oder Gruppen-ID) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
count
|
count | integer |
Gesicherten Link erstellen
Generieren eines Links zu einem Dokument, auf das von jedem Benutzer zugegriffen werden kann
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
id | True | string |
12-stellige Dokument-ID. |
|
Kennwort für den gesicherten Link
|
password | string |
Je nach Cab-Konfiguration kann das Kennwort optional oder obligatorisch sein. |
|
|
Ablaufdatum für gesicherten Link.
|
expirationdate | string |
Eingabeformat: yyyy-MM-tt. |
|
|
Version des Dokuments
|
version | string |
Welche Version des Dokuments freigegeben werden soll. Wenn leer, wird die offizielle Version freigegeben. |
|
|
Dokument herunterladen
|
download | boolean |
Wenn true, kann das Dokument vom Empfänger heruntergeladen werden. |
|
|
Mich benachrichtigen
|
notifyme | boolean |
Wenn true, benachrichtigen Sie den Absender, wenn auf den gesicherten Link zugegriffen wird. |
|
|
Dokument sperren
|
lock | boolean |
Sperren Sie optional die ausgewählte Version des Dokuments. Dies erfordert Bearbeitungsrechte. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ansicht
|
standardAttributes.view | string | |
|
Download verfügbar ist
|
standardAttributes.download | string |
Gruppenmitgliedschaft abrufen
Gruppenmitgliedschaft abrufen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Gruppen-ID
|
groupID | True | string |
(Beginnt mit UG-) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
Anzeigename
|
displayName | string | |
|
id
|
id | string |
Hinzufügen oder Entfernen einer Gruppe aus cab
Hinzufügen einer Gruppe zu Cab- und Standardzugriffsrechten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabinetID | True | string |
(Es beginnt mit NG-) |
|
Gruppe hinzufügen oder entfernen
|
action | True | string |
Gruppe hinzufügen oder entfernen |
|
Gruppen-ID
|
id | True | string |
Gruppen-ID (beginnt mit UG-). |
|
Rechte anzeigen
|
view | True | boolean |
Rechte anzeigen (V) – Nur für das Hinzufügen. |
|
Bearbeiten von Rechten
|
edit | True | boolean |
Bearbeitungsrechte (E) – Nur für das Hinzufügen. |
|
Freigaberechte
|
share | True | boolean |
Freigaberechte (S) – Nur für das Hinzufügen. |
|
Verwalten von Rechten
|
administer | True | boolean |
Verwalten von Rechten (A) – Nur für das Hinzufügen. |
|
Keine Zugriffsrechte
|
noAccess | True | boolean |
Keine Zugriffsrechte (N) – nur für das Hinzufügen. |
Hinzufügen oder Entfernen eines Gruppenmitglieds
Hinzufügen oder Entfernen eines Gruppenmitglieds
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Gruppen-ID
|
groupID | True | string |
(Beginnt mit UG-) |
|
Hinzufügen oder Entfernen des Benutzers
|
action | True | string |
Hinzufügen oder Entfernen des Benutzers |
|
Benutzer-ID
|
member | True | string |
(Muss bereits Mitglied des Repositorys sein.) |
Liste der Benutzerschränke abrufen
Abrufen von Benutzerschränken
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
isCollaborationSpacesEnabled
|
isCollaborationSpacesEnabled | string | |
|
name
|
name | string | |
|
repositoryId
|
repositoryId | string | |
|
repositoryName
|
repositoryName | string | |
|
wsAttrNum
|
wsAttrNum | integer | |
|
wsOrgAttrNum
|
wsOrgAttrNum | integer |
Löschen eines Nachschlagetabelleneintrags
Löschen eines Nachschlagetabelleneintrags
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Attribut-ID
|
attributeID | True | string |
(Entfernen sie die führende '10') |
|
Key
|
parentID | True | string |
Key |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
count
|
count | integer |
Löschen eines untergeordneten Nachschlagetabelleneintrags
Löschen eines untergeordneten Nachschlagetabelleneintrags
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Untergeordnete Attribut-ID
|
childAttributeID | True | string |
(Entfernen sie die führende '10') |
|
Übergeordneter Schlüssel
|
parentID | True | string |
Übergeordneter Schlüssel |
|
Untergeordneter Schlüssel
|
childID | True | string |
Untergeordneter Schlüssel |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
count
|
count | integer |
Nach Nachschlagetabelleneinträgen suchen
Nach Nachschlagetabelleneinträgen suchen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Attribut-ID
|
attributeID | True | string |
(Entfernen sie die führende '10') |
|
Filter
|
$filter | string |
(Weitere Informationen finden Sie in der Dokumentation zu den verfügbaren Filtern) |
|
|
Abzurufende Felder
|
$select | string |
(Schließen Sie eine durch Trennzeichen getrennte Liste von: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user' und/oder 'access' ein) |
|
|
Anzahl der übereinstimmenden Datensätze, die übersprungen werden sollen
|
$skip | integer |
(Dies wird beim Abrufen mehrerer Ergebnisblöcke verwendet.) |
|
|
Maximale Anzahl der zurückzugebenden Datensätze
|
$top | integer |
Maximale Anzahl der zurückzugebenden Datensätze |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeilen
|
rows | array of object | |
|
unterlassend
|
rows.defaulting | string | |
|
Beschreibung
|
rows.description | string | |
|
halten
|
rows.hold | boolean | |
|
key
|
rows.key | string | |
|
geschlossen
|
rows.closed | string | |
|
Zugang
|
rows.access | string |
Ordner folgen
Empfangen von Benachrichtigungen, wenn einem Ordner neue Inhalte hinzugefügt werden
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ordner-ID
|
id | True | string |
12-stellige Ordner-ID. |
|
Empfänger
|
recipients | True | string |
Mindestens eine gültige E-Mail-Adresse, die durch Semikolons getrennt ist. Duplikate werden ignoriert. |
|
Send
|
send | string |
Welche Kategorie von Benutzern die Benachrichtigung erhalten soll. |
Ordner löschen
Löschen eines Ordners
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ordner-ID
|
id | True | string |
12-stellige Ordner-ID. |
|
Dauerhaft löschen
|
permanent | boolean |
Gibt an, dass der Ordner dauerhaft gelöscht werden soll, anstatt in "Gelöschte Elemente" verschoben zu werden. Der Inhalt des Ordners, einschließlich untergeordneter Unterordner, wird nicht dauerhaft gelöscht. |
|
|
Ordnerinhalte löschen
|
deleteContents | boolean |
Gibt an, dass die Dokumente im gelöschten Ordner (und in jedem untergeordneten Unterordner) ebenfalls gelöscht werden sollen, anstatt einfach nicht abgelegt zu werden. |
Ordner umbenennen
Umbenennen eines Ordners
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ordner-ID
|
id | True | string |
12-stellige Ordner-ID. |
|
Neuer Name
|
name | True | string |
Repositorygruppe erstellen
Erstellen einer Repositorygruppe
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Gruppenname
|
name | True | string |
Gruppenname |
|
External
|
external | True | boolean |
External |
|
In Listen ausblenden
|
hidden | True | boolean |
In Listen ausblenden |
|
Ausgeblendete Mitgliedschaft
|
hideMembership | True | boolean |
Ausgeblendete Mitgliedschaft |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
äußerlich
|
external | boolean | |
|
ausgeblendet
|
hidden | boolean | |
|
hideMembership
|
hideMembership | boolean | |
|
id
|
id | string | |
|
name
|
name | string |
Repositorygruppe löschen
Löschen einer Repositorygruppe
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Er beginnt mit ca-) |
|
Gruppen-ID
|
groupID | True | string |
(Beginnt mit UG-) |
Repositoryprotokoll abrufen
Repositoryprotokoll abrufen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryID | True | string |
(Beginnt mit ca-) |
|
Startdatum/-uhrzeit
|
start | string |
(Standardwert ist 30 Tage; Format jjjj-MM-tt oder yyyy-MM-ddThh:mm:ssZ) |
|
|
Enddatum/Uhrzeit
|
end | string |
(Dasselbe Format wie "Start"; Standardeinstellungen für "Heute") |
|
|
Protokolltyp
|
Logtype | True | string |
Protokolltyp |
Trigger
| Kabinett durchsuchen |
Durchsuchen des angegebenen Schranks |
Kabinett durchsuchen
Durchsuchen des angegebenen Schranks
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cab-ID
|
cabId | True | string |
(Es beginnt mit NG-) |
|
Suchkriterien
|
q | True | string |
Verwenden Sie das gleiche Format und dieselben Operatoren wie in der NetDocuments-Webschnittstelle. |
|
Bestellung nach
|
$orderby | string |
Bestellung nach |
|
|
Maximale Anzahl von Ergebnissen
|
$top | string |
Eine ganze Zahl zwischen 1 und 500. Der Standardwert ist 100. |
|
|
Zurückzugebende Attribute
|
$select | string |
Eine durch Trennzeichen getrennte Liste von Attributwerten. Weitere Informationen finden Sie in der REST-API-Dokumentation. |