{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-exportoptions.json",
  "title": "ExportOptions",
  "description": "Schema for ExportOptions in Nuix REST API",
  "type": "object",
  "properties": {
    "productOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "Adds a new type of file to produce as part of the export.\n* `type` - The type of product to produce.\n  * `native` - Native files, including support for exporting mailboxes.\n  * `text` - Plain text files.\n  * `pdf` - PDF images.\n  * `tiff` - TIFF images.\n  * `xhtml_report` - XHTML metadata reports.\n  * `thumbnail` - Thumbnail files.\n\nSupported options common to multiple product types.\n* `naming` - Selects the type of naming to apply to the produced files\n  * `document_id` (e.g. `ABC-000000001.pdf`)\n  * `document_id_with_page` (e.g. `ABC-000000001_11.pdf`)\n  * `page_only` (e.g. `0001.pdf`)\n  * `full` (e.g. `ABC0010010001.pdf`)\n  * `full_with_periods` (e.g. `ABC.001.001.0001.pdf`)\n  * `item_name` (e.g. `original-name.pdf`)\n  * `item_name_with_path` (e.g. `mailbox/inbox/original-name.pdf`)\n  * `guid` (e.g. `04d/04dd8e72-f087-4f66-848a-6585bce732d5.pdf`)\n  * `md5` (e.g. `790/79054025255fb1a26e4bc422aef54eb4.pdf`)\n\nSupported options for native files\n* `mailFormat` - Selects the format for native exports of emails.\n  * `native` - exports emails in the format they are internally stored with no conversion.\n  * `eml` - converts all messages to RFC822 format.\n  * `html` - converts all messages to HTML format with headers written in.\n  * `mime_html` - converts all messages to MIME/HTML format with headers written in.\n  * `mime_html_mht` - converts all messages to MIME/HTML ( with extension \"mht\") format with headers written in.\n  * `msg` - converts all messages to Outlook MSG format.\n  * `dxl` - converts all messages to Lotus Notes DXL format.\n  * `mbox` - exports all messages into a single MBOX file.\n  * `pst` - exports all messages into a single PST file.\n  * `nsf` - exports all messages into a single NSF file.\n* `includeAttachments` - If true, attachments will be left on email messages. If false, attachments will be stripped off.\n* `regenerateStored` - If true, stored copies of binaries in the case will be regenerated.\n\nSupported options for text files.\n* `wrapLines` - Specifies the column to wrap text files at. If null, no wrapping will be performed.\n* `perPage` - If true, text files will be split with text for each page in a separate file. If false, the entire text for an item will be put in a single file.  Default false.\n* `lineSeparator` - Selects the separators to place between each line of the text.\n* `encoding` - The text files will be exported with the given encoding.  Default \"UTF-8\".\n\nSupported options for PDF files.\n* `regenerateStored` - If true, stored copies of PDFs in the case will be regenerated.  Default false.\n\nSupported options for TIFF files.\n* `regenerateStored` - If true, stored copies of PDFs (used as an intermediate product in order to produce the TIFF) in the case will be regenerated.  Default false.\n* `multiPageTiff` - Specifies whether to generate one TIFF file for each page (false) or all pages in one (true).  Default false.\n* `tiffDpi` - Specifies what DPI to use when generating TIFF images.  Default 300.\n  * `72` - 72 dpi.\n  * `150` - 150 dpi.\n  * `200` - 200 dpi.\n  * `300` - 300 dpi.\n* `tiffFormat` - Specifies what format the tiff files will be created in.  Default \"MONOCHROME_CCITT_T6_G4\".\n  * `MONOCHROME_CCITT_T6_G4` - Black and white, CCITT T.6 Group 4 Fax Encoding.\n  * `GREYSCALE_UNCOMPRESSED` - Greyscale, uncompressed.\n  * `GREYSCALE_DEFLATE` - Greyscale, Zip compression.\n  * `GREYSCALE_LZW` - Greyscale, LZW compression.\n  * `COLOUR_UNCOMPRESSED` - Colour, uncompressed.\n  * `COLOUR_DEFLATE` - Color, zip compression.\n  * `COLOUR_LZW` - Color, LZW compression.\n  * `JPEG` - JPEG format with default compression and quality.\n"
    },
    "loadFileOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "Adds a new load file as a product of the export.\n\n* `type` - The type of load file.\n  * `discover` - Discover.\n  * `ringtail` - Ringtail (MDB).\n  * `concordance` - Concordance.\n  * `summation` - Summation.\n  * `discovery_radar` - Discovery Radar.\n  * `documatrix` - DocuMatrix.\n  * `edrm_xml` - EDRM XML.\n  * `edrm_xml_zip` - EDRM v1.2 XML ZIP.\n  * `ipro` - IPRO.\n  * `xhtml_summary_report` - XHTML summary report.\n  * `csv_summary_report` - CSV summary report.\n  * `md5_digest` - MD5 digest report.\n\nSupported options common to multiple load file types\n* `metadataProfile` - Selects the metadata profile to use for additional metadata for this load file. If null, no extra metadata is used.\n* `encoding` - Selects the encoding (character set) to use when writing the load file.  Default \"UTF-8\".  Used by Concordance.\n* `lineSeparator` - Selects the separators to place between each line of text in the load file.\n* `pathSeparator` - Selects the separators to use between directories when writing paths to exported files into the load file.\n* `maxLoadFileSize` - DEPRECATED: Selects the maximum number of items written to a load file.\n* `loadFileEntryLimit` - Selects the maximum number of items written to a load file.\n* `loadFileByteLimit` - Selects the maximum size, in bytes, of each load file.\n* `addressSeparator` - The separator of multiple addresses.  Default \";\".\n* `compressOutput` - Whether the export output folder needs to be compressed.  Default false.\n\nSupported options for Ringtail (MDB)\n* `version` - Selects the version of Ringtail which the exported database will export. The default value will always be the most recent supported version of Ringtail, so explicitly setting the value is recommended if Ringtail Legal 2005 format is specifically required.  Default 2005.\n* `inheritDates` -  If true, dates of embedded items within the family will always be inherited from the top-level item in the family, instead of following the normal rules for getting the item date.  Default false.\n* `removeCommas` - If true, commas will not be used in number fields.  Default false.\n* `directParent` - If true, the direct parent will be used for the host reference.  Default false.\n* `useDocumentId` - If true, the document id will be used for the page label. It is a property for Ringtail (MDB) only.  Default false.\n* `useNativePageCount` - If true, native page counts will be used for TIFFs in num_pages. It is a property for Ringtail (MDB) only.  Default false.\n* `mappingLocation` - The location of the file mapping from the load file metadata to the Ringtail types. It is the script writer's responsibility to ensure the mapping will be valid. The file should be a CSV file with a header line consisting of \"Category,Label\". The valid categories are TEXT, MEMO, NUMB, PICK and DATE and the labels should use the same format as metadataText in the stamping options.\n* `extrasFieldSeparator` - The separator of multi-value fields.  Default \";\".\n\nSupported options for EDRM XML\n* `version` - Selects the version of the EDRM XML specification will be used for the export. The default value will always be the most recent supported version of the specification, so explicitly setting the value is recommended if version 1.1 is specifically required.  Default \"1.1\".\n"
    },
    "imagingOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "Sets the imaging options to use for the export.\n* `imageExcelSpreadsheets` - DEPRECATED: Specifies whether to image Excel spreadsheets, instead of generating a slip sheet. This is replaced with Imaging Profiles since Nuix 7.2.  Default false.\n* `slipSheetContainers` - DEPRECATED: - Same as exportDescendantContainers since Nuix 7.2.\n* `excelExportEngine` - Optionally select which export method to use for generating PDFs.  Default \"INTERNAL\".\n  * `MS_OFFICE` - Export Excel documents using Microsoft Office.\n  * `INTERNAL` - Export Excel documents using the built in exporter.\n* `excelPrintHiddenRows` - Optionally unhide all Excel rows.\n* `excelPrintHiddenColumns` - Optionally unhide all Excel columns.\n* `excelPrintHiddenWorksheets` - Optionally force hidden or very hidden Excel worksheets to be printed.  Default \"SHEET_VERY_HIDDEN\".\n  * `SHEET_HIDDEN` - Show hidden worksheets.\n  * `SHEET_VERY_HIDDEN` - Show hidden and very hidden worksheets.\n* `excelPrintComments` - Optionally set for Excel the way comments are printed with the sheet.\n  * `PRINT_IN_PLACE` - Print in original location.\n  * `PRINT_NO_COMMENTS` - Do not print.\n  * `PRINT_SHEETEND` - Print as end notes.\n* `excelPrintNotes` - Optionally set for Excel cell notes to be printed as end notes with the sheet.\n* excelPaperSize\n  * `PAPER_10x14` - 10 in. x 14 in.\n  * `PAPER_11x17` - 11 in. x 17 in.\n  * `PAPER_A3` - A3 (297 mm x 420 mm).\n  * `PAPER_A4` - A4 (210 mm x 297 mm).\n  * `PAPER_A4Small` - A4 Small (210 mm x 297 mm).\n  * `PAPER_A5` - A5 (148 mm x 210 mm).\n  * `PAPER_B4` - B4 (250 mm x 354 mm).\n  * `PAPER_B5` - A5 (148 mm x 210 mm).\n  * `PAPER_Csheet` - C size sheet.\n  * `PAPER_Dsheet` - D size sheet.\n  * `PAPER_Envelope10` - Envelope #10 (4-1/8 in. x 9-1/2 in.).\n  * `PAPER_Envelope11` - Envelope #11 (4-1/2 in. x 10-3/8 in.).\n  * `PAPER_Envelope12` - Envelope #12 (4-1/2 in. x 11 in.).\n  * `PAPER_Envelope14` - Envelope #14 (5 in. x 11-1/2 in.).\n  * `PAPER_Envelope9` - Envelope #9 (3-7/8 in. x 8-7/8 in.).\n  * `PAPER_EnvelopeB4` - Envelope B4 (250 mm x 353 mm).\n  * `PAPER_EnvelopeB5` - Envelope B5 (176 mm x 250 mm).\n  * `PAPER_EnvelopeB6` - Envelope B6 (176 mm x 125 mm).\n  * `PAPER_EnvelopeC3` - Envelope C3 (324 mm x 458 mm).\n  * `PAPER_EnvelopeC4` - Envelope C4 (229 mm x 324 mm).\n  * `PAPER_EnvelopeC5` - Envelope C5 (162 mm x 229 mm).\n  * `PAPER_EnvelopeC6` - Envelope C6 (114 mm x 162 mm).\n  * `PAPER_EnvelopeC65` - Envelope C65 (114 mm x 229 mm).\n  * `PAPER_EnvelopeDL` - Envelope DL (110 mm x 220 mm).\n  * `PAPER_EnvelopeItaly` - Envelope (110 mm x 230 mm).\n  * `PAPER_EnvelopeMonarch` - Envelope Monarch (3-7/8 in. x 7-1/2 in.).\n  * `PAPER_EnvelopePersonal` - Envelope (3-5/8 in. x 6-1/2 in.).\n  * `PAPER_Esheet` - E size sheet.\n  * `PAPER_Executive` - Executive (7-1/2 in. x 10-1/2 in.).\n  * `PAPER_FanfoldLegalGerman` - German Legal Fanfold (8-1/2 in. x 13 in.).\n  * `PAPER_FanfoldStdGerman` - German Legal Fanfold (8-1/2 in. x 13 in.).\n  * `PAPER_FanfoldUS` - U.S. Standard Fanfold (14-7/8 in. x 11 in.).\n  * `PAPER_Folio` - Folio (8-1/2 in. x 13 in.).\n  * `PAPER_Ledger` - Ledger (17 in. x 11 in.).\n  * `PAPER_Legal` - Legal (8-1/2 in. x 14 in.).\n  * `PAPER_Letter` - Letter (8-1/2 in. x 11 in.).\n  * `PAPER_LetterSmall` - Letter Small (8-1/2 in. x 11 in.).\n  * `PAPER_Note` - Note (8-1/2 in. x 11 in.).\n  * `PAPER_Quarto` - Quarto (215 mm x 275 mm).\n  * `PAPER_Statement` - Statement (5-1/2 in. x 8-1/2 in.).\n  * `PAPER_Tabloid` - Tabloid (11 in. x 17 in.).\n* `excelPageOrientation` - Optionally set Excel page orientation (portrait or landscape) for every worksheet.\n  * `PORTRAIT` - Portrait mode.\n  * `LANDSCAPE` - Landscape mode.\n* `excelPageZoom` - Optionally set Excel page zoom value that represents a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing.\n  * `PERCENT_10` - 10%.\n  * `PERCENT_25` - 25%.\n  * `PERCENT_50` - 50%.\n  * `PERCENT_75` - 75%.\n  * `PERCENT_100` - 100%.\n  * `PERCENT_125` - 125%.\n  * `PERCENT_150` - 150%.\n  * `PERCENT_200` - 200%.\n  * `PERCENT_400` - 400%.\n* `excelFitToPagesTall` - Optionally set for Excel the number of pages tall the worksheet will be scaled to when it's printed.\n* `excelFitToPagesWide` - Optionally set for Excel the number of pages wide the worksheet will be scaled to when it's printed.\n* `excelWorksheetPrintArea` - Optionally set Excel print area for every worksheet.\n* `excelPageNumberLimit` - Optionally set the page number limit for Excel. The value must be a positive number.\n* `excelPrintGridlines` - Optionally force Excel gridlines to be always shown or hidden.\n* `excelPrintHeadings` - Optionally force Excel headers to be hidden or shown.\n* `wordExportEngine` - Optionally select which export method to use for generating PDF's.\n  * `MS_OFFICE` - Export Word documents using Microsoft Office.\n  * `INTERNAL` - Export Word documents using the built in exporter.\n* `wordShowMarkup` - Optionally force Word to show markup (such as track-changes) or hide it.\n* `wordShowHiddenText` - Optionally force PowerPoint to show markup (such as track-changes or hidden text) or hide it.\n* `powerPointExportEngine` - Optionally select which export method to use for generating PDF's. Note: Only PRINT_OUTPUT_SLIDES is supported for INTERNAL.\n  * `MS_OFFICE` - Export Powerpoint documents using Microsoft Office.\n  * `INTERNAL` - Export Powerpoint documents using the built in exporter.\n* `powerPointPrintOutputType` - PRINT_OUTPUT_SLIDES A value that indicates which component (slides, handouts, notes pages, or an outline) of the presentation is to be printed.\n  * `PRINT_OUTPUT_BUILD_SLIDES` - Build Slides.\n  * `PRINT_OUTPUT_FOUR_SLIDE_HANDOUTS` - Four Slide Handouts.\n  * `PRINT_OUTPUT_NINE_SLIDE_HANDOUTS` - Nine Slide Handouts.\n  * `PRINT_OUTPUT_NOTES_PAGES` - Notes Pages.\n  * `PRINT_OUTPUT_ONE_SLIDE_HANDOUTS` - Single Slide Handouts.\n  * `PRINT_OUTPUT_OUTLINE` - Outline.\n  * `PRINT_OUTPUT_SIX_SLIDE_HANDOUTS` - Six Slide Handouts.\n  * `PRINT_OUTPUT_SLIDES` - Slides.\n  * `PRINT_OUTPUT_THREE_SLIDE_HANDOUTS` - Three Slide Handouts.\n  * `PRINT_OUTPUT_TWO_SLIDE_HANDOUTS` - Two Slide Handouts.\n* `slipSheetMetadataProfile` - Optionally insert values from a metadata profile into generated slip-sheets.\n"
    },
    "numberingOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "* `createProductionSet` - Sets whether a production set should be created.  Default true.\n* `delimiter` - Selects the string to use when separating the parts of a number for writing into a load file. Note: Not supported for document ID based numbering.  Default \".\"\n* `groupDocumentPages` - If true, numbering will roll over to the next folder to avoid splitting a single document. Note: Not supported for document ID based numbering.  Default true.\n* `groupFamilyItems` - If true, numbering will roll over to the next folder to avoid splitting a family of documents. Note: Not supported for document ID based numbering.  Default false.\n* `prefix` - Specifies the prefix for numbering. If null, disables the prefix component.\n* `box`, `folder`, `page`, `documentId` - A nested map of options for the specified component. See the table below for the definition of each option in these nested maps.\n  \n  Settings for documentId components\n  * `minWidth` - Specifies the minimum width of the numbering component. If the number used for this component is shorter, it will be padded out to the specified width. However, numbering may overflow, so it is possible for a longer number to appear.  Default 9.\n  * `startAt` - Specifies the number to start at.  Default 1.\n\n  Settings for formattedDocumentId components\n  * `minWidth` - Specifies the minimum width of the numbering component. If the number used for this component is shorter, it will be padded out to the specified width. However, numbering may overflow, so it is possible for a longer number to appear.  Default 9.\n  * `startAt` - Specifies the number to start at, and includes all the formatting characters in each document ID, e.g. \"00.00.01\".  Default \"1\".\n  * `pageDelimiter` - Specifies the delimiter that will appear before individual page numbers.  Default \"_\".\n  * `labelFirstPage` - Specifies whether the page number suffix will appear on the first page of a document.  Default true.\n\n  Settings for box, folder, and page componenents\n  * `minWidth` - Specifies the minimum width of the numbering component. If the number used for this component is shorter, it will be padded out to the specified width. However, numbering may overflow, so it is possible for a longer number to appear.  Default 3.\n  * `from` - Specifies the lowest number in the sequence. When numbering wraps around, this becomes the next number.  Default 1.\n  * `to` - Specifies the highest number in the sequence. Numbering will be wrapped around the next number after this number is used.  Default 999.\n  * `startAt` - Specifies the number to start at.  Default 1.\n"
    },
    "stampingOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "The stamping options.  \nSpecifies the options for the respective stamping area of the page. Options supported inside the nested hash are detailed below.\n* `headerLeft`, `headerCentre`, `headerRight`, `footerLeft`, `footerCentre`, `footerRight`\n\n  Supported options for stamper areas (headerLeft, footerCentre, etc.)\n  * `type` - Specifies what type of information to write into the stamper location.\n    * `name` - The name of the item.\n    * `guid` - The GUID of the item.\n    * `document_number` - The document number of the page of the item (changes each page.)\n    * `first_document_number` - The document number of the first page of the item.\n    * `page_number` - The number of the current page within the item.\n    * `page_count` - The count of all pages within the item.\n    * `item_id` - DEPRECATED: The \"Item ID\" for the item. Deprecated in Nuix 5.2 as Item ID is being removed. As a transitional measure, this currently stamps the same as \"guid\", but support will be removed completely in the future.\n    * `produced_by` - A string indicating the software producing the export products.\n    * `md5` - The MD5 digest for the item.\n    * `sha1` - The SHA-1 digest for the item.\n    * `sha256` - The SHA-256 digest for the item.\n    * `document_id` - The document ID of the item within the production set used to export.\n    * `production_set_name` - The name of the production set used to export.\n    * `custom` - custom text which will be the same for every item. Requires the customText option to be specified as well.\n  * `metadata` - reference to a metadata column by name. Requires either the metadataItem or metadataText option to be specified as well.\n  * `customText` - Specifies the custom text to put in the header when type is \"custom\". Custom text may include other embedded fields by using %{tag} where 'tag' is one of the available type options in this section. e.g. \"Page %{page_number} of %{page_count}\" will generate \"Page 3 of 5\". You can also use this same syntax in the Nuix Legal Export Headers and Footers dialog box to produce the same effect from within the GUI. You cannot use %{custom} as a tag inside a custom text string (i.e. it cannot be recursive).\n  * `metadataItem` - Specifies the metadata column to put in the header when type is \"metadata\".\n  * `metadataText` - DEPRECATED: metadataText is deprecated and replaced with metadataItem.\n  * `font` - Specifies the font to use for stamped text. This can be used, for instance, to insert a bar code font. The support options for the font hash are documented below.\n    * `family` - Specifies the font family by name.\n    * `style` - Specifies the style to use. If null, plain style will be used.\n    * `size` - Specifies the size to draw the text at.\n* `headerLine` - Default false. Specifies whether to draw a line separating the header or footer content from the body of the document. The line will only be drawn if the values being drawn in the header or footer are non-blank.\n* `footerLine` - Default false.\n* `increasePageSize` - Default false. Specifies whether to increase the size of the page to accommodate the header and footer.\n"
    },
    "traversalOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "Sets the traversal options to use for the export.\n* `strategy` - Selects the method of selecting which items to export based on the items which are passed into exportItems.  Default \"items\".\n  * `items` - Exports only the items specified.\n  * `items_and_descendants` - Exports the items specified, and any descendants.\n  * `top_level_items` - Exports the top-level items for the items specified.\n  * `top_level_items_and_descendants` - Exports the top-level items for the items specified, and any descendants of the top-level items.\n  * `deduplicated_top_level_items` - DEPRECATED - Same as \"top_level_items\" with deduplicate set to \"md5\". \n  * `deduplicated_top_level_items_and_descendants` - DEPRECATED -  Same as \"top_level_items_and_descendants\" with deduplicate set to \"md5\".\n* `deduplication` - Selects the method of deduplication to use when a top-level item export is being used.  Default \"none\".\n  * `none` - Performs no deduplication.\n  * `md5` - Performs deduplication by md5.\n  * `per custodian` - Performs deduplication as md5 per custodian.\n* `sortOrder` - Selects the method of sorting items during the export.  Default \"none\" if strategy is \"items\", \"position\" otherwise.\n  * `none` - Exports the items in the original order. This order will only give sensible results if strategy is \"items\"\n  * `position` - Sorts by position.\n  * `top_level_item_date` - Sorts by top level item date.\n  * `top_level_item_date_descending` - Sorts by top level item date descending.\n  * `document_id` - Sorts items based on their document IDs for the current production set. Note:This option is only valid if exporting a production set.\n* `exportDescendantContainers` - Default false.  Specifies whether to export descendant container items, instead of omitting them. This only has an effect if \"strategy\" = \"items_and_descendants\", \"top_level_items_and_descendants\", or \"deduplicated_top_level_items_and_descendants\".\n"
    },
    "skipNativesSlipsheetedItems": {
      "type": "boolean",
      "description": "Sets whether to skip export of natives for slip-sheeted items."
    },
    "nearDuplicateOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "Sets the near-duplicate options to be used in legal export.\n* `resemblanceThreshold` - Specifies the resemblance threshold to use for the export of any metadata items that require the computation of (chained) near-duplicates.\n"
    },
    "promoteToDiscoverOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "Sets the options to promote to Nuix Discover.\n* `caseId` - REQUIRED. The unique identifier of the Discover case.\n* `token` - REQUIRED.  The application token to authenticate against the Nuix Discover API v2 or newer.  Note: This field carries the Discover Instance URI and app key encoded in it.\n* `jobId` - The unique identifier of the job.\n* `level` - The base name of the folder where the binaries will be uploaded to.  For example, Promotions/<Case GUID>/<Job GUID>.\n* `docsPerLevel` - Number of documents per level. New sub-folders under level will be created once this limit is reached.\n* `deduplication` - Whether or not Nuix Discover should deduplicate imported items.\n"
    }
  }
}