dms.GetAllCollaborationDocuments

This job returns all collaboration shares present in the system — incoming and outgoing, across all users — as a JSON document. The format and fields of the records correspond to those of dms.CreateCollaborationDocuments.

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.GetAllCollaborationDocuments); enaio® servers accept both spellings.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Reserved; always pass 0.

2. Output Parameters

Name Type Dependency Description

JSON

BASE64

—

Existing shares in JSON format (UTF-8). Root object with key objects, whose value is an array of share records; fields identical to dms.CreateCollaborationDocuments (object_id, object_type, from_user, to_user, valid_from, valid_to, rights, remark).
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"
    }
  ]
}

3. Return Value

(INT): 0 = job successful, otherwise error code.

For further return values see Error Codes.

4. See Also