Freigeben über


Content Manager Power Connect

Content Manager ist ein governancebasiertes Enterprise Content Management-System, das Behörden, regulierte Branchen und globale Organisationen dabei unterstützt, ihre Geschäftsinhalte von der Erstellung bis zur Entsorgung zu verwalten. Stellen Sie eine Verbindung mit Dem Inhalts-Manager her, um Aktionen auszuführen, z. B. Das Erstellen oder Aktualisieren von Datensätzen oder Speicherorten, das Hochladen oder Herunterladen elektronischer Dateien, das Suchen und vieles mehr. (1.0.4.757)

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 Kapish Services Pty Ltd
URL https://kapish.com.au/products/power_connect/
Email sales@kapish.com.au
Connectormetadaten
Herausgeber Kapish Services Pty Ltd
Webseite https://kapish.com.au/products/power_connect/
Datenschutzrichtlinie https://kapish.com.au/products/privacy-policy/
Kategorien Daten; Inhalt und Dateien

Der Content Manager Power Connect von Kapish ist ein Connector, der Automatisierungs- und Integrationsfunktionen in Content Manager bereitstellt, um die Fähigkeit Ihrer Organisation zur Erfüllung seiner Informationsverwaltungs- und Governanceanforderungen zu optimieren.

Voraussetzungen

  • Eine extern zugängliche Content Manager ServiceAPI
  • Ein Abonnementschlüssel, der von Kapish Services Pty Ltd bereitgestellt wird

Eine detaillierte Liste der Spezifikationen und Anforderungen oder weitere Informationen dazu, wie der Connector Ihrer Organisation helfen kann, wenden Sie sich bitte an kapish Services Pty Ltd.

Eine Verbindung wird erstellt

Der Connector unterstützt die folgenden Authentifizierungstypen:

OAuth (Vertraulicher Clientfluss) Verwenden von OAuth zum Herstellen einer Verbindung mit dem Inhalts-Manager Alle Regionen Nicht teilbar
Vom System verwaltete Systeme Verwenden eines Benutzernamens und kennworts zum Herstellen einer Verbindung mit Dem Inhalts-Manager Alle Regionen Nicht teilbar
Standard [VERALTET] Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt. Alle Regionen Nicht teilbar

OAuth (Vertraulicher Clientfluss)

Authentifizierungs-ID: OAuth

Anwendbar: Alle Regionen

Verwenden von OAuth zum Herstellen einer Verbindung mit dem Inhalts-Manager

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
KPC-Abonnementschlüssel securestring Der API-Schlüssel für den Zugriff auf Kapish Power Connect Richtig
CM ServiceAPI-URL (z. B. https://myserver/CMServiceAPI/) Schnur Die URL, unter der Ihre CM ServiceAPI erreicht werden kann Richtig
Autorisierungsserver-URL (z. B. https://myserver/adfs/oauth2/token) Schnur Die URL zum Abrufen des Zugriffstokens Richtig
Kunden-ID Schnur Die Client-ID für die Authentifizierung Richtig
Geheimer Clientschlüssel securestring Der geheime Clientschlüssel für die Authentifizierung Richtig

Vom System verwaltete Systeme

Authentifizierungs-ID: Einfach

Anwendbar: Alle Regionen

Verwenden eines Benutzernamens und kennworts zum Herstellen einer Verbindung mit Dem Inhalts-Manager

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
KPC-Abonnementschlüssel securestring Der API-Schlüssel für den Zugriff auf Kapish Power Connect Richtig
CM ServiceAPI-URL (z. B. https://myserver/CMServiceAPI/) Schnur Die URL, unter der Ihre CM ServiceAPI erreicht werden kann Richtig
Benutzername Schnur Der Benutzername für die Authentifizierung Richtig
Kennwort securestring Das Kennwort für die Authentifizierung Richtig

Standard [VERALTET]

Anwendbar: Alle Regionen

Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt.

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
KPC-Abonnementschlüssel securestring Der API-Schlüssel für den Zugriff auf Kapish Power Connect Richtig
CM ServiceAPI-URL (z. B. https://myserver/CMServiceAPI/) Schnur Die URL, unter der Ihre CM ServiceAPI erreicht werden kann Richtig
Autorisierungsserver-URL (z. B. https://myserver/adfs/oauth2/token) Schnur Die URL zum Abrufen des Zugriffstokens Richtig
Kunden-ID Schnur Die Client-ID für die Authentifizierung Richtig
Geheimer Clientschlüssel securestring Der geheime Clientschlüssel für die Authentifizierung Richtig

Drosselungsgrenzwerte

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

Aktionen

Datei von URL abrufen

Herunterladen einer Datei von URL in einen Stagingbereich mithilfe des CM-Dienst-API-Plug-Ins "GetFileFromUrl"

Datensatz aktualisieren (Access-Steuerelemente hinzufügen)

AddAccessControl

Datensatz aktualisieren (Aktion neu zuweisen)

Zuweisen der nominierten Aktion zu einem angegebenen Speicherort

Datensatz aktualisieren (Aktion oder Prozedur anfügen)

Anfügen einer Aktion oder Prozedur an einen Datensatz

Datensatz aktualisieren (Aktionen neu planen)

Plant alle an diesen Datensatz angefügten Aktionen neu.

Datensatz aktualisieren (Alle Aktionen entfernen)

Entfernt alle Aktionen, die dem angegebenen Datensatz zugeordnet sind.

Datensatz aktualisieren (Anforderungsdarstellung)

Ermöglicht es Ihnen, eine Anforderung für das automatische Renderingmodul zu erstellen, um eine Darstellung eines Datensatzes vorzunehmen.

Datensatz aktualisieren (Auschecken)

Festlegen des Status des ausgecheckten Datensatzes

Datensatz aktualisieren (Auschecken rückgängig machen)

Rückgängigmachen eines vorherigen Auscheckens des elektronischen Dokuments für diesen Datensatz, wobei alle änderungen ignoriert werden, die seit dem Auschecken vorgenommen wurden

Datensatz aktualisieren (Benutzerbezeichnung festlegen)

Ermöglicht die Einstellung einer Benutzerbezeichnung für einen Datensatz.

Datensatz aktualisieren (Dispose)

Löschen eines Datensatzes

Datensatz aktualisieren (Eigenschaften)

Aktualisieren eines Datensatzes

Datensatz aktualisieren (Elektronische Datei anfügen)

Anfügen einer elektronischen Datei an einen Datensatz

Datensatz aktualisieren (erneut öffnen)

Verwenden Sie die Funktion "Erneut öffnenDatensatz", um einen geschlossenen Container erneut zu öffnen. Da beim erneuten Öffnen eines Datensatzes möglicherweise viele enthaltene Datensätze aktualisiert werden müssen, führt diese Funktion automatisch einen Commit für die Änderungen durch.

Datensatz aktualisieren (erweitert)

Aktualisieren eines Datensatzes mit erweiterten Eigenschaften

Datensatz aktualisieren (Finalise)

Aktualisieren eines Entwurfsdatensatzes

Datensatz aktualisieren (Klassifizierung)

Aktualisieren der Klassifizierung eines Datensatzes

Datensatz aktualisieren (Kontakt anfügen)

Anfügen eines Kontakts an einen Datensatz

Datensatz aktualisieren (Schließen)

Verwenden Sie die CloseRecord-Funktion, um einen Container zu schließen – lassen Sie das Datum leer, wenn das Schließdatum "jetzt" sein soll. Da das Schließen eines Datensatzes möglicherweise eine Aktualisierung vieler enthaltener Datensätze erfordert, führt diese Funktion automatisch einen Commit für die Änderungen durch.

Datensatz aktualisieren (Set Assignee)

Festlegen des Zuweisenden auf einen bestimmten Speicherort, zurück zur Startseite oder registrieren als fehlt

Datensatz aktualisieren (Speicherort aus Access-Steuerelementen entfernen)

RemoveAccessControl

Datensatz aktualisieren (Thesaurusausdruck anfügen)

Anfügen eines Thesaurusausdrucks an einen Datensatz

Datensatz aktualisieren (Undispose)

Gibt den Status des Datensatzes (und eines seiner Inhalte) zurück, sodass er nicht mehr verworfen wird.

Datensatz aktualisieren (unfinalise - Als Entwurf festlegen)

Aktualisieren eines abgeschlossenen Datensatzes auf "Entwurf"

Datensatz aktualisieren (Vollständige Aktionen)

Ausführen einer oder aller Aktionen, die für einen bestimmten Datensatz fällig sind

Datensatz aktualisieren (Zugriff uneingeschränkt festlegen oder auf Container basieren)

InheritAccessControl

Datensatz aktualisieren (Zugriffssteuerelemente ersetzen)

SetAccessControl

Datensatz aktualisieren (zusätzliche Felder)

Aktualisieren zusätzlicher Felder für einen Datensatz

Datensatz erstellen (Dokument)

Erstellen eines Datensatzes

Datensatz erstellen (erweitert)

Erstellen eines Datensatzes mit erweiterten Feldern

Datensatz erstellen (Ordner)

Erstellen eines Datensatzes

Datensatz löschen

Löschen eines Datensatzes

Datensatz nach ID suchen

Abrufen eines einzelnen Datensatzes nach eindeutiger ID oder Name

Datensätze suchen

Nach Datensätzen suchen (Abrufen einer Sammlung von Datensätzen mithilfe einer Suchzeichenfolge)

Eindeutige ID der Standortadresse suchen

Abrufen der eindeutigen ID der untergeordneten Adresse eines Speicherorts

Elektronische Datei herunterladen

Herunterladen einer elektronischen Datei eines Datensatzes

Elektronische Datei hochladen

Hochladen einer elektronischen Datei, die später an einen Datensatz angefügt werden kann

Ereignisdaten lesen

Transformieren von Kapish Dispatch-Ereignisdaten für den Flussverbrauch

Ort erstellen (Person)

Erstellen eines Personenspeicherorts

Speicherort aktualisieren (Adresse)

Erstellen/Aktualisieren der Adresse eines Speicherorts mithilfe der eindeutigen ID der Adresse

Speicherort aktualisieren (Person)

Aktualisieren eines Personenspeicherorts mithilfe seines eindeutigen Bezeichners

Speicherort aktualisieren (zusätzliche Felder)

Aktualisieren zusätzlicher Felder an einem Speicherort

Speicherort erstellen (sonstige)

Erstellen eines Speicherorts eines beliebigen Typs

Speicherort nach ID suchen

Abrufen eines einzelnen Speicherorts nach eindeutiger ID oder Name

Speicherorte suchen

Suchen nach Speicherorten (Abrufen einer Sammlung von Speicherorten mithilfe einer Suchzeichenfolge)

Suchen von CM-Objekten

Suchen nach CM-Objekten

Suchen von Datensätzen (Erweitert)

Suchen nach Datensätzen (Abrufen einer Sammlung von Datensätzen mithilfe einer Suchzeichenfolge). Gibt eine unformatierte Content Manager ServiceAPI-Antwort zurück.

Updatespeicherort (sonstige)

Aktualisieren eines Speicherorts

Datei von URL abrufen

Herunterladen einer Datei von URL in einen Stagingbereich mithilfe des CM-Dienst-API-Plug-Ins "GetFileFromUrl"

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
URL der Datei
url True string

Nicht codierte URL der herunterzuladenden Datei

Dateiname zum Speichern unter
filename string

Dateiname zum Speichern der heruntergeladenen URL als (nur der Dateiname mit Suffix, schließen Sie nicht das vollständige Verzeichnis ein)

Inhaltstyp
contentType string

Typische Zeichenfolge in den meisten Inhaltstyp-Headern (z. B. Bild/PNG, Text/Nur-Text, Anwendung/PDF).

Gibt zurück

Antwort vom CM-Dienst-API-Plug-In "GetFileFromUrl".

Datensatz aktualisieren (Access-Steuerelemente hinzufügen)

AddAccessControl

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner
Uri True integer
FunctionEnum
FunctionEnum string
Eindeutige ID
Uri integer

Eindeutiger Standortbezeichner

Gibt zurück

Datensatz aktualisieren (Aktion neu zuweisen)

Zuweisen der nominierten Aktion zu einem angegebenen Speicherort

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Neuer Assignee
NewAssignee True string

Eindeutige ID oder E-Mail-Adresse des neuen Assignee

Aktion, die neu zugewiesen werden soll
RecordActionUri True integer
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Aktion oder Prozedur anfügen)

Anfügen einer Aktion oder Prozedur an einen Datensatz

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Anfügende Aktion
ActionToAttach True integer
Assignee Unique ID
NewAssignee integer
Assignee-Option
AssigneeOption string
Startdatum planen
ScheduleStartDate date
Vorhandene Aktion
RecordAction integer
Position einfügen
InsertPos string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Aktionen neu planen)

Plant alle an diesen Datensatz angefügten Aktionen neu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Vom Basisdatum
FromBaseDate date
Aktuelle Dauer verwenden
UseActualDurations boolean
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Alle Aktionen entfernen)

Entfernt alle Aktionen, die dem angegebenen Datensatz zugeordnet sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Anforderungsdarstellung)

Ermöglicht es Ihnen, eine Anforderung für das automatische Renderingmodul zu erstellen, um eine Darstellung eines Datensatzes vorzunehmen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Darstellungstyp
RenditionType True string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Auschecken)

