dms.CreateCollaborationDocuments

Dieser Job erstellt eine oder mehrere Collaboration-Freigaben. Mit einer Freigabe gewährt ein Benutzer (from_user) einem anderen Benutzer (to_user) für einen befristeten Zeitraum (valid_fromvalid_to) bestimmte Zugriffsrechte (rights) auf ein DMS-Objekt und kann einen Vermerk hinterlegen. Die Freigaben werden als JSON-Dokument übergeben.

Der Job ist in der offiziellen enaio®-DMS-Engine-Übersicht nicht gelistet. Diese Beschreibung wurde aus dem beobachteten Aufruf-Verhalten rekonstruiert. Im Server wird das Job-Präfix groß geschrieben (DMS.CreateCollaborationDocuments); enaio®-Server akzeptieren beide Schreibweisen.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Flags

INT

Ja

Reserviert; stets 0 übergeben.

JSON

BASE64

Ja

Anzulegende Freigaben im JSON-Format (UTF-8). Wurzelobjekt mit Schlüssel objects, dessen Wert ein Array von Freigabe-Datensätzen ist (Felder s. u.).

1.1. JSON-Datensatz pro Freigabe

  • object_id: ID des Objekts

  • object_type: Typ des Objekts (Objekttyp-ID)

  • from_user: ID des freigebenden Benutzers

  • to_user: ID des Benutzers, an den freigegeben wird

  • valid_from: Beginn der Gültigkeit der Freigabe im deutschen Datumsformat (dd.mm.yyyy)

  • valid_to: Ende der Gültigkeit der Freigabe im deutschen Datumsformat (dd.mm.yyyy)

  • rights: Freigegebene Zugriffsrechte als Zeichenkette aus den Buchstaben
    R = Indexdaten lesen
    W = Indexdaten schreiben
    X = Objekt öffnen/ausführen
    D = Objekt löschen
    U = Objekt schreiben

  • remark: Vermerk des freigebenden Benutzers zur Freigabe

Beispiel
{
  "objects": [
    {
      "object_id": 2846,
      "object_type": 262148,
      "from_user": 10,
      "to_user": 74,
      "valid_from": "08.05.2026",
      "valid_to": "22.05.2026",
      "rights": "RXU",
      "remark": "test"
    }
  ]
}

2. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode. Es werden keine inhaltlichen Ausgabeparameter geliefert.

Weitere Rückgabewerte siehe Fehlercodes.

3. Siehe auch