Export
======

.. _ExportReceivers:

ExportReceivers
---------------

Info about receivers (group or user) of an export

.. code-block:: json

 message ExportReceivers {
  string title = 1;
  ItemType item_type = 2;
 }

+---------------+--------------+-------------+
| Field         | Type         | Description |
+===============+==============+=============+
| ``title``     | ``string``   |             |
+---------------+--------------+-------------+
| ``item_type`` | ``ItemType`` |             |
+---------------+--------------+-------------+

.. _ExportRestrictionObject:

ExportRestrictionObject
-----------------------

If export is restricted to user or folder, this holds info about the user or folder

.. code-block:: json

 message ExportRestrictionObject {
  string title = 1;
 }

+-----------+------------+-------------+
| Field     | Type       | Description |
+===========+============+=============+
| ``title`` | ``string`` |             |
+-----------+------------+-------------+

.. _DataroomExportItem:

DataroomExportItem
------------------

Defines a single data room export object (zip, dvd a.s.o).

The items holds information about the options the export was created with (e.g. which content type or content format was used, which lists were included a.s.o)

.. code-block:: json

 message DataroomExportItem {
  string id = 1;
  string dataroom_id = 2;
  string parent_id = 3;
  string name = 4;
  string type = 5;
  string author = 6;
  string title = 7;
  optional string path = 8;
  uint32 document_size = 10;
  google.protobuf.Timestamp creation_date = 11;
  google.protobuf.Timestamp modification_date = 12;
  string md5_checksum = 13;
  EffectivePermission effective_permission = 15;
  string document_class = 20;
  repeated ItemPermissionsEntry permissions = 22;
  string hash_value = 23;
  ExportContentType content_type = 24;
  ExportRestrictionType restriction_type = 25;
  ExportContentFormat content_format = 26;
  string archive_id = 27;
  Language archive_language = 28;
  repeated string archive_object_ids = 29;
  repeated ExportReceivers receivers = 30;
  // if set to true, the list of users is included in the export
  optional bool has_user_list = 31;
  optional bool has_activity_log = 32;
  optional bool has_extended_file_list = 33;
  optional string volume = 34;
  optional ExportRestrictionObject restriction_object = 35;
  ItemType item_type = 36;
  optional bool has_qa_file_list = 37;
 }

.. list-table::
   :widths: 20 20 60
   :header-rows: 1

   * - Field
     - Type
     - Description
   * - ``id``
     - ``string``
     -
   * - ``dataroom_id``
     - ``string``
     -
   * - ``parent_id``
     - ``string``
     -
   * - ``name``
     - ``string``
     -
   * - ``type``
     - ``string``
     -
   * - ``author``
     - ``string``
     -
   * - ``title``
     - ``string``
     -
   * - ``path``
     - ``string``
     - **Optional**
   * - ``document_size``
     - ``uint32``
     -
   * - ``creation_date``
     - ``google.protobuf.Timestamp``
     -
   * - ``modification_date``
     - ``google.protobuf.Timestamp``
     -
   * - ``md5_checksum``
     - ``string``
     -
   * - ``effective_permission``
     - ``EffectivePermission``
     -
   * - ``document_class``
     - ``string``
     -
   * - ``permissions``
     - array of ``ItemPermissionsEntry``
     - 
   * - ``hash_value``
     - ``string``
     -
   * - ``content_type``
     - ``ExportContentType``
     -
   * - ``restriction_type``
     - ``ExportRestrictionType``
     -
   * - ``content_format``
     - ``ExportContentFormat``
     -
   * - ``archive_id``
     - ``string``
     -
   * - ``archive_language``
     - ``Language``
     -
   * - ``archive_object_ids``
     - array of ``string``
     -
   * - ``receivers``
     - array of ``ExportReceivers``
     -
   * - ``has_user_list``
     - ``bool``
     - **Optional** If set to true, the list of users is included in the export
   * - ``has_activity_log``
     - ``bool``
     - **Optional**
   * - ``has_extended_file_list``
     - ``bool``
     - **Optional**
   * - ``volume``
     - ``string``
     - **Optional**
   * - ``restriction_object``
     - ``ExportRestrictionObject``
     - **Optional**
   * - ``item_type``
     - ``ItemType``
     -
   * - ``has_qa_file_list``
     - ``bool``
     - **Optional**