Festlegen des Status des ausgecheckten Datensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Kommentare
Comments string
Auscheckpfad speichern unter
SaveCheckoutPathAs string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Auschecken rückgängig machen)

Rückgängigmachen eines vorherigen Auscheckens des elektronischen Dokuments für diesen Datensatz, wobei alle änderungen ignoriert werden, die seit dem Auschecken vorgenommen wurden

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Kommentare
Comments string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Benutzerbezeichnung festlegen)

Ermöglicht die Einstellung einer Benutzerbezeichnung für einen Datensatz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Datensatz
Uri True integer

Die eindeutige ID des Datensatzes, an den die Benutzerbezeichnung angefügt werden soll

Benutzerkennsatz
UserLabel True string

Die eindeutige ID oder der Name der anzuwendenden Benutzerbezeichnung

Lieblingstyp
FavouriteType string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Dispose)

Löschen eines Datensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Fahren Sie mit dem Fehler fort?
ContinueOnError boolean
Entsorgungsmethode
MethodOfDisposal string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Eigenschaften)

Aktualisieren eines Datensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri integer
Query
q string

Geben Sie hier eine Abfrage an, um das Update auf eine Gruppe von Datensätzen anstatt nur auf eine (wie durch die eindeutige ID angegeben) anzuwenden.

Titel (Freitextteil)
RecordTypedTitle string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Autor
RecordAuthor string

Eindeutige ID oder E-Mail-Adresse des Standorts

Container
RecordContainer string
Klassifizierung
RecordClassification string

Bereitstellen des eindeutigen Bezeichners der Klassifizierung

Empfänger
RecordAddressee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Alternativer Container
RecordAlternativeContainer string
Zugewiesene Person
RecordAssignee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Automatisches Rendern in PDF beim Speichern
RecordAutoRenderToPDFOnSave boolean
Umgangen mit Zugriffssteuerungen für Datensatztypen
RecordBypassRecordTypeAccessControls boolean
Einchecken als
CheckinAs string

Legen Sie die Source-Eigenschaft des elektronischen Dokuments fest.

Kunde
RecordClient string

Eindeutige ID oder E-Mail-Adresse des Standorts

Clientdatensatz
RecordClientRecord string
Dokument aus Datensatz kopieren
CopyDocumentFromRecord string

Geben Sie eine eindeutige ID für den Datensatz an, aus dem das elektronische Dokument für diesen Datensatz kopiert werden soll.,

Schöpfer
RecordCreator string

Eindeutige ID oder E-Mail-Adresse des Standorts

Erstellungsdatum
RecordDateCreated string
Fälligkeitsdatum
RecordDateDue string
Datum der Veröffentlichung
RecordDatePublished string
Empfangsdatum
RecordDateReceived string
Externe Referenz
RecordExternalReference string
Fehler bei Warnungen?
FailOnWarnings boolean

True, um ein Objekt nicht zu erstellen/zu speichern, wenn Warnungen vorhanden sind.

Dateiname im Ordner "Uploads"
RecordFilePath string

Der Dateiname, wie er im Ordner "Uploads" angezeigt wird.

Abschließen des Speichervorgangs
RecordFinalizeOnSave boolean
Fremdcodecode
RecordForeignBarcode string
GPS-Standort
RecordGpsLocation string
Startort
RecordHomeLocation string

Eindeutige ID des Speicherorts

Home Space
RecordHomeSpace string
Ist eingeschlossen
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Ausgecheckt bleiben
keepBookedOut boolean

True, um den Datensatz ausgecheckt zu lassen, nachdem das elektronische Dokument hochgeladen wurde.

Lange Zahl
RecordLongNumber string
Medientyp
RecordMediaType string
Hinweise
RecordNotes string
Notizenaktualisierungstyp
NotesUpdateType string
Anderer Kontakt
RecordOtherContact string

Eindeutige ID oder E-Mail-Adresse des Standorts

Besitzerspeicherort
RecordOwnerLocation string

Eindeutige ID oder E-Mail-Adresse des Standorts

Verwandter Datensatz
RecordRelatedRecord string
Verkäufer
RecordRepresentative string
Überprüfungsdatum
RecordReviewDate string
Fälligkeitsdatum überprüfen
RecordReviewDueDate string
Status überprüfen
RecordReviewState string
Sicherheit
RecordSecurity string

Gibt zurück

Datensatz aktualisieren (Elektronische Datei anfügen)

Anfügen einer elektronischen Datei an einen Datensatz

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Datei
File True file

Dateiinhalt/Textkörper des elektronischen Dokuments, das angefügt werden soll

Eindeutiger Bezeichner
Uri True string

Eindeutige ID des Datensatzes

Gibt zurück

Datensatz aktualisieren (erneut öffnen)

Verwenden Sie die Funktion "Erneut öffnenDatensatz", um einen geschlossenen Container erneut zu öffnen. Da beim erneuten Öffnen eines Datensatzes möglicherweise viele enthaltene Datensätze aktualisiert werden müssen, führt diese Funktion automatisch einen Commit für die Änderungen durch.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Fahren Sie mit dem Fehler fort?
ContinueOnError boolean
Ergebnisse protokollieren?
LogResults boolean

