dms.CreateCollaborationDocuments

This job creates one or more collaboration shares. With a share, a user (from_user) grants another user (to_user) certain access rights (rights) on a DMS object for a limited period (valid_from … valid_to) and may attach a remark. The shares are passed as a JSON document.

This job is not listed in the official enaio® DMS engine overview. This description was reconstructed from the observed call behavior. On the server, the job prefix is uppercase (DMS.CreateCollaborationDocuments); enaio® servers accept both spellings.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Reserved; always pass 0.

JSON

BASE64

Yes

Shares to create, in JSON format (UTF-8). Root object with key objects, whose value is an array of share records (fields see below).

1.1. JSON record per share

  • object_id: ID of the object

  • object_type: Type of the object (Object Type ID)

  • from_user: ID of the granting user

  • to_user: ID of the user the share is granted to

  • valid_from: Start of the share’s validity in German date format (dd.mm.yyyy)

  • valid_to: End of the share’s validity in German date format (dd.mm.yyyy)

  • rights: Granted access rights as a string composed of the letters
    R = read index data
    W = write index data
    X = open/execute object
    D = delete object
    U = write object

  • remark: Remark by the granting user about the share

Example
{
  "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. Return Value

(INT): 0 = job successful, otherwise error code. No content output parameters are returned.

For further return values see Error Codes.

3. See Also