Gibt ein Textprotokoll der Datensätze zurück, die in der Protokollnachricht-Eigenschaft erneut geöffnet wurden?

Inhalt nicht definieren?
UnfinalizeContents boolean
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (erweitert)

Aktualisieren eines Datensatzes mit erweiterten Eigenschaften

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Datensatztyp
RecordRecordType string
Klassifizierung
RecordClassification string

Bereitstellen des eindeutigen Bezeichners der Klassifizierung

Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Autor
RecordAuthor string

Eindeutige ID oder E-Mail-Adresse des Standorts

Beitrittsnummer
RecordAccessionNumber string
Empfänger
RecordAddressee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Alternativer Container
RecordAlternativeContainer string
Zugewiesene Person
RecordAssignee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Konfidenzniveau der automatischen Klassifizierung
RecordAutoClassificationConfidenceLevel string
Automatisches Rendern in PDF beim Speichern
RecordAutoRenderToPDFOnSave boolean
Umgangen mit Zugriffssteuerungen für Datensatztypen
RecordBypassRecordTypeAccessControls boolean
Speichern umgehen?
ByPassSave boolean

True, um das Objekt nicht zu speichern. Eine Verwendung dieser Vorgehensweise besteht darin, eine oder mehrere Eigenschaften für einen Datensatzbeitrag festzulegen und das Dateneingabeformular zurückzugeben. Das Dateneingabeformular spiegelt dann die verschiedenen Eigenschaften wider, die für den ursprünglichen Datensatz festgelegt sind.

Position innerhalb der Favoriten ändern
ChangePositionWithinFavorites string

Wenn Sie nach Favoriten suchen, werden sie in dieser Reihenfolge zurückgegeben, es sei denn, eine andere Sortierung wird verwendet.

Position innerhalb der Benutzerbezeichnung ändern
ChangePositionWithinUserLabel string

Bei der Suche nach UserLabel werden sie in dieser Reihenfolge zurückgegeben, es sei denn, eine andere Sortierung wird verwendet.,

Einchecken als
CheckinAs string

Legen Sie die Source-Eigenschaft des elektronischen Dokuments fest.

Datensatzklasse
RecordClassOfRecord string
Kunde
RecordClient string

Eindeutige ID oder E-Mail-Adresse des Standorts

Clientdatensatz
RecordClientRecord string
Kommentare
comments string

Kommentare, die beim Hochladen des Dokuments in die Datensatznotizen eingefügt werden sollen.

Sendung
RecordConsignment string
Sendungsobjekt
RecordConsignmentObject string
Container
RecordContainer string
Dokument aus Datensatz kopieren
CopyDocumentFromRecord string

Geben Sie eine eindeutige ID für den Datensatz an, aus dem das elektronische Dokument für diesen Datensatz kopiert werden soll.,

Schöpfer
RecordCreator string

Eindeutige ID oder E-Mail-Adresse des Standorts

Erstellungsdatum
RecordDateCreated string
Fälligkeitsdatum
RecordDateDue string
Datum der Veröffentlichung
RecordDatePublished string
Empfangsdatum
RecordDateReceived string
Editor
RecordEditor string

Eindeutige ID oder E-Mail-Adresse des Standorts

Elektronischer Dokumentspeicher
RecordEStore string
Externe Referenz
RecordExternalReference string
Fehler bei Warnungen?
FailOnWarnings boolean

True, um ein Objekt nicht zu erstellen/zu speichern, wenn Warnungen vorhanden sind.

Dateiname im Ordner "Uploads"
RecordFilePath string

Der Dateiname, wie er im Ordner "Uploads" angezeigt wird.

Abschließen des Speichervorgangs
RecordFinalizeOnSave boolean
Fremdcodecode
RecordForeignBarcode string
GPS-Standort
RecordGpsLocation string
Startort
RecordHomeLocation string

Eindeutige ID des Speicherorts

Home Space
RecordHomeSpace string
Ist eingeschlossen
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Ausgecheckt bleiben
keepBookedOut boolean

True, um den Datensatz ausgecheckt zu lassen, nachdem das elektronische Dokument hochgeladen wurde.

Datum der letzten Aktion
RecordLastActionDate string
Lange Zahl
RecordLongNumber string
Aktiv machen
MakeActive string

Gibt den Status des Datensatzes (und eines seiner Inhalte) zurück, sodass er nicht mehr inaktiv ist. Beim Verarbeiten von Inhalten können Sie angeben, ob die Aufgabe angehalten werden soll, wenn Fehler auftreten.

Inaktiv machen
MakeInactive string

Legt "dateInactive" für diesen Datensatz und einen der zugehörigen Inhalte fest. Beim Verarbeiten von Inhalten können Sie angeben, ob die Aufgabe angehalten werden soll, wenn Fehler auftreten.

Neue Überarbeitung vornehmen
makeNewRevision boolean

True, um eine neue Revision mit diesem elektronischen Dokument false zu erstellen, um die aktuelle Revision zu ersetzen.

Manuelles Vernichtungsdatum
RecordManualDestructionDate string
Matter Record
RecordMatterRecord string
Medientyp
RecordMediaType string
Meine Autorisierungskommentare
RecordMyAuthorizationComments string
Meine Autorisierung abgeschlossen
RecordMyAuthorizationComplete boolean
Meine Rezensionskommentare
RecordMyReviewComments string
Meine Rezension abgeschlossen
RecordMyReviewComplete boolean
Benötigt Autorisierung?
RecordNeedsAuthorization boolean
Muss überprüft werden?
RecordNeedsReview boolean
Neue Webparterstellungsregel
RecordNewPartCreationRule string

Eindeutige ID der Autoparterstellungsregel

Hinweise
RecordNotes string
Notizenaktualisierungstyp
NotesUpdateType string
Anderer Kontakt
RecordOtherContact string

Eindeutige ID oder E-Mail-Adresse des Standorts

Besitzerspeicherort
RecordOwnerLocation string

Eindeutige ID oder E-Mail-Adresse des Standorts

Preserver-Hierarchie bei der Dateneingabe?
RecordPreserveHierarchyOnDataEntry boolean
Vorheriger Teildatensatz
RecordPrevPartRecord string
Priority
RecordPriority string
Neuen Typ aufzeichnen
RecordNewType string

Als Standard beibehalten, es sei denn, eine neue Webpartversion oder Kopie wird erstellt.

Verwandter Datensatz
RecordRelatedRecord string
Verkäufer
RecordRepresentative string
Aufbewahrungszeitplan
RecordRetentionSchedule string
Überprüfungsdatum
RecordReviewDate string
Fälligkeitsdatum überprüfen
RecordReviewDueDate string
Status überprüfen
RecordReviewState string
Sicherheit
RecordSecurity string
Datenreihendatensatz
RecordSeriesRecord string
Titel (Freitextteil)
RecordTypedTitle string
Abfragezeichenfolge
q string

Geben Sie hier eine Abfrage an, um die Aktualisierung auf eine Gruppe von Datensätzen anstatt nur auf eine (wie durch die eindeutige ID angegeben) anzuwenden.

Gibt zurück

Datensatz aktualisieren (Finalise)

Aktualisieren eines Entwurfsdatensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Alte Überarbeitungen entfernen
SetAsFinalRemoveOldRevisions boolean
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Klassifizierung)

Aktualisieren der Klassifizierung eines Datensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Klassifizierung
RecordClassification True string

Bereitstellen des eindeutigen Bezeichners der Klassifizierung

Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Kontakt anfügen)

Anfügen eines Kontakts an einen Datensatz

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Kontakttyp
ContactType True string
Kontaktstandort
ContactLocation True string

Eindeutige ID oder E-Mail-Adresse des Standorts

Als primären Kontakt festlegen?
IsPrimary True boolean
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Schließen)

Verwenden Sie die CloseRecord-Funktion, um einen Container zu schließen – lassen Sie das Datum leer, wenn das Schließdatum "jetzt" sein soll. Da das Schließen eines Datensatzes möglicherweise eine Aktualisierung vieler enthaltener Datensätze erfordert, führt diese Funktion automatisch einen Commit für die Änderungen durch.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Fahren Sie mit dem Fehler fort?
ContinueOnError boolean
Inhalt einschließen?
EncloseContents boolean
Inhalte fertigstellen?
FinalizeContents boolean
Nur Protokollfehler?
LogErrorsOnly boolean
Ergebnisse protokollieren?
LogResults boolean

Gibt ein Textprotokoll der Datensätze zurück, die in der Protokollnachricht-Eigenschaft geschlossen wurden?

Inhaltsrevisionen löschen?
PurgeContentRevisions boolean
Spezifisches Enddatum?
SpecificCloseDate date
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Set Assignee)

Festlegen des Zuweisenden auf einen bestimmten Speicherort, zurück zur Startseite oder registrieren als fehlt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Neuer Assignee
NewAssignee string

Eindeutige ID oder E-Mail-Adresse des neuen Assignee

Assignee-Typ
AssigneeType string
Fällig für Rückgabe nach Datum
DueForReturnByDate date
Ist-Zeitänderung aufgetreten
ActualTimeChangeOccurred date-time
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Speicherort aus Access-Steuerelementen entfernen)

RemoveAccessControl

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner
Uri True integer
FunctionEnum
FunctionEnum string
Eindeutige ID
Uri integer

Eindeutiger Standortbezeichner

Gibt zurück

Datensatz aktualisieren (Thesaurusausdruck anfügen)

Anfügen eines Thesaurusausdrucks an einen Datensatz

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Datensatz
Uri True integer

Die eindeutige ID des Datensatzes zum Anfügen des Thesaurusausdrucks an

Thesaurusausdruck
Keyword True string

Die eindeutige ID oder der Name des thesaurus-Ausdrucks, der angefügt werden soll

Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Undispose)

Gibt den Status des Datensatzes (und eines seiner Inhalte) zurück, sodass er nicht mehr verworfen wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Fahren Sie mit dem Fehler fort?
ContinueOnError boolean
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (unfinalise - Als Entwurf festlegen)

Aktualisieren eines abgeschlossenen Datensatzes auf "Entwurf"

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer

Gibt zurück

Datensatz aktualisieren (Vollständige Aktionen)

Ausführen einer oder aller Aktionen, die für einen bestimmten Datensatz fällig sind

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer
Vollständig
Complete True string

Angeben, welche Datensatzaktionen abgeschlossen werden sollen

Vorherige Aktionen ausführen
CompletePrevious boolean

Ausführen aller Datensatzaktionen vor dem angegebenen Datensatz

Abschlussdatum
CompletionDate date

Das Datum, das als Abschlussdatum festgelegt werden soll

Eindeutige Datensatzaktions-ID
RecordActionUri integer

Die eindeutige ID der Datensatzaktion, die abgeschlossen werden soll, wenn "Für eindeutiger Bezeichner" ausgewählt ist

Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz aktualisieren (Zugriff uneingeschränkt festlegen oder auf Container basieren)

InheritAccessControl

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner
Uri True integer
FunctionEnum
FunctionEnum string
Eindeutige ID
Uri integer

Eindeutiger Standortbezeichner

Gibt zurück

Datensatz aktualisieren (Zugriffssteuerelemente ersetzen)

SetAccessControl

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner
Uri True integer
FunctionEnum
FunctionEnum string
Eindeutige ID
Uri integer

Eindeutiger Standortbezeichner

Gibt zurück

Datensatz aktualisieren (zusätzliche Felder)

Aktualisieren zusätzlicher Felder für einen Datensatz

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri integer
Name
SearchClause string
Wert
Value string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Gibt zurück

Datensatz erstellen (Dokument)

Erstellen eines Datensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Datensatztyp
RecordRecordType True string
Titel (Freitextteil)
RecordTypedTitle True string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Autor
RecordAuthor string

Eindeutige ID oder E-Mail-Adresse des Standorts

Empfänger
RecordAddressee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Alternativer Container
RecordAlternativeContainer string
Zugewiesene Person
RecordAssignee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Automatisches Rendern in PDF beim Speichern
RecordAutoRenderToPDFOnSave boolean
Umgangen mit Zugriffssteuerungen für Datensatztypen
RecordBypassRecordTypeAccessControls boolean
Einchecken als
CheckinAs string

Legen Sie die Source-Eigenschaft des elektronischen Dokuments fest.

Klassifizierung
RecordClassification string

Bereitstellen des eindeutigen Bezeichners der Klassifizierung

Kunde
RecordClient string

Eindeutige ID oder E-Mail-Adresse des Standorts

Clientdatensatz
RecordClientRecord string
Container
RecordContainer string
Dokument aus Datensatz kopieren
CopyDocumentFromRecord string

Geben Sie eine eindeutige ID für den Datensatz an, aus dem das elektronische Dokument für diesen Datensatz kopiert werden soll.,

Schöpfer
RecordCreator string

Eindeutige ID oder E-Mail-Adresse des Standorts

Erstellungsdatum
RecordDateCreated string
Fälligkeitsdatum
RecordDateDue string
Datum der Veröffentlichung
RecordDatePublished string
Empfangsdatum
RecordDateReceived string
Externe Referenz
RecordExternalReference string
Fehler bei Warnungen?
FailOnWarnings boolean

True, um ein Objekt nicht zu erstellen/zu speichern, wenn Warnungen vorhanden sind.

Dateiname im Ordner "Uploads"
RecordFilePath string

Der Dateiname, wie er im Ordner "Uploads" angezeigt wird.

Abschließen des Speichervorgangs
RecordFinalizeOnSave boolean
Fremdcodecode
RecordForeignBarcode string
GPS-Standort
RecordGpsLocation string
Startort
RecordHomeLocation string

Eindeutige ID des Speicherorts

Home Space
RecordHomeSpace string
Ist eingeschlossen
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Ausgecheckt bleiben
keepBookedOut boolean

True, um den Datensatz ausgecheckt zu lassen, nachdem das elektronische Dokument hochgeladen wurde.

Datum der letzten Aktion
RecordLastActionDate string
Lange Zahl
RecordLongNumber string
Medientyp
RecordMediaType string
Hinweise
RecordNotes string
Notizenaktualisierungstyp
NotesUpdateType string
Anderer Kontakt
RecordOtherContact string

Eindeutige ID oder E-Mail-Adresse des Standorts

Besitzerspeicherort
RecordOwnerLocation string

Eindeutige ID oder E-Mail-Adresse des Standorts

Verwandter Datensatz
RecordRelatedRecord string
Verkäufer
RecordRepresentative string

Eindeutige ID oder E-Mail-Adresse des Standorts

Überprüfungsdatum
RecordReviewDate string
Fälligkeitsdatum überprüfen
RecordReviewDueDate string
Status überprüfen
RecordReviewState string
Sicherheit
RecordSecurity string

Gibt zurück

Datensatz erstellen (erweitert)

Erstellen eines Datensatzes mit erweiterten Feldern

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Datensatztyp
RecordRecordType True string
Titel (Freitextteil)
RecordTypedTitle True string
Klassifizierung
RecordClassification string

Bereitstellen des eindeutigen Bezeichners der Klassifizierung

Autor
RecordAuthor string

Eindeutige ID oder E-Mail-Adresse des Standorts

Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Beitrittsnummer
RecordAccessionNumber string
Empfänger
RecordAddressee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Alternativer Container
RecordAlternativeContainer string
Zugewiesene Person
RecordAssignee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Konfidenzniveau der automatischen Klassifizierung
RecordAutoClassificationConfidenceLevel string
Automatisches Rendern in PDF beim Speichern
RecordAutoRenderToPDFOnSave boolean
Umgangen mit Zugriffssteuerungen für Datensatztypen
RecordBypassRecordTypeAccessControls boolean
Speichern umgehen?
ByPassSave boolean

True, um das Objekt nicht zu speichern. Eine Verwendung dieser Vorgehensweise besteht darin, eine oder mehrere Eigenschaften für einen Datensatzbeitrag festzulegen und das Dateneingabeformular zurückzugeben. Das Dateneingabeformular spiegelt dann die verschiedenen Eigenschaften wider, die für den ursprünglichen Datensatz festgelegt sind.

Position innerhalb der Favoriten ändern
ChangePositionWithinFavorites string

Wenn Sie nach Favoriten suchen, werden sie in dieser Reihenfolge zurückgegeben, es sei denn, eine andere Sortierung wird verwendet.

Position innerhalb der Benutzerbezeichnung ändern
ChangePositionWithinUserLabel string

Bei der Suche nach UserLabel werden sie in dieser Reihenfolge zurückgegeben, es sei denn, eine andere Sortierung wird verwendet.,

Einchecken als
CheckinAs string

Legen Sie die Source-Eigenschaft des elektronischen Dokuments fest.

Datensatzklasse
RecordClassOfRecord string
Kunde
RecordClient string

Eindeutige ID oder E-Mail-Adresse des Standorts

Clientdatensatz
RecordClientRecord string
Kommentare
comments string

Kommentare, die beim Hochladen des Dokuments in die Datensatznotizen eingefügt werden sollen.

Sendung
RecordConsignment string
Sendungsobjekt
RecordConsignmentObject string
Container
RecordContainer string
Dokument aus Datensatz kopieren
CopyDocumentFromRecord string

Geben Sie eine eindeutige ID für den Datensatz an, aus dem das elektronische Dokument für diesen Datensatz kopiert werden soll.,

Schöpfer
RecordCreator string

Eindeutige ID oder E-Mail-Adresse des Standorts

Erstellungsdatum
RecordDateCreated string
Fälligkeitsdatum
RecordDateDue string
Datum der Veröffentlichung
RecordDatePublished string
Empfangsdatum
RecordDateReceived string
Editor
RecordEditor string

Eindeutige ID oder E-Mail-Adresse des Standorts

Externe Referenz
RecordExternalReference string
Fehler bei Warnungen?
FailOnWarnings boolean

True, um ein Objekt nicht zu erstellen/zu speichern, wenn Warnungen vorhanden sind.

Dateiname im Ordner "Uploads"
RecordFilePath string

Der Dateiname, wie er im Ordner "Uploads" angezeigt wird.

Abschließen des Speichervorgangs
RecordFinalizeOnSave boolean
Fremdcodecode
RecordForeignBarcode string
GPS-Standort
RecordGpsLocation string
Startort
RecordHomeLocation string

Eindeutige ID des Speicherorts

Home Space
RecordHomeSpace string
Vorlage initiieren
RecordInitiateTemplate string
Ist eingeschlossen
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Ausgecheckt bleiben
keepBookedOut boolean

True, um den Datensatz ausgecheckt zu lassen, nachdem das elektronische Dokument hochgeladen wurde.

Datum der letzten Aktion
RecordLastActionDate string
Lange Zahl
RecordLongNumber string
Aktiv machen
MakeActive string

Gibt den Status des Datensatzes (und eines seiner Inhalte) zurück, sodass er nicht mehr inaktiv ist. Beim Verarbeiten von Inhalten können Sie angeben, ob die Aufgabe angehalten werden soll, wenn Fehler auftreten.

Inaktiv machen
MakeInactive string

Legt "dateInactive" für diesen Datensatz und einen der zugehörigen Inhalte fest. Beim Verarbeiten von Inhalten können Sie angeben, ob die Aufgabe angehalten werden soll, wenn Fehler auftreten.

Neue Überarbeitung vornehmen
makeNewRevision boolean

True, um eine neue Revision mit diesem elektronischen Dokument false zu erstellen, um die aktuelle Revision zu ersetzen.

Manuelles Vernichtungsdatum
RecordManualDestructionDate string
Matter Record
RecordMatterRecord string
Medientyp
RecordMediaType string
Meine Autorisierungskommentare
RecordMyAuthorizationComments string
Meine Autorisierung abgeschlossen
RecordMyAuthorizationComplete boolean
Meine Rezensionskommentare
RecordMyReviewComments string
Meine Rezension abgeschlossen
RecordMyReviewComplete boolean
Benötigt Autorisierung?
RecordNeedsAuthorization boolean
Muss überprüft werden?
RecordNeedsReview boolean
Neue Webparterstellungsregel
RecordNewPartCreationRule string

Eindeutige ID der Autoparterstellungsregel

Hinweise
RecordNotes string
Notizenaktualisierungstyp
NotesUpdateType string
Anderer Kontakt
RecordOtherContact string

Eindeutige ID oder E-Mail-Adresse des Standorts

Besitzerspeicherort
RecordOwnerLocation string

Eindeutige ID oder E-Mail-Adresse des Standorts

Preserver-Hierarchie bei der Dateneingabe?
RecordPreserveHierarchyOnDataEntry boolean
Vorheriger Teildatensatz
RecordPrevPartRecord string
Priority
RecordPriority string
Neuen Typ aufzeichnen
RecordNewType string

Als Standard beibehalten, es sei denn, eine neue Webpartversion oder Kopie wird erstellt.

Verwandter Datensatz
RecordRelatedRecord string
Verkäufer
RecordRepresentative string
Aufbewahrungszeitplan
RecordRetentionSchedule string
Überprüfungsdatum
RecordReviewDate string
Fälligkeitsdatum überprüfen
RecordReviewDueDate string
Status überprüfen
RecordReviewState string
Sicherheit
RecordSecurity string
Datenreihendatensatz
RecordSeriesRecord string
Eigenschaftensätze
propertySets string

Geben Sie zusätzlich zu den bereitgestellten Eigenschaftensätzen, die von der Anforderung zurückgegeben werden sollen, an.

Abfragezeichenfolge
q string

Geben Sie hier eine Abfrage an, um die Aktualisierung auf eine Gruppe von Datensätzen anstatt nur auf eine (wie durch die eindeutige ID angegeben) anzuwenden.

Gibt zurück

Datensatz erstellen (Ordner)

Erstellen eines Datensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Datensatztyp
RecordRecordType True string
Titel (Freitextteil)
RecordTypedTitle True string
Klassifizierung
RecordClassification string

Bereitstellen des eindeutigen Bezeichners der Klassifizierung

Container
RecordContainer string
Eigenschaften
Properties string

Eine durch Trennzeichen getrennte Liste der zurückzugebenden Eigenschaften

Autor
RecordAuthor string

Eindeutige ID oder E-Mail-Adresse des Standorts

Empfänger
RecordAddressee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Alternativer Container
RecordAlternativeContainer string
Zugewiesene Person
RecordAssignee string

Eindeutige ID oder E-Mail-Adresse des Standorts

Umgangen mit Zugriffssteuerungen für Datensatztypen
RecordBypassRecordTypeAccessControls boolean
Kunde
RecordClient string

Eindeutige ID oder E-Mail-Adresse des Standorts

Schöpfer
RecordCreator string

Eindeutige ID oder E-Mail-Adresse des Standorts

Erstellungsdatum
RecordDateCreated string
Fälligkeitsdatum
RecordDateDue string
Datum der Veröffentlichung
RecordDatePublished string
Externe Referenz
RecordExternalReference string
Fehler bei Warnungen?
FailOnWarnings boolean

True, um ein Objekt nicht zu erstellen/zu speichern, wenn Warnungen vorhanden sind.

Dateiname im Ordner "Uploads"
RecordFilePath string

Der Dateiname, wie er im Ordner "Uploads" angezeigt wird.

Fremdcodecode
RecordForeignBarcode string
GPS-Standort
RecordGpsLocation string
Startort
RecordHomeLocation string

Eindeutige ID des Speicherorts

Home Space
RecordHomeSpace string
Ist eingeschlossen
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Datum der letzten Aktion
RecordLastActionDate string
Lange Zahl
RecordLongNumber string
Hinweise
RecordNotes string
Notizenaktualisierungstyp
NotesUpdateType string
Anderer Kontakt
RecordOtherContact string

Eindeutige ID oder E-Mail-Adresse des Standorts

Besitzerspeicherort
RecordOwnerLocation string

Eindeutige ID oder E-Mail-Adresse des Standorts

Verwandter Datensatz
RecordRelatedRecord string
Verkäufer
RecordRepresentative string

Eindeutige ID oder E-Mail-Adresse des Standorts

Überprüfungsdatum
RecordReviewDate string
Fälligkeitsdatum überprüfen
RecordReviewDueDate string
Status überprüfen
RecordReviewState string
Sicherheit
RecordSecurity string

Gibt zurück

Datensatz löschen

Löschen eines Datensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer

Die eindeutige ID des zu löschenden Datensatzes

Inhalt löschen?
DeleteContents True boolean
Neue Startseite für Inhalte
NewHomeForContents string

Die eindeutige ID oder E-Mail-Adresse des neuen Startspeicherorts für den Inhalt

Gibt zurück

Datensatz nach ID suchen

Abrufen eines einzelnen Datensatzes nach eindeutiger ID oder Name

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

ID
Id True string

Entweder die eindeutige OBJEKT-ID oder der Name

Include-Eigenschaftsdefinitionen
IncludePropertyDefs boolean

True, um ein Array der Eigenschaftendefinitionen zurückzugeben, die von Eigenschaften in dieser Antwort verwendet werden

Untergeordnete Eigenschaften
descendantProperties string

Eine durch Trennzeichen getrennte Liste von Objekteigenschaften gilt nur für Objekteigenschaften dieser und eigenschaften auf niedrigerer Ebene, z. B. RecordNumber,RecordTitle.

Eigenschaften
properties string

Eine durch Trennzeichen getrennte Liste von Objekteigenschaften, z. B. RecordNumber,RecordTitle.

Eigenschaftensätze
propertySets string

Ein oder mehrere vordefinierte Eigenschaftensätze, wählen Sie aus DataGridVisible, Detailed, FromSearch, All oder einer benutzerdefinierten Eigenschaft, die in Ihrer Dienstkonfiguration definiert ist.

Eigenschaftswert
PropertyValue string

Einschließen des Rohwerts, des Zeichenfolgenwerts oder beides in die Ergebnisse

Zeichenfolgenanzeigetyp
stringDisplayType string

Wenn der Zeichenfolgenwert zurückgegeben wird, welches Format verwendet werden soll

Gibt zurück

Datensätze suchen

Nach Datensätzen suchen (Abrufen einer Sammlung von Datensätzen mithilfe einer Suchzeichenfolge)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Query
q True string

Suchabfrage

Eigenschaften
properties True string

Eine durch Trennzeichen getrennte Liste von Eigenschaften, die zurückgegeben werden sollen

Gibt zurück

Eindeutige ID der Standortadresse suchen

Abrufen der eindeutigen ID der untergeordneten Adresse eines Speicherorts

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Typ
type string

Adresstyp auswählen

Eindeutiger Bezeichner
LocationUri True string

Eindeutige ID des Speicherorts

Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Gibt zurück

Untergeordnete Adresse
CMLocationAddressUri

Elektronische Datei herunterladen

Herunterladen einer elektronischen Datei eines Datensatzes

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner
uri True string

Eindeutige ID oder Datensatznummer

Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Gibt zurück

response
binary

Elektronische Datei hochladen

Hochladen einer elektronischen Datei, die später an einen Datensatz angefügt werden kann

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Dateiname
RecordFilePath True string
Eindeutiger Bezeichner
Uri True string

Ereignisdaten lesen

Transformieren von Kapish Dispatch-Ereignisdaten für den Flussverbrauch

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Content
Content string

Der Inhalt der ServiceBus-Aktion, die die CM-Ereignisdaten abgerufen hat

Gibt zurück

Ort erstellen (Person)

Erstellen eines Personenspeicherorts

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Title
LocationHonorific string
Nachname
LocationSurname string
Vorname
LocationGivenNames string
Intern
LocationIsWithin boolean
Position
LocationJobDescription string
Geburtsdatum
LocationDateOfBirth string
Anrede
LocationSalutation string
Eindeutiger Name
LocationNickName string
ID-Nummer
LocationIdNumber string
Geschäftstelefon
LocationPhoneNumber string
Mobiltelefon
LocationMobileNumber string
Faxnummer
LocationFaxNumber string
Telefon (privat)
LocationAfterHoursPhoneNumber string
Identisch mit Adresse
LocationUseAddressOf integer

Eindeutige ID des Speicherorts

Adresstyp
LocationAddressAddressType string

Wählen Sie den Adresstyp aus. Grenzwert von 1 pro Typ.

Straße
LocationAddressAddressLines string
Vorort / Stadt
LocationAddressCity string
Staat
LocationAddressState string
Postleitzahl
LocationAddressPostcode string
Country
LocationAddressCountry string
Standard festlegen
AddRelationshipMakeThisTheDefaultRelationship boolean
Zugehörige eindeutige ID
AddRelationshipRelatedLocation integer
Typ
AddRelationshipRelationshipType string
E-Mail-Adresse
LocationEmailAddress string
Geschlecht
LocationGenderValue string
Akzeptieren von Anmeldungen
LocationCanLogin boolean
Netzwerkanmeldung
LocationLogsInAs string
Zusätzliche Netzwerkanmeldung
LocationAdditionalLogin string
Anmeldung läuft ab am
LocationLoginExpires string
Benutzerprofil von
LocationUseProfileOf integer

Eindeutige ID des Speicherorts

Benutzertyp
LocationUserType string
Sicherheitszeichenfolge
LocationSecurityString string
Von
SetActiveDateRangeValidFromDate string

tt/mm/jjjj

Bis
SetActiveDateRangeValidToDate string

tt/mm/jjjj

Hinweise
LocationNotes string
Notizenaktualisierungstyp
NotesUpdateType string

Gibt zurück

Speicherort aktualisieren (Adresse)

Erstellen/Aktualisieren der Adresse eines Speicherorts mithilfe der eindeutigen ID der Adresse

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri True integer

Der URI des vorhandenen Speicherorts, der aktualisiert werden soll

Eindeutige ID
Uri integer

Der URI der vorhandenen Straße oder Postanschrift, die aktualisiert werden soll

Typ
LocationAddressAddressType string

Wählen Sie den Adresstyp aus. Grenzwert von 1 pro Typ.

Straße
LocationAddressAddressLines string
Vorort / Stadt
LocationAddressCity string
Staat
LocationAddressState string
Postleitzahl
LocationAddressPostcode string
Country
LocationAddressCountry string

Gibt zurück

Speicherort aktualisieren (Person)

Aktualisieren eines Personenspeicherorts mithilfe seines eindeutigen Bezeichners

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri integer
Abfragezeichenfolge
q string

Geben Sie hier eine Abfrage an, um das Update auf eine Reihe von Speicherorten anstatt nur auf eine (wie durch die eindeutige ID angegeben) anzuwenden.

Title
LocationHonorific string
Nachname
LocationSurname string
Vorname
LocationGivenNames string
Intern
LocationIsWithin boolean
Position
LocationJobDescription string
Geburtsdatum
LocationDateOfBirth string
Anrede
LocationSalutation string
Eindeutiger Name
LocationNickName string
ID-Nummer
LocationIdNumber string
Geschäftstelefon
LocationPhoneNumber string
Mobiltelefon
LocationMobileNumber string
Faxnummer
LocationFaxNumber string
Telefon (privat)
LocationAfterHoursPhoneNumber string
Identisch mit Adresse
LocationUseAddressOf integer

Eindeutige ID des Speicherorts

Standard festlegen
AddRelationshipMakeThisTheDefaultRelationship boolean
Zugehörige eindeutige ID
AddRelationshipRelatedLocation integer
Typ
AddRelationshipRelationshipType string
E-Mail-Adresse
LocationEmailAddress string
Geschlecht
LocationGenderValue string
Akzeptieren von Anmeldungen
LocationCanLogin boolean
Netzwerkanmeldung
LocationLogsInAs string
Zusätzliche Netzwerkanmeldung
LocationAdditionalLogin string
Anmeldung läuft ab am
LocationLoginExpires string
Benutzerprofil von
LocationUseProfileOf integer

Eindeutige ID des Speicherorts

Benutzertyp
LocationUserType string
Sicherheitszeichenfolge
LocationSecurityString string
Von
SetActiveDateRangeValidFromDate string

tt/mm/jjjj

Bis
SetActiveDateRangeValidToDate string

tt/mm/jjjj

Hinweise
LocationNotes string
Notizenaktualisierungstyp
NotesUpdateType string
Zugehörige eindeutige ID
RemoveRelationshipRelatedLocation integer

Gibt zurück

Speicherort aktualisieren (zusätzliche Felder)

Aktualisieren zusätzlicher Felder an einem Speicherort

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri integer
Name
SearchClause string
Wert
Value string

Gibt zurück

Speicherort erstellen (sonstige)

Erstellen eines Speicherorts eines beliebigen Typs

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Standorttyp
LocationTypeOfLocation string
Name
LocationSortName True string
Eindeutiger Name
LocationNickName string
ID-Nummer
LocationIdNumber string
Intern
LocationIsWithin boolean
Geschäftstelefon
LocationPhoneNumber string
Mobiltelefon
LocationMobileNumber string
Faxnummer
LocationFaxNumber string
Telefon (privat)
LocationAfterHoursPhoneNumber string
Identisch mit Adresse
LocationUseAddressOf integer

Eindeutige ID des Speicherorts

Adresstyp
LocationAddressAddressType string

Wählen Sie den Adresstyp aus. Grenzwert von 1 pro Typ.

Straße
LocationAddressAddressLines string
Vorort / Stadt
LocationAddressCity string
Staat
LocationAddressState string
Postleitzahl
LocationAddressPostcode string
Country
LocationAddressCountry string
Standard festlegen
AddRelationshipMakeThisTheDefaultRelationship boolean
Zugehörige eindeutige ID
AddRelationshipRelatedLocation integer
Typ
AddRelationshipRelationshipType string
E-Mail-Adresse
LocationEmailAddress string
Von
SetActiveDateRangeValidFromDate string

tt/mm/jjjj

Bis
SetActiveDateRangeValidToDate string

tt/mm/jjjj

Hinweise
LocationNotes string
Notizenaktualisierungstyp
NotesUpdateType string

Gibt zurück

Speicherort nach ID suchen

Abrufen eines einzelnen Speicherorts nach eindeutiger ID oder Name

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Id True string

Entweder die eindeutige OBJEKT-ID oder der Name

Untergeordnete Eigenschaften
descendantProperties string

Eine durch Trennzeichen getrennte Liste von Objekteigenschaften gilt nur für Objekteigenschaften dieser und eigenschaften auf niedrigerer Ebene, z. B. Nachname,GivenNames

Include-Eigenschaftsdefinitionen
IncludePropertyDefs boolean

True, um ein Array der Eigenschaftendefinitionen zurückzugeben, die von Eigenschaften in dieser Antwort verwendet werden

Eigenschaften
properties string

Eine durch Trennzeichen getrennte Liste von Objekteigenschaften, z. B. Nachname,GivenNames

Eigenschaftensätze
propertySets string

Ein oder mehrere vordefinierte Eigenschaftensätze, wählen Sie aus DataGridVisible, Detailed, FromSearch, All oder einer benutzerdefinierten Eigenschaft, die in Ihrer Dienstkonfiguration definiert ist

Eigenschaftswert
PropertyValue string

Einschließen des Rohwerts, des Zeichenfolgenwerts oder beides in die Ergebnisse

Zeichenfolgenanzeigetyp
stringDisplayType string

Gibt den zu verwendenden Zeichenfolgenwert zurück.

Gibt zurück

Speicherorte suchen

Suchen nach Speicherorten (Abrufen einer Sammlung von Speicherorten mithilfe einer Suchzeichenfolge)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Query
q True string

Geben Sie eine Suchabfrage ein, z. B. "alle", um alle Objekte abzurufen.

Standard anwenden
ApplyDefaults boolean

True, um den Standardfilter des Benutzers anzuwenden und auf diese Suche zu sortieren

Anzahl Ergebnisse
CountResults boolean

True, um eine Anzahl der Ergebnisse einzuschließen

Anzahl ausschließen
ExcludeCount boolean

True, um eine Anzahl der Ergebnisse auszuschließen

Filter
filter string

Eine durch Leerzeichen getrennte Liste von Suchklauseln, die als Filter angewendet werden sollen.

Von Suche
fromSearch string

Die eindeutige ID einer gespeicherten Suche, aus der diese Suche erstellt werden soll

Untergeordnete Eigenschaften
descendantProperties string

Eine durch Trennzeichen getrennte Liste von Objekteigenschaften gilt nur für Objekteigenschaften dieser und eigenschaften auf niedrigerer Ebene, z. B. RecordNumber,RecordTitle

Include-Eigenschaftsdefinitionen
IncludePropertyDefs boolean

True, um ein Array der Eigenschaftendefinitionen zurückzugeben, die von Eigenschaften in dieser Antwort verwendet werden

Options
Options string

Legen Sie eine oder mehrere der Optionen fest, die in der Regel nur in den Benutzeroptionen für diese Suche festgelegt sind. Verwenden Sie IDs aus "/PropertyDef"? Get=SearchOptions-Dienst, fügen Sie ein Minuszeichen an, das auf "false" festgelegt werden soll, andernfalls wird "true" angenommen.

Eigenschaften
properties string

Eine durch Trennzeichen getrennte Liste von Objekteigenschaften, z. B. RecordNumber,RecordTitle

Eigenschaftensätze
propertySets string

Ein oder mehrere vordefinierte Eigenschaftensätze, wählen Sie aus DataGridVisible, Detailed, FromSearch, All oder einer benutzerdefinierten Eigenschaft, die in Ihrer Dienstkonfiguration definiert ist

Eigenschaftswert
PropertyValue string

Einschließen des Rohwerts, des Zeichenfolgenwerts oder beides in die Ergebnisse

Seitenformat
pageSize string

Die Anzahl der Elemente, die auf jeder Ergebnisseite zurückgegeben werden sollen

Zweck
purpose string

Eine spezielle Eigenschaft zum Filtern von Suchergebnissen basierend auf Objektzweck-Enumerationswerten

Zweck extra
purposeExtra string

Erforderlich als Ergänzung zu einigen Zwecken. Der ObjectDef-Dienst stellt Informationen zum Enumerations- oder TrimMainObject-Typ bereit, um anzugeben, insbesondere ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes und HaveExtraPurposeParameter.

Sortieren nach
sortBy string

Eine durch Trennzeichen getrennte Liste der Suchklauseln-IDs

Start
start string

Die Position im Resultset, die beginnen soll, leer (oder 1), um am Anfang zu beginnen, 2, um am zweiten Objekt zu beginnen, 3 am dritten, usw.

Zeichenfolgenanzeigetyp
stringDisplayType string

Wenn der Zeichenfolgenwert zurückgegeben wird, welches Format verwendet werden soll

Gibt zurück

Suchen von CM-Objekten

Suchen nach CM-Objekten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Suchen nach
TrimType True string
Abfragezeichenfolge
q True string

Geben Sie eine Suchabfrage ein, z. B. "alle", um alle Objekte abzurufen.

Standard anwenden
ApplyDefaults boolean

True, um den Standardfilter des Benutzers anzuwenden und auf diese Suche zu sortieren.

Anzahl Ergebnisse
CountResults boolean

CountResults gibt die zuverlässigste und langsamste Anzahl der Suchergebnisse zurück. Die resultierende Anzahl befindet sich in der Response Count-Eigenschaft.

Untergeordnete Eigenschaften
DescendantProperties string

Eine durch Trennzeichen getrennte Liste von Objekteigenschaften gilt nur für Objekteigenschaften dieser und eigenschaften auf niedrigerer Ebene, z. B. RecordNumber,RecordTitle.

Anzahl ausschließen
ExcludeCount boolean

Das Zurückgeben von TotalResults und SearchTitle kann die Leistung beeinträchtigen. "true", wenn "TotalResults" und "SearchTitle" nicht erforderlich sind.

Filter
Filter string

Eine durch Leerzeichen getrennte Liste von Suchklauseln, die als Filter angewendet werden sollen.

Von Suche
FromSearch integer

Die eindeutige ID einer gespeicherten Suche, aus der diese Suche erstellt werden soll.

Include-Eigenschaftsverzögerung
IncludePropertyDefs boolean

True, um ein Array der Eigenschaftendefinitionen zurückzugeben, die von Eigenschaften in dieser Antwort verwendet werden.

Options
Options string

Legen Sie eine oder mehrere der Optionen fest, die in der Regel nur in den Benutzeroptionen für diese Suche festgelegt sind. Verwenden Sie IDs aus "/PropertyDef"? Get=SearchOptions-Dienst, fügen Sie ein Minuszeichen an, das auf "false" festgelegt werden soll, andernfalls wird "true" angenommen.

Seitenformat
pageSize integer

Die Anzahl der Elemente, die auf jeder Ergebnisseite zurückgegeben werden sollen. Wenn leer, wird standardmäßig der Standardwert in der Konfiguration festgelegt.

Eigenschaftswert
PropertyValue string

Schließen Sie den Rohwert, den Zeichenfolgenwert oder beides in die Ergebnisse ein.

Eigenschaftensätze
PropertySets string

Ein oder mehrere vordefinierte Eigenschaftensätze, wählen Sie aus DataGridVisible, Detailed, FromSearch, All oder einer benutzerdefinierten Eigenschaft, die in Ihrer Dienstkonfiguration definiert ist.

Zweck
purpose integer

Eine spezielle Eigenschaft zum Filtern von Suchergebnissen basierend auf Objektzweck-Enumerationswerten.

Zweck extra
purposeExtra integer

Erforderlich als Ergänzung zu einigen Zwecken. Der ObjectDef-Dienst stellt Informationen zum Enumerations- oder TrimMainObject-Typ bereit, um anzugeben, insbesondere ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes und HaveExtraPurposeParameter.

Sortieren nach
sortBy string

Eine durch Trennzeichen getrennte Liste der Suchklauseln-IDs. Verwenden Sie - um absteigend anzugeben. Zum Sortieren von Datensätzen nach absteigender Zahl. Number-

Start
start integer

Die Position im Resultset, die beginnen soll, leer (oder 1), um am Anfang zu beginnen, 2, um am zweiten Objekt zu beginnen, 3 am dritten, usw.

StringDisplayType
StringDisplayType string

Gibt den Zeichenfolgenwert zurück, der verwendet werden soll.

Eigenschaften
properties string

Eine durch Trennzeichen getrennte Liste von Objekteigenschaften, z. B. Uri,NameString

Gibt zurück

Suchen von Datensätzen (Erweitert)

Suchen nach Datensätzen (Abrufen einer Sammlung von Datensätzen mithilfe einer Suchzeichenfolge). Gibt eine unformatierte Content Manager ServiceAPI-Antwort zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Query
q True string

Suchabfrage

Eigenschaften
properties True string

Eine durch Trennzeichen getrennte Liste von Eigenschaften, die zurückgegeben werden sollen

Gibt zurück

response
object

Updatespeicherort (sonstige)

Aktualisieren eines Speicherorts

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer zum Identitätswechsel
userToImpersonate string

Die Netzwerkanmeldung oder alternative Anmeldung des Speicherorts in CM zum Identitätswechsel

Eindeutiger Bezeichner
Uri integer
Abfragezeichenfolge
q string

Geben Sie hier eine Abfrage an, um das Update auf eine Reihe von Speicherorten anstatt nur auf eine (wie durch die eindeutige ID angegeben) anzuwenden.

Name
LocationSortName string
Eindeutiger Name
LocationNickName string
ID-Nummer
LocationIdNumber string
Geschäftstelefon
LocationPhoneNumber string
Mobiltelefon
LocationMobileNumber string
Faxnummer
LocationFaxNumber string
Telefon (privat)
LocationAfterHoursPhoneNumber string
Identisch mit Adresse
LocationUseAddressOf integer

Eindeutige ID des Speicherorts

Standard festlegen
AddRelationshipMakeThisTheDefaultRelationship boolean
Zugehörige eindeutige ID
AddRelationshipRelatedLocation integer
Typ
AddRelationshipRelationshipType string
E-Mail-Adresse
LocationEmailAddress string
Von
SetActiveDateRangeValidFromDate string

tt/mm/jjjj

Bis
SetActiveDateRangeValidToDate string

tt/mm/jjjj

Hinweise
LocationNotes string
Notizenaktualisierungstyp
NotesUpdateType string
Zugehörige eindeutige ID
RemoveRelationshipRelatedLocation integer

Gibt zurück

Definitionen

CMRecord

Name Pfad Typ Beschreibung
Dateipfad
RecordFilePath string

Der Dateiname, wie er im Ordner "Uploads" angezeigt wird

Beitrittsnummer
RecordAccessionNumber integer
Empfänger
RecordAddressee integer
Alternativer Container
RecordAlternativeContainer integer
Zugewiesene Person
RecordAssignee integer
Autor
RecordAuthor integer
Autorisierungsmethode
RecordAuthorizationMethod string
Konfidenzniveau der automatischen Klassifizierung
RecordAutoClassificationConfidenceLevel integer
Automatisches Rendern in PDF beim Speichern
RecordAutoRenderToPDFOnSave boolean
Blauer Drucktitel
RecordBlueprintTitle string
Umgangen mit Zugriffssteuerungen für Datensatztypen
RecordBypassRecordTypeAccessControls boolean
Eingecheckt nach
RecordCheckedInBy integer
Ausgecheckt für
RecordCheckedOutTo integer
Klassifizierung
RecordClassification integer
Datensatzklasse
RecordClassOfRecord string
Kunde
RecordClient integer
Clientdatensatz
RecordClientRecord integer
Sendung
RecordConsignment string
Sendungsobjekt
RecordConsignmentObject string
Container
RecordContainer integer
Schöpfer
RecordCreator integer
Aktuelle Version
RecordCurrentVersion string
Datum der Schließung
RecordDateClosed date-time
Erstellungsdatum
RecordDateCreated date-time
Fälligkeitsdatum
RecordDateDue date-time
Abgeschlossenes Datum
RecordDateFinalized date-time
Importiert am
RecordDateImported date-time
Datum inaktiv
RecordDateInactive date-time
Änderungsdatum
RecordDateModified date-time
Datum der Veröffentlichung
RecordDatePublished date-time
Empfangsdatum
RecordDateReceived date-time
Registriert am
RecordDateRegistered date-time
Dokumentanfügung ausstehend
RecordDocumentAttachPending boolean
Dokumentgröße
RecordDocumentSize integer
Dokumenttyp
RecordDocumentType string
Editor
RecordEditor integer
Elektronischer Dokumentspeicher
RecordEStore integer
Dokumenterweiterung
RecordExtension string
Externe Referenz
RecordExternalReference string
Abschließen des Speichervorgangs
RecordFinalizeOnSave boolean
Ordnerursprung
RecordFolderOrigin integer
Fremdcodecode
RecordForeignBarcode string
Generierter Titel
RecordGeneratedTitle string
GPS-Standort
RecordGpsLocation string
Startort
RecordHomeLocation integer
Home Space
RecordHomeSpace integer
Vorlage initiieren
RecordInitiateTemplate string

Eindeutige ID der Workflowvorlage

Ist eingeschlossen
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Datum der letzten Aktion
RecordLastActionDate date-time
Datensatz des letzten Teils
RecordLastPartRecord integer
Aktuelle Version
RecordLatestVersion integer
Erweiterte Zahl
RecordLongNumber string
Datensatznummer
RecordNumber string
Manuelles Vernichtungsdatum
RecordManualDestructionDate date-time
Matter Record
RecordMatterRecord integer
Medientyp
RecordMediaType string
Besprechung
RecordMeeting integer
MIME-Typ
RecordMimeType string
Meine Autorisierungskommentare
RecordMyAuthorizationComments string
Meine Autorisierung abgeschlossen
RecordMyAuthorizationComplete boolean
Meine Rezensionskommentare
RecordMyReviewComments string
Meine Rezension abgeschlossen
RecordMyReviewComplete boolean
Seitenzahlen?
RecordNbrPages integer
Benötigt Autorisierung?
RecordNeedsAuthorization boolean
Muss überprüft werden?
RecordNeedsReview boolean
Neue Webparterstellungsregel
RecordNewPartCreationRule string

Eindeutige ID der Autoparterstellungsregel

Nächster Teildatensatz
RecordNextPartRecord integer
Notizenaktualisierungstyp
NotesUpdateType string
Hinweise
RecordNotes string
Stammt von
RecordOriginatedFrom string
Stammt von "Ausführen"
RecordOriginatedFromRun string
Anderer Kontakt
RecordOtherContact integer
Besitzerspeicherort
RecordOwnerLocation integer
Preserver-Hierarchie bei der Dateneingabe?
RecordPreserveHierarchyOnDataEntry boolean
Vorheriger Teildatensatz
RecordPrevPartRecord integer
Primärer Kontakt
RecordPrimaryContact integer
Priority
RecordPriority string
Datensatztyp
RecordRecordType integer
Verwandter Datensatz
RecordRelatedRecord integer
Verkäufer
RecordRepresentative integer
Aufbewahrungszeitplan
RecordRetentionSchedule integer
Überprüfungsdatum
RecordReviewDate date-time
Fälligkeitsdatum überprüfen
RecordReviewDueDate date-time
Status überprüfen
RecordReviewState string
Stammteildatensatz
RecordRootPartRecord integer
Sicherheit
RecordSecurity string
Datenreihendatensatz
RecordSeriesRecord integer
Title
RecordTitle string
Titel (Freitextteil)
RecordTypedTitle string
Eindeutiger Bezeichner
Uri integer
Zusätzliche Felder
Fields object

CMEventData

Name Pfad Typ Beschreibung
Eindeutiger Ereignisbezeichner
OnlineEventUri integer
Ereignistyp-ID
EventType integer
Ereignistyp
EventTypeString string
Ereignisdatum
EventDate date-time
Objekttyp-ID
ObjectType integer
Objekttyp
ObjectTypeString string
Eindeutige Objekt-ID
ObjectUri integer
Id des zugehörigen Objekttyps
RelatedObjectType integer
Verwandter Objekttyp
RelatedObjectTypeString string
Eindeutige ID des verknüpften Objekts
RelatedObjectUri integer
Vom Computer
FromMachine string
Verbindungs-IP-Adresse
ConnectionIPAddress string
Client-IP-Adresse
ClientIPAddress string
Von Zeitzone
FromTimeZone integer
Benutzername
LoginName string
Eindeutige Anmelde-ID
LoginUri integer
Zusätzliche Details
ExtraDetails string

CMLogMessage

Name Pfad Typ Beschreibung
Protokollnachricht
LogMessage string
Suchen nach
TrimType CMTrimType
Eindeutiger Bezeichner
Uri integer

CMRecordsResponse

Name Pfad Typ Beschreibung
Ergebnisse
Results array of CMRecord
UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Gesamtergebnisse
TotalResults integer
Anzahl Zeichenfolge (Ex)
CountStringEx string
Mindestanzahl
MinimumCount integer
Anzahl
Count integer
Enthält weitere Elemente
HasMoreItems boolean
Suchtitel
SearchTitle string
Treffermarkerzeichenfolge
HitHighlightString string
Suchen nach
TrimType CMTrimType
Antwortstatus
ResponseStatus CMResponseStatus

Antwortstatus

CMLogResponse

Name Pfad Typ Beschreibung
Ergebnisse
Results array of CMLogMessage
UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Gesamtergebnisse
TotalResults integer
Anzahl Zeichenfolge (Ex)
CountStringEx string
Mindestanzahl
MinimumCount integer
Anzahl
Count integer
Enthält weitere Elemente
HasMoreItems boolean
Suchtitel
SearchTitle string
Treffermarkerzeichenfolge
HitHighlightString string
Suchen nach
TrimType CMTrimType
Antwortstatus
ResponseStatus CMResponseStatus

Antwortstatus

CMUpdateErrorResponse

Fehlerantwort aktualisieren

Name Pfad Typ Beschreibung
Fehlercode
ErrorCode string
Eindeutiger Bezeichner
Uri integer
Nachricht
Message string
Name
Name string
Name (Extra)
NameExtra string

CMResponseStatus

Antwortstatus

Name Pfad Typ Beschreibung
Fehlercode
ErrorCode string
Nachricht
Message string
StackTrace
StackTrace string
Errors
Errors array of CMResponseError
Meta
Meta object

Wörterbuchzeichenfolge,Zeichenfolge<>

CMResponseError

Antwortfehler

Name Pfad Typ Beschreibung
Fehlercode
ErrorCode string
Feldname
FieldName string
Nachricht
Message string
Meta
Meta object

Wörterbuchzeichenfolge,Zeichenfolge<>

CMTrimType

Suchen nach
string

CMLocation

Name Pfad Typ Beschreibung
Eindeutiger Bezeichner
Uri integer
Name
NameString string
Vollständig formatierter Speicherortname
LocationFullFormattedName string
Speicherortsortsortierungsname
LocationSortName string

CMBob

Name Pfad Typ Beschreibung
Eindeutiger Bezeichner
Uri integer
Name
NameString string

CMLocationsResponse

Name Pfad Typ Beschreibung
Ergebnisse
Results array of CMLocation

Ergebnisse

UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Gesamtergebnisse
TotalResults integer
Anzahl Zeichenfolge (Ex)
CountStringEx string
Mindestanzahl
MinimumCount integer
Anzahl
Count integer
Enthält weitere Elemente
HasMoreItems boolean
Suchtitel
SearchTitle string
Treffermarkerzeichenfolge
HitHighlightString string
Suchen nach
TrimType CMTrimType
Antwortstatus
ResponseStatus CMResponseStatus

Antwortstatus

CMBobResponse

Name Pfad Typ Beschreibung
Ergebnisse
Results array of CMBob

Ergebnisse

UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Gesamtergebnisse
TotalResults integer
Anzahl Zeichenfolge (Ex)
CountStringEx string
Mindestanzahl
MinimumCount integer
Anzahl
Count integer
Enthält weitere Elemente
HasMoreItems boolean
Suchtitel
SearchTitle string
Treffermarkerzeichenfolge
HitHighlightString string
Suchen nach
TrimType CMTrimType
Antwortstatus
ResponseStatus CMResponseStatus

Antwortstatus

GetFileFromUrlResponse

Antwort vom CM-Dienst-API-Plug-In "GetFileFromUrl".

Name Pfad Typ Beschreibung
Filepath
Filepath string

Lokaler Dateipfad zur Datei, die von der URL heruntergeladen wurde.

Nachricht
Message string

CMLocationAddressUri

Name Pfad Typ Beschreibung
Eindeutige ID
Uri integer

binär

Dies ist der grundlegende Datentyp "binary".

Objekt

Dies ist der Typ „Objekt“.