"
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: object
additionalProperties:
type: object
example:
- Name: MyWordDoc.docx
File Type: Microsoft 2007 Word Document
Path Name: /Evidence 1/Documents
guid: 5cc38060-640c-4fbb-91d0-b319812a5f0b
"404":
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/cases/{caseId}/items/{itemGuid}/download:
get:
tags:
- Export
summary: Downloads an item from a case
description: Use this operation to download a specific item from a case. This
API uses the original file name to determine the best format to download the
item. The item is downloaded by streaming its binary content using its original
file name and MIME type. This content is returned in the response body.
operationId: downloadItem
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
- name: overwriteExisting
in: query
description: Overwrite Existing; this value is treated as always true for PDFs
required: false
schema:
type: boolean
default: false
- name: populateBinaryStores
in: query
description: If true, the binary store will be regenerated for this item.
required: false
schema:
type: boolean
default: false
- name: populatePrintedImageStores
in: query
description: If true, the printed image store will be regenerated for this item.
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/octet-stream:
schema:
type: string
format: binary
head:
tags:
- Export
summary: Downloads an item from a case
description: Use this operation to download a specific item from a case. This
API uses the original file name to determine the best format to download the
item. The item is downloaded by streaming its binary content using its original
file name and MIME type. This content is returned in the response body.
operationId: downloadItemHead
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
- name: overwriteExisting
in: query
description: Overwrite Existing; this value is treated as always true for PDFs
required: false
schema:
type: boolean
default: false
- name: populateBinaryStores
in: query
description: If true, the binary store will be regenerated for this item.
required: false
schema:
type: boolean
default: false
- name: populatePrintedImageStores
in: query
description: If true, the printed image store will be regenerated for this item.
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: string
/cases/{caseId}/itemBinaries/{itemGuid}:
get:
tags:
- Export
summary: Streams an item binary from a case if it is available
description: Use this operation to stream a specific item binary from a case
if the item binary is available.This API uses the original file name to determine
the best format to download the item.The item is downloaded by streaming its
binary content using its original file name and MIME type.
operationId: downloadItemBinary
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/octet-stream:
schema:
type: string
format: binary
"500":
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Source Item Not Available:
value:
serverId: "nuix-restful-server-1"
errorCode: ENGINE_EXCEPTION
developerMessage: Error getting byte region
userMessage: Could not export item as binary
additionalInfo:
rootExceptionClass: java.io.IOException
rootExceptionMessage: "Source data missing for item: 3d4ad678-4127-423a-aea1-956de9ed2d21/item.pdf/ (image/jpeg) {cd6f8bd9-3b7e-450e-afd3-2f1be82a3bdf}"
head:
tags:
- Export
summary: Streams an item binary from a case if it is available
description: Use this operation to stream a specific item binary from a case
if the item binary is available.This API uses the original file name to determine
the best format to download the item.The item is downloaded by streaming its
binary content using its original file name and MIME type.
operationId: downloadItemBinary_1
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
responses:
"200":
description: default response
"500":
description: error response
/cases/{caseId}/items/{itemGuid}/view:
get:
tags:
- Export
summary: Enables you to view a case item
description: Use this operation to view a case item. The REST API uses the
original file name to determine the best format to view the item. This endpoint
returns the binary data with the MIME type set in the Content-Type header
so you are viewing the actual item.
For example, you can use this
endpoint to view a case item in a web browser. The API will determine the
best format to view this item in the browser.
operationId: downloadItemBestFormat
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
- name: overwriteExisting
in: query
description: Overwrite Existing
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
multipart/form-data:
schema:
type: string
format: binary
head:
tags:
- Export
summary: Enables you to view a case item
description: Use this operation to view a case item. The REST API uses the
original file name to determine the best format to view the item. This endpoint
returns the binary data with the MIME type set in the Content-Type header
so you are viewing the actual item.
For example, you can use this
endpoint to view a case item in a web browser. The API will determine the
best format to view this item in the browser.
operationId: downloadItemBestFormatHeadRequest
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
- name: overwriteExisting
in: query
description: Overwrite Existing
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: string
/cases/{caseId}/items/{itemGuid}/comment:
get:
tags:
- Analysis
summary: Returns comments for an item
description: Use this operation to view comments associated with an item. Multiple comments are delimeted by the newline (\n) character.
operationId: getItemComment
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemCommentResponse'
example:
itemGuid: 9dd7ebaa-0671-4f73-add7-d38d920105eb
itemComment: this is an item comment
"404":
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
Invalid Item GUID:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'ITEM' and identifier '96c3defc-ee21-4972-9561-d69622c25389' could not be found."
userMessage: "The resource of type 'ITEM' and identifier '96c3defc-ee21-4972-9561-d69622c25389' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
put:
tags:
- Analysis
summary: Applies a comment to an item
description: Use this operation to apply a comment to an item. This will modify any existing comment.
The boolean field **(append)** is available to let you replace or append the comment. By default, existing comments are
replaced. Appended comments are done so with the newline (\n) character.
operationId: modifyItemComment
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
- name: append
in: query
description: Append to existing comment
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemCommentRequest'
responses:
"200":
description: default response
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ItemCommentResponse'
examples:
Simple Comment:
value:
itemGuid: 9dd7ebaa-0671-4f73-add7-d38d920105eb
itemComment: this is an item comment
Appended Comment:
value:
itemGuid: 9dd7ebaa-0671-4f73-add7-d38d920105eb
itemComment: "This is an item comment.\nThis comment is appended."
"404":
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
Invalid Item GUID:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'ITEM' and identifier '96c3defc-ee21-4972-9561-d69622c25389' could not be found."
userMessage: "The resource of type 'ITEM' and identifier '96c3defc-ee21-4972-9561-d69622c25389' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/cases/{caseId}/itemShingles:
put:
tags:
- Analysis
summary: Calculates the number of shingles associated with a case's items
description: |
Use this operation to see how many shingles are associated with
the items in a case. This operation starts an asynchronous task to count the
shingles.
Shingling enables you to find near-duplicate items by extracting the textual essence from each document and applying that pattern to a data set
to find similar documents. Each shingle, or pattern, generally consists of a phrase of 5 or 6 words. For example, you could use shingling
to find the Word document that a PDF was created from. The binary makeup of the documents is different, but the content is the same.
operationId: getItemsShingles
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemsShinglesRequest'
example:
query: "kind:document"
deduplication: md5
maxItems: 5
maxShingleResponse: 5
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
example:
functionKey: 1277e4ce-a1dd-421a-b4e0-41c40404908a
location: "http://localhost:8080/svc/v1/asyncFunctions/1277e4ce-a1dd-421a-b4e0-41c40404908a"
/cases/{caseId}/itemSets/{itemSetNameOrGuid}:
get:
tags:
- Culling
summary: Returns details for an item set
description: Use this operation to view details for an item set in a case.
This
endpoint returns an AsyncFunctionResponse.
operationId: getItemSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemSetResponse'
examples:
Item Set Details:
value:
guid: "0d2e7cc9-8e6d-4f44-9054-3c0d8642acbc"
name: MyItemSet
description: The item set description.
batches:
- batchName: "22/06/28 14:30:25 EDT"
createdOn: 1656441025778
put:
tags:
- Culling
summary: Renames an item set
description: Use this operation to rename an item set associated with a case.
operationId: renameItemSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemSetNameChangeRequest'
examples:
Rename an Item Set:
value:
newName: MyNewItemSetName
responses:
"204":
description: default response
delete:
tags:
- Culling
summary: Deletes an item set from a case
description: Use this operation to delete a specific item set associated with a case.
operationId: deleteItemSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
example:
functionKey: "12451c5f-eaf9-4089-9a90-3df32944e5fc"
location: "http://localhost:8080/svc/v1/asyncFunctions/12451c5f-eaf9-4089-9a90-3df32944e5fc"
/cases/{caseId}/itemSets:
get:
tags:
- Culling
summary: Returns item sets associated with a case
description: Use this operation to view the names and descriptions for each
item set in a case.
operationId: getItemSets
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemSetResponse'
examples:
Get Item Sets:
value:
- guid: "d2e331a8-9228-45b4-ae73-6313574fab8e"
name: "MyItemSet"
description: A description of the item set
batches:
- batchName: "22/06/28 10:41:01 EDT"
createdOn: 1656427261910
post:
tags:
- Culling
summary: Creates an item set within a case
description: Use this operation to create an item set in a case. Creating an item set enables you to deduplicate content by removing duplicate copies.
operationId: asyncCreateItemSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/ItemSetCreateRequest'
examples:
Simple Item Set Create Request:
value:
name: MyItemSet
description: My item set description
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemSetRequest'
examples:
Simple Item Set Create Request:
value:
name: MyItemSet
description: My item set description
responses:
"201":
description: default response
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
examples:
Standard Asynchronous Function Response:
value:
functionKey: 1aea3a2c-889c-4670-8779-7334089025cb
location: "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/1aea3a2c-889c-4670-8779-7334089025cb"
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
examples:
Standard Asynchronous Function Response:
value:
functionKey: 1aea3a2c-889c-4670-8779-7334089025cb
location: "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/1aea3a2c-889c-4670-8779-7334089025cb"
/cases/{caseId}/itemSets/{itemSetNameOrGuid}/duplicates:
get:
tags:
- Culling
summary: Returns the duplicate items in this set
description: Gets the items that are deemed duplicates in the context of this
set after deduplication. Returns a list of GUIDs of each duplicate item.
operationId: getItemSetDuplicates
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
- name: batch
in: query
description: Item set batch name, defaults to all batches
required: false
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemSetDuplicatesResponse'
examples:
Duplicates:
value:
duplicates:
- "d3d63fe9-14f1-4cd8-a66a-64f9f6479c27"
- "95aaf52a-1051-43f5-801a-9dc49414fe99"
/cases/{caseId}/itemSets/{itemSetNameOrGuid}/{itemGuid}/duplicates:
get:
tags:
- Culling
summary: Returns duplicates for an item in an item set
description: Finds items classified as duplicates of an item within an item
set. If the item is original, all of its duplicates within the item set will
be returned. If the item is classified as a duplicate within the item set
the original and all other duplicates within the item set will be returned.
If the item set was deduplicated by family, duplicates will be restricted
to items within duplicate families. Sets of type SCRIPTED are not supported
by this method. Returns a list of GUIDs of each duplicate item.
operationId: findItemSetItemDuplicates
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item guid to find duplicates of
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemSetDuplicatesResponse'
examples:
Duplicates:
value:
duplicates:
- "0e4be68b-96a3-43e0-96fc-f6098b04c6b4"
- "f43a0419-2d88-4914-87ff-7d6aec511868"
/cases/{caseId}/itemSets/{itemSetNameOrGuid}/originals:
get:
tags:
- Culling
summary: Returns the original items in this set
description: Gets the items that are deemed originals in the context of this set after deduplication.
operationId: getOriginals
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
- name: batch
in: query
description: Item set batch name, defaults to all batches
required: false
schema:
type: string
- name: startIndex
in: query
description: The index of the first record that should be returned. Defaults
to 0.
required: false
schema:
type: integer
format: int32
- name: numberOfRecordsRequested
in: query
description: The number of records that should be returned. Defaults to 100
records.
required: false
schema:
type: integer
format: int32
- name: metadataProfile
in: query
description: Defines the metadata profile to be appied to the results. Needed
to get custom metadata. Defaults to no metadata profile.
required: false
schema:
type: string
- name: fieldList
in: query
description: List of fields to be returned for each item in the results.
required: false
schema:
type: array
items:
type: string
- name: customMetadataList
in: query
description: List of custom metadata to be returned for each item in the results. Maintained for backward compatibility.
required: false
schema:
type: array
items:
type: string
- name: propertyList
in: query
description: List of properties to be returned for each item in the results.
required: false
schema:
type: array
items:
type: string
- name: itemParameterizedFields
in: query
description: Specifies parameterized fields in a key/value pair separated by a colon.
* `entities` - corresponds to item.getEntities. (e.g., "entities:company")
* `serializedItem` - returns a serialized copy of the item. (e.g., "seralizedItem:topLevelItem")
* `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., "textTruncated:10000")
* `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., "thumbnail:200x200")
* `nearDupeThreshold` - (e.g., "nearDupeThreshold:0.9")
* `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., "emailThreadCluster:cluster-1")
required: false
schema:
type: array
items:
type: string
- name: sortField
in: query
description: |
Any field in the metadata profile which you want to sort by.
Use the following supported fields in the sortFields:
position,kind,duplicates
required: false
schema:
type: string
- name: sortOrder
in: query
description: Sets the sort order for the results. Possible values are [asc,desc]
required: false
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/MarshalledItems'
/cases/{caseId}/itemSets/{itemSetNameOrGuid}/items:
get:
tags:
- Culling
summary: Returns items in an item set
description: Use this operation to view the items associated with an item set in a case.
operationId: getItemSetItems
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
- name: batchName
in: query
description: Batch name (null for all batches)
required: false
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/SearchNativeResult'
examples:
Item Set Items Response:
value:
request:
caseId: "09f166a30f5e430db01d2f7b67f5ec27"
query: "item-set:0d2e7cc9-8e6d-4f44-9054-3c0d8642acbc"
startIndex: 0
numberOfRecordsRequested: 2
deduplicate: null
metadataProfile: Default
fieldList: [ ]
customMetadataList: null
propertyList: null
itemParameterizedFields: null
sortField: null
sortOrder: null
s: 0
p: 2
metadataItems:
- Name
- File Type
- Path Name
localizedMetadataItems:
- Name
- File Type
- Path Name
metadataItemDetails:
- name: Name
localisedName: Name
type: String
- name: File Type
localisedName: File Type
type: String
- name: Path Name
localisedName: Path Name
type: String
resultList:
- File Type: Zip-Compressed File
Name: first-zip.zip
Path Name: /4c8c2d2c-2fa3-476f-ac61-77631c370219/api
guid: dc8cceb2-45df-4914-859e-8453e11a01ba
- File Type: Directory
Name: jquery
Path Name: /4c8c2d2c-2fa3-476f-ac61-77631c370219/api
guid: 269f78c6-bcc2-4805-ad32-28b826b8df22
count: 204566
deduplicatedCount: 204566
post:
tags:
- Culling
summary: Adds items to an item set
description: |
Use this operation to add items to an existing item set in a case.
Each addition of items to the set is classified as a batch which facilitates
rolling deduplication, whereby more items are added to a set and deduplicated
against the existing set members.
operationId: addItemsToItemSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemSetAddItemsRequest'
examples:
Add Items to an Item Set:
value:
batchName: MyBatchName
query: "file-extension:html"
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
examples:
Standard Asynchronous Function Response:
value:
functionKey: c2b5a20b-3cd1-4eb3-b600-6fa909ba0949
location: "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949"
delete:
tags:
- Culling
summary: Removes items from an item set
deprecated: true
description: Use this operation to remove items from an existing item set in
a case. When removing items from an item set with family-level deduplication,
operations on top-level originals are applied to their families (removal or
re-assignment) but operations on individual descendants and duplicates are
applied to those items only.
operationId: removeItemsFromItemSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ItemSetRemoveItemsRequest'
responses:
"204":
description: default response
patch:
tags:
- Culling
description: Use this operation to add items to or delete items from an existing item set in a case.
summary: Add or delete items to an item set in bulk.
operationId: patchItemsFromItemSet
parameters:
- name: caseId
in: path
required: true
description: Case identification token
schema:
type: string
- name: itemSetNameOrGuid
in: path
required: true
description: The item set name or GUID.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkItemSetItemsRequest'
examples:
Bulk Add Items to ItemSet:
value:
addItems:
- batchName: myBatch
query: "*"
removeItems: []
Bulk Remove Items From ItemSet:
value:
removeItems:
- query: "*"
addItems: [ ]
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/BulkApplyItemSetChangeResponse'
examples:
Bulk Add Items to ItemSet:
value:
results:
- query: "*"
itemSetName: MyItemSet
operationType: ADD
failedItemGuidList: []
successfulItemGuidList:
- d7f6abcd-0555-4a4f-ad52-09a27490061f
Bulk Remove Items from ItemSet:
value:
results:
- query: "*"
itemSetName: MyItemSet
operationType: DELETE
failedItemGuidList: [ ]
successfulItemGuidList:
- d7f6abcd-0555-4a4f-ad52-09a27490061f
/licenseServer/credentials:
put:
tags:
- Licensing
summary: Update and persist license server credentials
description: Updates and attempts to persist the license server credentials. This endpoint will validate the credentials
provided, persist, and encrypt the user credentials.
operationId: "setLicenseServerCredentials"
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AuthenticationRequest'
example:
username: "user1"
password: "mysecurepassword"
responses:
"200":
description: "The REST configuration change response object."
content:
application/json;charset=UTF-8:
schema:
$ref: "#/components/schemas/ConfigurationChangeResponse"
examples:
Persistent Successful Password Change:
value:
message: Success.
status: PERSISTENT
Transient Successful Password Change:
value:
message: Success.
status: TRANSIENT
Failed Password Change:
value:
message: "Unable to verify NMS credentials. Invalid username and/or password."
status: FAILED
/cases/{caseId}/itemSets/{itemSetNameOrGuid}/batches:
get:
tags:
- Culling
summary: Returns the batches in this item set
description: Use this operation to view batches associated with this item set.
Batches are a subset of items within an item set that were added to the set
at the same time. Item sets are grouped in a batch by date.
Batch
load details objects store the settings and items from a processing session.
These include the operating system, architecture, case evidence settings,
data processing settings, parallel processing settings, batch load items,
and the date and time the batch was loaded.
operationId: getItemSetBatches
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: itemSetNameOrGuid
in: path
description: The item set name or GUID.
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemSetBatchResponse'
examples:
Item Set Batches:
value:
- batchName: MyBatchName
createdOn: 1656442334287
- batchName: "22/06/28 14:30:25 EDT"
createdOn: 1656441025778
/licenses:
get:
tags:
- Licensing
summary: Returns a list of available licences
description: Use this operation to view a list of your available licences. This
information comes from the Nuix Management Server (NMS) or Cloud License Server (CLS).
operationId: getAvailableLicensesAus
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/LicenseDescription'
examples:
Unauthenticated Response:
value:
shortname: enterprise-workstation
count: 8
configuredCount: 10
description: Nuix eDiscovery Workstation
workers: 6
configuredWorkers: 10
audited: false
auditThreshold: 0
source: null
type: null
location: null
expiry: null
legalHoldHoldCountLimit: null
concurrentUserLimit: null
canChooseWorkers: null
Authenticated Response:
value:
source: h{type=server, location=yourserver:27443}
type: server
location: yourserver:27443
shortname: enterprise-workstation
count: 8
configuredCount: 10
description: Nuix eDiscovery Workstation
workers: 6,
configuredWorkers: 10
audited: false
auditThreshold: 0
expiry: 1602720000000
legalHoldHoldCountLimit: null
concurrentUserLimit: null
canChooseWorkers: true
/kinds:
get:
tags:
- Resources
summary: Returns all item kinds
description: Use this operation to view the item kinds currently available with
this API. A kind is a collection of types which are similar and grouped together.
These are not case specific. This is useful for analysis.
operationId: getKinds
responses:
"200":
description: The list of item kinds.
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/NuixItemKindResponse'
example:
- name: email
localisedName: Email
- name: calendar
localisedName: Calendar
- name: document
localisedName: Documents
/searchMacros:
get:
tags:
- Resources
summary: Returns all search macros names and expansions
description: Use this operation to view the search macros names and expansions
for all cases. If there aren't any search macros available, the returned list
will be empty. Macros are used to identify relevant items and screen
them for information. These are useful when the screening process needs to
be repeated regularly.
operationId: getSearchMacros
responses:
"200":
description: Structured search macro response.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/SearchMacroStructuredResponse'
example:
files: null
folders:
Context Groups:
files: null
folders:
Device Access:
files:
- name: USB Devices
expansion: "(properties:\"registryvalue friendlyname\" AND (mime-type:application/vnd.ms-registry-key) AND (path-name:usb)) OR (properties:(\"Event ID:2100\" OR \"Event ID:2102\" OR \"Event ID:157\")) "
- name: Mounted Devices
expansion: "((mime-type:application/vnd.ms-registry-key) AND (name:MountedDevices)) "
/shingleLists:
get:
tags:
- Resources
summary: Returns all shingle list names and expansions
description: Use this operation to view the shingle list names and expansions
for all cases. If there aren't any shingle lists available in the shingle
lists store, the returned list will be empty.
operationId: getShingleLists
responses:
"200":
description: An array of shingle list names.
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- MyShingleList.shlist
/wordLists:
get:
tags:
- Resources
summary: Returns all word list names
description: Use this operation to view the word list names for all cases. If
there aren't any word lists available, the returned list will be empty.
operationId: getWordLists
responses:
"200":
description: An array of word lists.
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- MyWordList
/fuzzyHashLists:
get:
tags:
- Resources
summary: Returns all fuzzy hash list names
description: Use this operation to view all fuzzy hash list names. If there
aren't any fuzzy hash lists available, the returned list will be empty.
operationId: getFuzzyHashLists
responses:
"200":
description: An array of fuzzy has lists.
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- MyFuzzyHashList
/metadataProfiles:
get:
tags:
- Resources
summary: Returns all metadata profile names
description: Use this operation to view the metadata profile names for all cases.
These represent the item data that should be displayed in a query, including
fields and properties. The metadata profile names are returned as
a set of strings.
operationId: getMetadataProfiles
responses:
"200":
description: The list of metadata profile names.
content:
application/vnd.nuix.v1+json:
schema:
uniqueItems: true
type: array
items:
type: string
example:
- Context
- Default
- Discover
/types:
get:
tags:
- Resources
summary: Returns all item types
description: Use this operation to view the item types currently available with
this API. Types correspond to MIME types where possible.
operationId: getTypes
responses:
"200":
description: An array of item types.
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/NuixItemTypeResponse'
example:
- name: "application/vnd.ms-excel"
localisedName: Microsoft Excel Spreadsheet
preferredExtension: xls
kind: spreadsheet
count: null
- name: "application/vnd.ms-word"
localisedName: Microsoft Word Document
preferredExtension: doc
kind: document
count: null
/configurationProfiles:
get:
tags:
- Resources
summary: Returns all configuration profile names
description: Use this operation to view the configuration profiles on the system.
operationId: getConfigurationProfiles
responses:
"200":
description: The list of configuration profile names.
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- MyConfigurationProfile
deprecated: true
/digestLists:
get:
tags:
- Resources
summary: Returns all digest list names
description: Use this operation to view all digest list names. If there aren't
any digest lists available, the returned list will be empty.
operationId: availableDigests
responses:
"200":
description: The list of available digests.
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- NSRLFile
post:
tags:
- Resources
summary: Uploads a digest list to a user data directory
description: When no user data directory is provided, the first one found in
'nuix.engine.userDataDirs' will be used. If the file already exists in the user data directory
it will be replaced.
operationId: addDigestListsToNuix
parameters:
- name: userDataDir
in: query
description: User data directory
required: false
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
digestList:
type: array
items:
type: string
format: binary
responses:
"200":
description: File upload response.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/FileUploadResponse'
example:
fileUploads:
- success: true
filePath: "/opt/nuix/nuix-restful-service/engines/8.4.0.251/user-data/Digest Lists/NSRLFile.txt"
size: 875193726
"413":
description: The size of the request exceeds the maximum size.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: "FILE_TOO_LARGE"
developerMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the
configured maximum (10485760)"
userMessage: null
additionalInfo:
rootExceptionClass: "org.springframework.web.multipart.MultipartException"
rootExceptionMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size
(3260299650) exceeds the configured maximum (10485760)"
/imagingProfiles:
get:
tags:
- Resources
summary: Returns all imaging profile names
description: Use this operation to view the imaging profiles on the system.
operationId: getImagingProfiles
responses:
"200":
description: The list of all imaging profiles
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- Default
- MyImagingProfile
post:
tags:
- Resources
summary: Upload an imaging profile
description: Use this operation to add an imaging profile to the system. This
operation will fail if a profile with the same name already exists.
operationId: uploadImagingProfile
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
profile:
type: string
format: binary
responses:
"201":
description: Imaging Profile created and uploaded.
headers:
Location:
schema:
type: string
description: The URL of the uploaded imaging profile.
"409":
description: A imaging profile with the same filename already exists.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
userMessage: "A Imaging Profile named imagingAutomation.xml already exists."
additionalInfo: null
errorCode: "FOLDER_ALREADY_EXISTS"
developerMessage: "A user attempted to upload a file, while another file with this name already existed."
"413":
description: The size of the request exceeds the maximum size.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: "FILE_TOO_LARGE"
developerMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the
configured maximum (10485760)"
userMessage: null
additionalInfo:
rootExceptionClass: "org.springframework.web.multipart.MultipartException"
rootExceptionMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size
(3260299650) exceeds the configured maximum (10485760)"
"415":
description: Unsupported file type.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
additionalInfo:
supportedMediaTypes:
- "application/xml"
errorCode: "MEDIA_TYPE_NOT_SUPPORTED"
developerMessage: >
The server is refusing to service the request because the entity of the request is in a format not supported by the requested
resource for the requested method. See 'supportedMediaTypes' in 'additionalInfo' for a list of supported types
/imagingProfiles/{name}:
get:
tags:
- Resources
summary: Downloads an imaging profile by name
description: Use this operation to export an imaging profile from the system.
operationId: downloadImagingProfile
parameters:
- name: name
in: path
description: >
The name of the imaging profile as defined in the name field of the XML file. This should not be confused with the
filename and the path value should not contain the file extension.
required: true
schema:
type: string
responses:
"200":
description: The imaging profile download.
content:
"application/xml":
schema:
type: string
"404":
description: A imaging profile with the name provided could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'IMAGING_PROFILE' and identifier 'InvalidProfile' could not be found."
userMessage: "The resource of type 'IMAGING_PROFILE' and identifier 'InvalidProfile' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/productionProfiles:
get:
tags:
- Resources
summary: Returns all production profile names
description: Use this operation to view the production profiles on the system.
operationId: getProductionProfiles
responses:
"200":
description: The list of all production profiles
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- MyProductionProfile
post:
tags:
- Resources
summary: Upload a production profile
description: Use this operation to add a production profile to the system. This
operation will fail if a profile with the same name already exists.
operationId: uploadProductionProfile
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
profile:
type: string
format: binary
responses:
"201":
description: Production Profile created and uploaded.
headers:
Location:
schema:
type: string
description: The URL of the uploaded production profile.
"409":
description: A production profile with the same filename already exists.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
userMessage: "A Production Profile named productionAutomation.xml already exists."
additionalInfo: null
errorCode: "FOLDER_ALREADY_EXISTS"
developerMessage: "A user attempted to upload a file, while another file with this name already existed."
"413":
description: The size of the request exceeds the maximum size.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: "FILE_TOO_LARGE"
developerMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the
configured maximum (10485760)"
userMessage: null
additionalInfo:
rootExceptionClass: "org.springframework.web.multipart.MultipartException"
rootExceptionMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size
(3260299650) exceeds the configured maximum (10485760)"
"415":
description: Unsupported file type.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
additionalInfo:
supportedMediaTypes:
- "application/xml"
errorCode: "MEDIA_TYPE_NOT_SUPPORTED"
developerMessage: >
The server is refusing to service the request because the entity of the request is in a format not supported by the requested
resource for the requested method. See 'supportedMediaTypes' in 'additionalInfo' for a list of supported types
/productionProfiles/{name}:
get:
tags:
- Resources
summary: Downloads a production profile by name
description: Use this operation to export a production profile from the system.
operationId: downloadProductionProfile
parameters:
- name: name
in: path
description: >
The name of the production profile as defined in the name field of the XML file. This should not be confused with the
filename and the path value should not contain the file extension.
required: true
schema:
type: string
responses:
"200":
description: The production profile download.
content:
"application/xml":
schema:
type: string
"404":
description: A production profile with the name provided could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'PRODUCTION_PROFILE' and identifier 'InvalidProfile' could not be found."
userMessage: "The resource of type 'PRODUCTION_PROFILE' and identifier 'InvalidProfile' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/processingProfiles:
get:
tags:
- Resources
summary: Returns all processing profile names
description: Use this operation to view the processing profiles on the system.
operationId: getProcessingProfiles
responses:
"200":
description: The list of all Processing profiles
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- Default
- Default_Mobile
- MyProcessingProfile
post:
tags:
- Resources
summary: Upload a processing profile
description: Use this operation to add a processing profile to the system. This
operation will fail if a profile with the same name already exists.
operationId: uploadProcessingProfile
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
profile:
type: string
format: binary
responses:
"201":
description: Processing Profile created and uploaded.
headers:
Location:
schema:
type: string
description: The URL of the uploaded processing profile.
"409":
description: A processing profile with the same filename already exists.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
userMessage: "A Processing Profile named processingAutomation.xml already exists."
additionalInfo: null
errorCode: "FOLDER_ALREADY_EXISTS"
developerMessage: "A user attempted to upload a file, while another file with this name already existed."
"413":
description: The size of the request exceeds the maximum size.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: "FILE_TOO_LARGE"
developerMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the
configured maximum (10485760)"
userMessage: null
additionalInfo:
rootExceptionClass: "org.springframework.web.multipart.MultipartException"
rootExceptionMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size
(3260299650) exceeds the configured maximum (10485760)"
"415":
description: Unsupported file type.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
additionalInfo:
supportedMediaTypes:
- "application/xml"
errorCode: "MEDIA_TYPE_NOT_SUPPORTED"
developerMessage: >
The server is refusing to service the request because the entity of the request is in a format not supported by the requested
resource for the requested method. See 'supportedMediaTypes' in 'additionalInfo' for a list of supported types
/processingProfiles/{name}:
get:
tags:
- Resources
summary: Downloads a processing profile by name
description: Use this operation to export a processing profile from the system.
operationId: downloadProcessingProfile
parameters:
- name: name
in: path
description: >
The name of the processing profile as defined in the name field of the XML file. This should not be confused with the
filename and the path value should not contain the file extension.
required: true
schema:
type: string
responses:
"200":
description: The processing profile download.
content:
"application/xml":
schema:
type: string
"404":
description: A processing profile with the name provided could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'PROCESSING_PROFILE' and identifier 'InvalidProfile' could not be found."
userMessage: "The resource of type 'PROCESSING_PROFILE' and identifier 'InvalidProfile' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/ocrProfiles:
get:
tags:
- Resources
summary: Returns all OCR profile names
description: Use this operation to view the OCR profiles on the system.
operationId: getOcrProfiles
responses:
"200":
description: The list of all OCR profiles
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
example:
- Default
- MyOcrAutomation
post:
tags:
- Resources
summary: Upload an OCR profile
description: Use this operation to add an OCR profile to the system. This operation
will fail if a profile with the same name already exists.
operationId: uploadOcrProfile
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
profile:
type: string
format: binary
responses:
"201":
description: OCR Profile created and uploaded.
headers:
Location:
schema:
type: string
description: The URL of the uploaded OCR profile.
"409":
description: An OCR profile with the same filename already exists.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
userMessage: "An OCR Profile named ocrAutomation.xml already exists."
additionalInfo: null
errorCode: "FOLDER_ALREADY_EXISTS"
developerMessage: "A user attempted to upload a file, while another file with this name already existed."
"413":
description: The size of the request exceeds the maximum size.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: "FILE_TOO_LARGE"
developerMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the
configured maximum (10485760)"
userMessage: null
additionalInfo:
rootExceptionClass: "org.springframework.web.multipart.MultipartException"
rootExceptionMessage: >
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException:
org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size
(3260299650) exceeds the configured maximum (10485760)"
"415":
description: Unsupported file type.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
additionalInfo:
supportedMediaTypes:
- "application/xml"
errorCode: "MEDIA_TYPE_NOT_SUPPORTED"
developerMessage: >
The server is refusing to service the request because the entity of the request is in a format not supported by the requested
resource for the requested method. See 'supportedMediaTypes' in 'additionalInfo' for a list of supported types
/ocrProfiles/{name}:
get:
tags:
- Resources
summary: Downloads an OCR profile by name
description: Use this operation to export an OCR profile from the system.
operationId: downloadOcrProfile
parameters:
- name: name
in: path
description: >
The name of the OCR profile as defined in the name field of the XML file. This should not be confused with the
filename and the path value should not contain the file extension.
required: true
schema:
type: string
responses:
"200":
description: The OCR profile download.
content:
"application/xml":
schema:
type: string
"404":
description: An OCR profile with the name provided could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'OCR_PROFILE' and identifier 'InvalidProfile' could not be found."
userMessage: "The resource of type 'OCR_PROFILE' and identifier 'InvalidProfile' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/ocrProfiles/{name}/details:
get:
tags:
- Resources
summary: Returns the OCR profile template details.
description: Use this operation to get the OCR profile template details.
operationId: getOcrProfileTemplateDetails
parameters:
- name: name
in: path
description: >
The name of the OCR profile as defined in the name field of the XML file. This should not be confused with the
filename and the path value should not contain the file extension.
required: true
schema:
type: string
responses:
"200":
description: The OCR profile template details.
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/OcrTemplateDetails'
example:
id: "1eec3145-f3a6-4cce-8e32-c07cb2141438"
name: Default
description: null
appendText: true
updateText: true
updatePdf: true
pageRotation: AUTO
textRotations:
- AUTO
multiProcessingMode: SEQUENTIAL
languages:
- English
deskew: true
autoPageRotationEnabled: true
customPageRotationEnabled: false
noPageRotationEnabled: false
clockwisePageRotationEnabled: false
counterClockwisePageRotationEnabled: false
oneEightyPageRotationEnabled: false
ocrProcessingProfile: DOCUMENT_ARCHIVING_ACCURACY
timeout: 90
printedImageRotation: AUTO
"404":
description: An OCR profile with the name provided could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'OCR_PROFILE' and identifier 'InvalidProfile' could not be found."
userMessage: "The resource of type 'OCR_PROFILE' and identifier 'InvalidProfile' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/cases/{caseId}/items/ocr:
put:
tags:
- Processing
summary: Performs OCR on query items
description: |
Use this operation to perform bulk optical character recognition
(OCR) on items returned from a query. This is done using OCR and imaging options.
The Nuix OCR add-on must be installed. For example, you can OCR an image with
a query to extract item text.
operationId: bulkOcrItemsAsFunctionV2
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/OcrRequestV2'
examples:
Simple OCR Request:
value:
query: 'kind: spreadsheet'
ocrOptions:
quality: document_archiving_speed
ocrImagingOptions:
excelExportingEngine: MS_OFFICE
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/OcrRequest'
examples:
Simple OCR Request:
value:
query: 'kind: document'
ocrOptions:
quality: document_archiving_speed
ocrImagingOptions:
wordExportingEngine: MS_OFFICE
responses:
"200":
description: default response
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
/resources/ocr:
get:
tags:
- System
summary: Detects whether OCR functionality is available
description: Use this operation to determine whether optical character recognition
(OCR) functionality is available.
operationId: checkOcrCapability
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/GenericResponse'
examples:
OCR Enabled:
value:
success: true
OCR Disabled:
value:
success: false
/resources/ffmpeg:
get:
tags:
- System
summary: Detects whether FFmpeg/FFprobe functionality is available
description: Use this operation to determine whether FFmpeg and FFprobe functionality is available.
operationId: checkFfmpegCapability
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/GenericResponse'
examples:
FFmpeg Enabled:
value:
success: true
FFmpeg Disabled:
value:
success: false
/resources/lotusnotes:
get:
tags:
- System
summary: Detects whether Lotus Notes functionality is available
description: Use this operation to determine whether Lotus Notes functionality is available.
operationId: checkLotusNotesCapability
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/GenericResponse'
examples:
Lotus Notes Enabled:
value:
success: true
Lotus Notes Disabled:
value:
success: false
/resources/thirdparty:
get:
tags:
- System
summary: Provides a summary of third party dependencies and their availability.
description: Use this operation to determine whether third party dependencies have been installed and what
functionality is available.
operationId: getThirdPartyDepedencies
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/ThirdPartyDependencyResponse'
examples:
Third Party Dependencies:
value:
- description: Lotus Notes
version: null
message: Not found
comment: " Lotus notes was not found. Lotus Notes files will not be able to be processed.
Version 9.0 is required.
Due to licensing restrictions, this software cannot be redistributed; you will need to install it separately.
"
attentionRequired: true
- description: "FFmpeg / FFprobe"
version: "0.1"
message: Found
comment: " FFmpeg and FFprobe were found. Multimedia metadata will be extracted and video image data will be processed.
"
attentionRequired: false
- description: Nuix OCR
version: 12.4.7
message: Found Version 12.4.7
comment: " The Nuix OCR add-on 12.4.7 was found on your system.
It will be possible to perform OCR.
"
attentionRequired: false
application/vnd.nuix.v2+json:
schema:
type: array
items:
$ref: '#/components/schemas/ClusterThirdPartyDependency'
examples:
Third Party Dependencies Across Cluster:
value:
- hostAddress: "http://consumer1:8080"
thirdPartyDependency:
- description: Lotus Notes
version: null
message: Not found
comment: " Lotus notes was not found. Lotus Notes files will not be able to be processed.
Version 9.0 is required.
Due to licensing restrictions, this software cannot be redistributed; you will need to install it separately.
"
attentionRequired: true
- description: "FFmpeg / FFprobe"
version: "0.1"
message: Found
comment: " FFmpeg and FFprobe were found. Multimedia metadata will be extracted and video image data will be processed.
"
attentionRequired: false
- description: Nuix OCR
version: 12.4.7
message: Found Version 12.4.7
comment: " The Nuix OCR add-on 12.4.7 was found on your system.
It will be possible to perform OCR.
"
attentionRequired: false
/cases/{caseId}/productionSets:
get:
tags:
- Export
summary: Returns all production sets for a case
description: Use this operation to view all the production sets for a case. You can use this to see a list of which production sets are available for export.
operationId: getProductionSetsForCase
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: summary
in: query
required: false
description: If set to true, will only retrieve name and GUID.
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/ProductionSetResponse'
examples:
Empty Production Set:
value:
- name: MyProductionSet
description: This is a production set
guid: 1ecbbbc9-e093-497b-a92f-e9c58f00fb2f
frozen: false
nextDocumentNumber: null
prefix: null
nextDocumentId: null
firstDocumentNumber: null
itemCount: 0
Production Set With Items:
value:
- name: MyProductionSet
description: This is a production set
guid: 1ecbbbc9-e093-497b-a92f-e9c58f00fb2f
frozen: false
nextDocumentNumber: nuix000000002
prefix: nuix
nextDocumentId: 2
firstDocumentNumber: nuix000000001
itemCount: 1
Production Set Summary Only:
value:
- name: MyProductionSet
description: null
guid: 1ecbbbc9-e093-497b-a92f-e9c58f00fb2f
frozen: null
nextDocumentNumber: null
prefix: null
nextDocumentId: null
firstDocumentNumber: null
itemCount: 0
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
post:
tags:
- Export
summary: Creates a production set
description: Use this operation to create a production set in a case. Production sets allow you to manage a set of grouped items for export.
operationId: createProductionSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
requestBody:
required: true
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/BulkProductionSetWithProfilesRequest'
example:
name: MyProductionSet
description: This is a production set
query: "kind:document"
productionProfileName: Default
imagingProfileName: Default
responses:
"200":
description: default response
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
/v1/cases/{caseId}/productionSets:
post:
tags:
- Export
deprecated: true
summary: Creates a production set
description: Use this operation to create a production set in a case. Production sets allow you to manage a set of grouped items for export.
operationId: createProductionSetDeprecated
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ProductionSetRequest'
examples:
Simple Production Set:
value:
name: MyProductionSet
description: This is a production set
query: "kind:document"
includeFamilies: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
/cases/{caseId}/productionSets/{productionSetId}/item/{itemGuid}/printPreview:
get:
tags:
- Export
summary: Returns a print preview for an item in the production set
description: Use this operation to return a print preview of the item. If a print preview isn't present on the item, it will be generated.
operationId: getPrintPreview
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: productionSetId
in: path
description: Production set GUID
required: true
schema:
type: string
- name: itemGuid
in: path
description: Item GUID
required: true
schema:
type: string
- name: pageNumber
in: query
description: The page number to be printed
required: true
schema:
type: integer
format: int32
- name: generateNew
in: query
description: Force regeneration of print preview
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
format: byte
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
Production Set Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
userMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
Item Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'ITEM' and identifier '96c3defc-ee21-4972-9561-d69622c25389' could not be found."
userMessage: "The resource of type 'ITEM' and identifier '96c3defc-ee21-4972-9561-d69622c25389' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/cases/{caseId}/productionSets/{productionSetId}/items:
get:
tags:
- Export
summary: Returns the items in this production set
description: This is a shortcut for using the search endpoint with a production-set-guid:[guid] query
operationId: getProductionSetItems
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: productionSetId
in: path
description: Production set GUID
required: true
schema:
type: string
- name: startIndex
in: query
description: Start index, defaults to 0
required: false
schema:
type: integer
format: int32
- name: numberOfRecordsRequested
in: query
description: Number of records to return, defaults to 100
required: false
schema:
type: integer
format: int32
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/SearchNativeResult'
example:
request:
caseId: 219f69f5eee14cf6b8c8c15d7cc2dd1e
query: "production-set-guid:1ecbbbc9-e093-497b-a92f-e9c58f00fb2f"
sortField: null
sortOrder: null
startIndex: 0
numberOfRecordsRequested: 1
deduplicate: null
metadataProfile: null
fieldList: []
customMetadataList: []
propertyList: []
itemParameterizedFields: []
showAvailableThumbnails: false
useCache: false
forceCacheDelete: false
searchRetry: 0
relationType: null
entities": []
s: 0
p: 1
customMetadataField: []
property: []
field: []
startedOn: 1589459144928
completedOn: 1589459145042
elapsedTimeForSearch: 90
elapsedTimeForSort: 0
elapsedTimeForMarshal: 24
elapsedTimeForDeduplicate: 0
elapsedTotal: 114
metadataItems: []
localizedMetadataItems: []
metadataItemDetails: []
resultList:
- customMetadata: {}
entities: {}
guid: fd772326-87f2-40d2-8d6a-b6009c79cc49
properties: {}
count: 1
deduplicatedCount: 1
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
post:
tags:
- Export
summary: Adds items to a production set
description: Use this operation to add items to an existing production set in a case. Production sets allow you to manage a set of grouped items for export.
operationId: addItemsToProductionSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: productionSetId
in: path
description: Production set GUID
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ProductionSetRequest'
example:
query: "kind:document"
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/cases/{caseId}/productionSets/{productionSetId}/printPreview:
post:
tags:
- Export
summary: Generates print previews for items in the production set
description: Use this operation to generate print previews for all items in
the production set.
operationId: generatePrintPreviews
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: productionSetId
in: path
description: Production set GUID
required: true
schema:
type: string
- name: allItems
in: query
description: Generate all print previews, or only generate previews that don't already exist
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ProductionSetResponse'
example:
name: MyProductionSet
description: This is a production set
guid: 1ecbbbc9-e093-497b-a92f-e9c58f00fb2f
frozen: false
nextDocumentNumber: nuix000000002
prefix: nuix
nextDocumentId: 2,
firstDocumentNumber: nuix000000001
itemCount: 1
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
Production Set Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
userMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/cases/{caseId}/productionSets/{productionSetId}:
get:
tags:
- Export
summary: Returns details for a specific production set
description: Use this operation to view information about a production set.
Details include set name, item count, description, and document numbering.
You can use this information to determine if this production set is ready
for export.
operationId: getProductionSet
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: productionSetId
in: path
description: Production set GUID
required: true
schema:
type: string
- name: summary
in: query
description: If true returns a production set summary. The summary includes guid and name of the production set only.
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ProductionSetResponse'
examples:
Empty Production Set:
value:
name: MyProductionSet
description: This is a production set
guid: 1ecbbbc9-e093-497b-a92f-e9c58f00fb2f
frozen: false
nextDocumentNumber: null
prefix: null
nextDocumentId: null
firstDocumentNumber: null
itemCount: 0
Production Set With Items:
value:
name: MyProductionSet
description: This is a production set
guid: 1ecbbbc9-e093-497b-a92f-e9c58f00fb2f
frozen: false
nextDocumentNumber: nuix000000002
prefix: nuix
nextDocumentId: 2
firstDocumentNumber: nuix000000001
itemCount: 1
Production Set Summary Only:
value:
name: MyProductionSet
description: null
guid: 1ecbbbc9-e093-497b-a92f-e9c58f00fb2f
frozen: null
nextDocumentNumber: null
prefix: null
nextDocumentId: null
firstDocumentNumber: null
itemCount: 0
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
Production Set Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
userMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
delete:
tags:
- Export
summary: Deletes a production set from a case
description: Use this operation to delete a specific production set from a case.
operationId: deleteProductionSet
deprecated: true
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: productionSetId
in: path
description: Production set GUID
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ProductionSetResponse'
example:
name: MyProductionSet
description: This is a production set
guid: 1ecbbbc9-e093-497b-a92f-e9c58f00fb2f
frozen: false
nextDocumentNumber: null
prefix: null
nextDocumentId: null
firstDocumentNumber: null
itemCount: 0
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
Production Set Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
userMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/v2/cases/{caseId}/productionSets/{productionSetId}:
delete:
tags:
- Export
summary: Deletes a production set from a case
description: Use this operation to delete a specific production set from a case.
operationId: deleteProductionSetV2
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: productionSetId
in: path
description: Production set GUID
required: true
schema:
type: string
responses:
"204":
description: default response
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
Production Set Does Not Exist:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
userMessage: "The resource of type 'PRODUCTION_SET' and identifier 'InvalidProductionSetGuid' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/v2/cases/{caseId}:
delete:
tags:
- Inventory
summary: Deletes a case asynchronously
description: Use this operation to delete a case asynchronously. This operation returns immediately with an async function key that can be used to monitor the deletion progress.
operationId: deleteCaseAsync
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: deleteAllDescendants
in: query
description: Delete child cases of a compound case
required: false
schema:
type: boolean
default: false
responses:
"200":
description: Async function response with key and location for monitoring progress
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
example:
functionKey: "12451c5f-eaf9-4089-9a90-3df32944e5fc"
location: "http://localhost:8080/svc/v1/asyncFunctions/12451c5f-eaf9-4089-9a90-3df32944e5fc"
"404":
description: Case does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
examples:
Case Not Found:
value:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
userMessage: "The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/cases/{caseId}/search:
get:
tags:
- Search
summary: Performs a search
description: |
Use this operation to search a case. For large query strings, use the POST method.
Use the following supported fields in the fieldList:
* `all` - Returns all fields for the item.
* `auditedSize` - Returns the item''s audited size.
* `children` - Returns a list of the item''s children.
* `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.
* `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.
* `comment` - Returns item comments.
* `communication` - If the item is a communication, this returns item communication information.
* `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.
* `custodian` - Returns the custodian assigned to an item.
* `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.
* `date` - Returns the item date.
* `descendants` - Gets the list of items which are descendants of this item.
* `digests` - Returns a map of the computed digests for an item.
* `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.
* `duplicates` - Returns duplicates of this item.
* `evidenceMetadata` - Returns custom evidence metadata for the item.
* `exclusion` - Returns the reason for an item''s exclusion.
* `family` - Returns a list of items in the same family.
* `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.
* `fileType` - Returns the name of the file type.
* `guid` - Returns the item''s globally unique identifier (GUID).
* `history` - Returns the item''s history in ascending order by date.
* `id` - Returns the item''s ID.
* `isAudited` - Tests whether the item is considered audited and returns true or false.
* `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it. This returns
true if the item had binary data at processing time that was not stored. This
differs from isStored() as this method returns true if the item had binary
data at processing time that was not stored.
* `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned
if stored binary exists. In this case, the source data isn''t required for
binary export.
* `isChatMessage` - Tests whether the item is a chat message.
* `isChatConversation` - Tests whether the item is a chat conversation.
* `isDeleted` - Tests whether the item was marked as deleted and returns true or false.
* `isEmailThreadMember` - Tests whether the item is part of an email thread.
* `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.
* `isExcluded` - Tests whether the item was marked as excluded.
* `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).
* `isIncluded` - Tests whether the item is included and returns true or false.
* `isLooseFile` - Tests whether the item is a loose file and returns true or false.
* `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.
* `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field
is useful when you only need to know if a printed image exists for this item.
This is faster and uses fewer resources than requesting the printedImageInfo
field.
* `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.
* `isTextStored` - Tests hether the item has text stored against it in the database. In the event
where you only want to know if the item had text but didn''t need the text
this field is considerably faster and more conservative of resources than
isTextAvailable.
* `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.
* `isTopLevel` - Tests whether this is a top-level item and returns true or false.
* `itemCategory` - Returns the item category.
* `kind` - Returns the item kind.
* `language` - Returns the language identified by the item.
* `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])
if the name is blank.
* `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.
* `name` - Returns the item name.
* `originalExtension` - Returns the original extension listed on the source file.
* `parent` - Returns the parent of this item.
* `path` - Returns an item list which represents the path from the root evidence container to the item.
* `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.
* `pathNames` - Returns a list of item names on the path from the root evidence container to the item.
* `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.
* `printedImageInfo` - Returns information about the printed image.
* `properties` - Returns item properties.
* `root` - Returns the root item. If this item is the root, the item itself is returned.
* `rootUri` - Returns the item''s root URI as a string.
* `tags` - Returns the item tags.
* `text` - Returns the text of the item as a string.
* `textHtml` - Returns the text of the item escaped for HTML.
* `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.
* `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.
* `threadItems` - Returns items that are in the same discussion thread as this item.
* `topLevelItem` - Returns the associated top-level item.
* `topLevelItemDate` - Returns the associated top-level item date.
* `type` - Returns the type name.
* `typeLocalisedName` - Returns the type name, localised appropriately for display to users.
* `uri` - Returns the item''s uniform resource identifier (URI) as a string.
operationId: searchNativeResult
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
- name: query
in: query
description: Identifies what items should be returned. If a query is not supplied it defaults to an empty string, which returns all items.
required: false
schema:
type: string
- name: s
in: query
description: The index of the first record that should be returned. Defaults
to 0. Maintained for backward compatibility.
required: false
schema:
type: integer
format: int32
- name: p
in: query
description: The number of records that should be returned. Defaults to 100
records. Maintained for backward compatibility.
required: false
schema:
type: integer
format: int32
- name: startIndex
in: query
description: The index of the first record that should be returned. Defaults
to 0.
required: false
schema:
type: integer
format: int32
- name: numberOfRecordsRequested
in: query
description: The number of records that should be returned per page. Defaults to 100
records.
required: false
schema:
type: integer
format: int32
- name: limit
in: query
description: The maximum number of results to return.
required: false
schema:
type: integer
format: int32
- name: deduplication
in: query
description: Deduplicate content based on the Value field selection. The default is none, no deduplication.
required: false
schema:
type: string
enum:
- md5
- per custodian
- none
- name: maintainDeduplicatedSearchOrder
in: query
description: Specifies whether the original search result order based on the query should be maintained for
deduplicated results. Default is true. Setting this field to false may improve deduplication performance
especially for Elasticsearch cases. This field is ignored if a sort field has been specified.
required: false
schema:
type: boolean
default: true
- name: metadataProfile
in: query
description: Defines the metadata profile to be appied to the results. Needed
to get custom metadata. Defaults to no metadata profile.
required: false
schema:
type: string
- name: fieldList
in: query
description: List of fields to be returned for each item in the results.
required: false
schema:
type: array
items:
type: string
- name: customMetadataField
in: query
description: List of custom metadata to be returned for each item in the results. Maintained for backward compatibility.
required: false
schema:
type: array
items:
type: string
- name: propertyList
in: query
description: List of properties to be returned for each item in the results.
required: false
schema:
type: array
items:
type: string
- name: itemParameterizedFields
in: query
description: Specifies parameterized fields in a key/value pair separated by a colon.
* `entities` - corresponds to item.getEntities. (e.g., "entities:company")
* `serializedItem` - returns a serialized copy of the item. (e.g., "seralizedItem:topLevelItem")
* `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., "textTruncated:10000")
* `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., "thumbnail:200x200")
* `nearDupeThreshold` - (e.g., "nearDupeThreshold:0.9")
* `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., "emailThreadCluster:cluster-1")
required: false
schema:
type: array
items:
type: string
- name: entities
in: query
description: List of entity names to include in response (e.g. company,email)
required: false
schema:
type: array
items:
type: string
- name: showAvailableThumbnails
in: query
description: Show thumbnails that have been generated
required: false
schema:
type: boolean
default: false
- name: useCache
in: query
description: Specifies whether the results should be loaded from and stored
in cache.
required: false
schema:
type: boolean
default: false
- name: forceCacheDelete
in: query
description: Specifies whether the cached results should be deleted before
performing the search.
required: false
schema:
type: boolean
default: false
- name: sortField
in: query
description: |
Any field in the metadata profile which you want to sort by.
Use the following supported fields in the sortFields:
position,kind,duplicates
required: false
schema:
type: string
- name: sortOrder
in: query
description: Sets the sort order for the results.
required: false
schema:
type: string
- name: relationType
in: query
description: The relation to apply to the found items.
required: false
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/SearchNativeResult'
post:
tags:
- Search
summary: Performs a large search
description: Use this operation to perform a large search on a case. This operation
doesn't have a maximum query string length.
operationId: searchNativeResultPost
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/SearchNativeRequest'
responses:
"200":
description: default response
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/SearchNativeResult'
/cases/{caseId}/asyncFunctions/search:
post:
tags:
- Search
summary: Performs an asynchronous search
description: Use this operation to perform an asynchronous search.
operationId: asyncSearchNative
parameters:
- name: caseId
in: path
description: caseId
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/SearchNativeRequest'
examples:
Asynchronous Search:
value:
query: ""
fieldList:
- name
- guid
- date
- fileSize
- isBinaryAvailable
- kind
- fileType
- pathNames
useCache: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
examples:
Standard Asynchronous Function Response:
value:
functionKey: c2b5a20b-3cd1-4eb3-b600-6fa909ba0949
location: "http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949"
Asynchronous Search Result:
value:
done: true
cancelled: false
result:
request:
caseId: 058d9a61faf04e4ca320cb64a166715b
query: ""
sortField: null
sortOrder: null
startIndex: 0
numberOfRecordsRequested: 100
deduplicate: null
metadataProfile: null
fieldList:
- name
- guid
- date
- digest
- fileSize
- isBinaryAvailable
- kind
- fileType
- pathNames
customMetadataList: [ ]
propertyList: [ ]
itemParameterizedFields: [ ]
showAvailableThumbnails: false
useCache: false
forceCacheDelete: false
searchRetry: 0
relationType: null
entities: [ ]
s: 0
p: 100
customMetadataField: [ ]
property: [ ]
field:
- name
- guid
- date
- digest
- fileSize
- isBinaryAvailable
- kind
- fileType
- pathNames
startedOn: 1607707917841
completedOn: 1607707920476
elapsedTimeForSearch: 2413
elapsedTimeForSort: 0
elapsedTimeForMarshal: 192
elapsedTimeForDeduplicate: 0
elapsedTotal: 2635
metadataItems: [ ]
localizedMetadataItems: [ ]
metadataItemDetails: [ ]
resultList:
- File Type: application/vnd.nuix-evidence
customMetadata: { }
entities: { }
fileSize: null
fileType: application/vnd.nuix-evidence
guid: c9fbe0c7-bba8-48f2-ae6e-3dd7b68c5885
isBinaryAvailable: false
kind: container
name: 63ec0e62-2687-4e00-8b47-6110039e8bd4
pathNames:
- 63ec0e62-2687-4e00-8b47-6110039e8bd4
properties: { }
/system/properties/{propertyName}:
get:
tags:
- System
summary: Gets a Nuix system property
description: Use this operation to get the value of a Nuix system property.
This operation is limited to Nuix system properties only and the property must
start with the string "nuix."
operationId: getSystemProperty
parameters:
- name: propertyName
in: path
description: The name of the system property.
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/SystemPropertyResponse'
example:
name: nuix.registry.servers
value: server.domain.com
previousValue: null
"400":
description: Invalid Property
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: "INVALID_REQUEST_FORMAT"
developerMessage: "badproperty is an unrecognized Nuix system property."
userMessage: null
additionalInfo: null
put:
tags:
- System
summary: Sets a Nuix system property
description: Use this operation to set a Nuix system property. This operation
is limited to Nuix system properties only and the value is not persisted between
application restarts. You may want to do this if there is a specific Nuix system property
required for an ingestion, export, or OCR operation. This is NOT threadsafe and
could affect other users.
operationId: setSystemProperty
parameters:
- name: propertyName
in: path
description: The name of the system property.
required: true
schema:
type: string
requestBody:
required: true
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/SystemPropertyRequest'
examples:
Update Property Example:
value:
value: new_value
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/SystemPropertyResponse'
example:
name: nuix.registry.servers
value: server.domain.com
previousValue: oldserver.domain.com
"400":
description: Invalid Property
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: "INVALID_REQUEST_FORMAT"
developerMessage: "badproperty is an unrecognized Nuix system property."
userMessage: null
additionalInfo: null
delete:
tags:
- System
summary: Clears a Nuix system property
description: Use this operation to clear a Nuix system property. This operation
is limited to Nuix system properties only and the value is not persisted between
application restarts. You may want to do this if you previously set a specific
Nuix system property required for an ingestion, export, or OCR operation. This is
NOT threadsafe and could affect other users.
operationId: clearSystemProperty
parameters:
- name: propertyName
in: path
description: The name of the system property.
required: true
schema:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/SystemPropertyResponse'
example:
name: nuix.registry.servers
value: null
previousValue: oldserver.domain.com
"400":
description: Invalid Property
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: "INVALID_REQUEST_FORMAT"
developerMessage: "badproperty is an unrecognized Nuix system property."
userMessage: null
additionalInfo: null
/system/diagnostics:
get:
tags:
- System
summary: Generates a system diagnostics ZIP file
description: Use this operation to create a ZIP file with system diagnostics
information. The diagnostics include log files, product versions, environment
variables, system properties, licence properties, drive information, process
information, JVM arguments and settings, and installed and not installed dependencies.
Please note that when operating in a cluster this endpoint will return system diagnostics
from ALL nodes in the cluster.
operationId: generateSystemsDiagnostics
parameters:
- name: includeResourceDetails
in: query
description: Creates an additional diagnostics file that includes the engine
version, search cache, system resources, function queue, and active user
count.
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/octet-stream:
schema:
type: string
format: binary
post:
tags:
- System
summary: Generates a system diagnostics ZIP file asyncronously.
description: Use this operation to create a ZIP file with system diagnostics
information asyncronously. The diagnostics include log files, product versions, environment
variables, system properties, licence properties, drive information, process
information, JVM arguments and settings, and installed and not installed dependencies. The endpoint
return an async function id which should be polled until complete. The result can be used to
retrieve the download from the /downloads/{downloadId} endpoint. Please note that when
operating in a cluster this endpoint will return diagnostics from ALL nodes in the cluster.
operationId: generateSystemDiagnosticsDistributed_1
parameters:
- name: includeResourceDetails
in: query
description: Creates an additional diagnostics file that includes the engine
version, search cache, system resources, function queue, and active user
count.
required: false
schema:
type: boolean
default: false
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
application/json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
/downloads/{id}:
get:
tags:
- System
summary: Downloads a file given an id.
description: Use this endpoint to download a file from the server given a download id.
operationId: downloadFile_1
parameters:
- name: id
in: path
description: The id of the download.
required: true
schema:
type: string
responses:
"200":
description: default response
content:
'application/json,application/octet-stream':
schema:
type: string
format: binary
"404":
description: Download does not exist
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
example:
serverId: "nuix-restful-server-1"
errorCode: RESOURCE_NOT_FOUND
developerMessage: "The resource of type 'DOWNLOAD' and identifier 'c2284dc7-1ec4-47bf-b5c0-af91ae2e8087' could not be found."
userMessage: "The resource of type 'DOWNLOAD' and identifier 'c2284dc7-1ec4-47bf-b5c0-af91ae2e8087' could not be found."
additionalInfo:
rootExceptionClass: com.nuix.us.exception.i18n.I18nNotFoundException
rootExceptionMessage: null
/system/health:
get:
tags:
- System
summary: Checks whether the REST server is running
description: Use this operation to ensure the RESTful services are working.
This is a heartbeat test that checks whether the REST server is up and running.
operationId: heartbeat
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/GenericResponse'
examples:
Service Running:
value:
success: true
/cases/{caseId}/userScripts:
put:
tags:
- Scripting
summary: Executes a user script on a case
description: |
Use this operation to execute a script that is in the user scripts
directory. This is useful for extending the Nuix REST API to fit your needs.
Each script is injected with several common local variables, all of which are available both
with and without a leading dollar sign (**$**):
* **current_case** (also as **currentCase**): This is the Java nuix.Case object. It is only
available in the case-specific endpoint.x
* **utilities**: This is the Java nuix.Utilities object for the current environment.
* **request**: This is the Java HttpServletRequest object. It is only available in version 1 of the endpoint.
This variable is not available in version 2 of the endpoint. Use custom_arguments instead.
* **response**: This provides methods for customising the object that is returned from the server.
These methods are:
* **setStatus(int httpStatusCode)**: This sets the HTTP status code.
* **addHeader(String headerName, String headerValue)**: This adds a header to the actual HTTP response that comes back from the server.
* **setBody(Object body)**: This sets the payload of the response.
* **progress** : This provides methods for updating the progress of the script when run in an asynchronous
manner. These methods are:
* **setStatus(String status)**: This sets an arbitrary status value. This will be reflected
in the ''status'' variable in the AsyncFunctionStatus response.
* **setEstimatedFinalValue(long value))**: This sets an estimate for the final progress value. This will
be reflected in the ''total'' variable in the AsyncFunctionStatus response,
and will be used as the denominator when calculating percent complete.
* **setCurrentValue(long value)**: This sets the current progress value. This will be reflected in
the ''progress'' variable in the AsyncFunctionStatus response, and will be
used as the numerator when calculating percent complete.
* **custom_arguments** (also as **customArguments**): This is the map of provided custom arguments.
For scripts run asynchronously, the following JSON variables will be available
in the *result* section when retrieving function status:
* **status**: This is the HTTP status code as set by **response.setStatus(httpStatusCode)**
(see above), or 200 if not explicitly set.
* **headers**: These are HTTP headers as set by **response.addHeader(headerName, headerValue)**(see above).
* **body**: This is the payload as set by **response.setBody(body)**
(see above).
* **output**: This is the result of any print statement (or equivalent) executed by the script. Newlines will most likely be encoded.
* **result**: This is the return value from the script, if any.
For scripts run synchronously, the HTTP response code, headers, and body will reflect the use of the **response** variable. Version 1 of the
endpoint is not able to run in a cluster.
*NOTE: Version 2 endpoints are always asynchronous and can run in a cluster. *
operationId: executeUserScriptFunctionForCase
parameters:
- name: caseId
in: path
description: Case identification token
required: true
schema:
type: string
requestBody:
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/UserScriptRequestV2'
examples:
Ruby:
value:
description: Ruby User Script
name: Ruby User Script
script: "$response.setStatus(200)\n$response.setBody(\"result\":\"hello world\")"
language: RUBY
Python:
value:
description: Python User Script
name: "Python User Script"
script: "response.setStatus(200)\nresponse.setBody({\"result\":\"hello world\"})"
language: PYTHON
Javascript:
value:
description: Javascript User Script
name: "Javascript User Script"
script: "response.setStatus(200)\nresponse.setBody({\"result\":\"hello world\"})"
language: JAVASCRIPT
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/UserScriptRequest'
examples:
Ruby:
value:
async: false
description: Ruby User Script
name: Ruby User Script
script: "$response.setStatus(200)\n$response.setBody(\"result\":\"hello world\")"
language: RUBY
Python:
value:
async: false
description: Python User Script
name: "Python User Script"
script: "response.setStatus(200)\nresponse.setBody({\"result\":\"hello world\"})"
language: PYTHON
Javascript:
value:
async: false
description: Javascript User Script
name: "Javascript User Script"
script: "response.setStatus(200)\nresponse.setBody({\"result\":\"hello world\"})"
language: JAVASCRIPT
responses:
"200":
description: default response
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
example:
functionKey: c2b5a20b-3cd1-4eb3-b600-6fa909ba0949
location: "http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949"
application/vnd.nuix.v1+json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/AsyncFunctionResponse'
examples:
Synchronous Response:
value:
result: Hello World
Asynchronous Response:
value:
functionKey: c2b5a20b-3cd1-4eb3-b600-6fa909ba0949
location: "http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949"
/userScripts:
get:
tags:
- Scripting
summary: Retrieves the list of existing user scripts
description: Use this operation to view the list of existing user scripts.
operationId: fetchUserScripts
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
type: string
put:
tags:
- Scripting
summary: Executes a user script
description: |
Use this operation to execute a script that is in the user scripts
directory. This is useful for extending the Nuix REST API to fit your needs.
Version 1 of this endpoint has been *deprecated*.
Each script is injected with several common local variables, all of which are available both
with and without a leading dollar sign (**$**):
* **current_case** (also as **currentCase**): This is the Java nuix.Case object. It is only
available in the case-specific endpoint.
* **utilities**: This is the Java nuix.Utilities object for the current environment.
* **request**: This is the Java HttpServletRequest object. It is only available in version 1 of the endpoint.
This variable is not available in version 2 of the endpoint. Use custom_arguments instead.
* **response**: This provides methods for customising the object that is returned from the server.
These methods are:
* **setStatus(inthttpStatusCode)**: This sets the HTTP status code.
* **addHeader(String headerName, String headerValue)**: This adds a header to the actual HTTP response that comes back from the server.
* **setBody(Object body)**: This sets the payload of the response.
* **progress** : This provides methods for updating the progress of the script when run in an asynchronous
manner. These methods are:
* **setStatus(String status)**: This sets an arbitrary status value. This will be reflected
in the ''status'' variable in the AsyncFunctionStatus response.
* **setEstimatedFinalValue(long value))**: This sets an estimate for the final progress value. This will
be reflected in the ''total'' variable in the AsyncFunctionStatus response,
and will be used as the denominator when calculating percent complete.
* **setCurrentValue(long value)**: This sets the current progress value. This will be reflected in
the ''progress'' variable in the AsyncFunctionStatus response, and will be
used as the numerator when calculating percent complete.
* **custom_arguments** (also as **customArguments**): This is the map of provided custom arguments.
For scripts run asynchronously, the following JSON variables will be available
in the *result* section when retrieving function status:
* **status**: This is the HTTP status code as set by **response.setStatus(httpStatusCode)**
(see above), or 200 if not explicitly set.
* **headers**: These are HTTP headers as set by **response.addHeader(headerName, headerValue)**(see above).
* **body**: This is the payload as set by **response.setBody(body)**
(see above).
* **output**: This is the result of any print statement (or equivalent) executed by the script. Newlines will most likely be encoded.
* **result**: This is the return value from the script, if any.
For scripts run synchronously, the HTTP response code, headers, and body will reflect the use of the **response** variable. Version 1 of the
endpoint is not able to run in a cluster.
*NOTE: Version 2 endpoints are always asynchronous and can run in a cluster.*
operationId: executeUserScriptFunction
requestBody:
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/UserScriptRequestV2'
examples:
Ruby:
value:
description: Ruby User Script
name: Ruby User Script
script: "$response.setStatus(200)\n$response.setBody(\"result\":\"hello world\")"
language: RUBY
Python:
value:
description: Python User Script
name: "Python User Script"
script: "response.setStatus(200)\nresponse.setBody({\"result\":\"hello world\"})"
language: PYTHON
Javascript:
value:
description: Javascript User Script
name: "Javascript User Script"
script: "response.setStatus(200)\nresponse.setBody({\"result\":\"hello world\"})"
language: JAVASCRIPT
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/UserScriptRequest'
examples:
Ruby:
value:
async: false
description: Ruby User Script
name: Ruby User Script
script: "$response.setStatus(200)\n$response.setBody(\"result\":\"hello world\")"
language: RUBY
Python:
value:
async: false
description: Python User Script
name: "Python User Script"
script: "response.setStatus(200)\nresponse.setBody({\"result\":\"hello world\"})"
language: PYTHON
Javascript:
value:
async: false
description: Javascript User Script
name: "Javascript User Script"
script: "response.setStatus(200)\nresponse.setBody({\"result\":\"hello world\"})"
language: JAVASCRIPT
responses:
"200":
description: default response
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/AsyncFunctionResponse'
example:
functionKey: c2b5a20b-3cd1-4eb3-b600-6fa909ba0949
location: "http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949"
application/vnd.nuix.v1+json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/AsyncFunctionResponse'
examples:
Synchronous Response:
value:
result: Hello World
Asynchronous Response:
value:
functionKey: c2b5a20b-3cd1-4eb3-b600-6fa909ba0949
location: "http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949"
/about:
get:
tags:
- System
summary: Retrieves information about Nuix RESTful services
description: >
Use this operation to view version information about your Nuix RESTful services configuration. Authentication is optional for this endpoint. If the user is
not authenticated then sensitive information about the service is not returned.
operationId: aboutV1
responses:
"200":
description: default response
content:
application/vnd.nuix.v2+json:
schema:
$ref: '#/components/schemas/AboutResponse'
examples:
Unauthenticated Response:
value:
server: http://localhost:8080
serverId: my-rest-server
startupTime: null
nuixRestfulVersion: null
engineVersion: null
Authenticated Response:
value:
server: http://localhost:8080
serverId: my-rest-server
startupTime: 1582916595048
nuixRestfulVersion: 15.0.0
engineVersion: 8.4.0.251
application/vnd.nuix.v1+json:
schema:
$ref: '#/components/schemas/AboutResponseV1'
examples:
Unathenticated Response:
value:
server: http://localhost:8080
serverId: my-rest-server
startupTime: null
nuixRestfulVersion: 15.0.0
engineVersion: null
licenceSource: server
casePrivilegeSecurityEnabled: false
itemSecurityEnabled: false
specificLicenseRequiredAtLogin: false
userManagementUrl: ""
textHighlightingEnabled: true
phraseHighlightingEnabled: false
Authenticated Response:
value:
server: http://localhost:8080
serverId: my-rest-server
startupTime: 1582916595048
nuixRestfulVersion: 15.0.0
engineVersion: 8.4.0.251
licenceSource: server
casePrivilegeSecurityEnabled: false
itemSecurityEnabled: false
specificLicenseRequiredAtLogin: false
userManagementUrl: ""
textHighlightingEnabled: true
phraseHighlightingEnabled: false
/charsets:
get:
summary: Returns the list of charsets on the system.
description: >
Use this operation to view the list of system charsets.
tags:
- System
operationId: getCharSets
responses:
"200":
description: A list of system charsets.
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/CharsetResponse'
example:
- name: UTF-8
displayName: UTF-8
/validation/query:
post:
tags:
- Search
summary: Validates a list of queries
description: Use this operation to validate queries.
operationId: validateQueryPost
requestBody:
content:
application/vnd.nuix.v1+json:
schema:
type: array
description: List of queries to validate
items:
type: string
responses:
"200":
description: default response
content:
application/vnd.nuix.v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/QueryValidationResponse'
components:
schemas:
ClusteredRestErrorResponse:
type: object
properties:
serverId:
type: string
description: The server ID of the server reporting the error.
developerMessage:
type: string
description: The technical description of the error.
userMessage:
type: string
description: The friendly error message.
additionalInfo:
type: object
description: Additional information about the error.
additionalProperties:
type: object
description: This is a map of additional properties.
errorCode:
type: string
description: The specific error code for the error from the list of available error codes.
enum:
- AUTHENTICATION_FAILED
- CASE_ACCESS_RESTRICTED
- CASE_LOCKED
- DELETE_DENIED
- DUPLICATE_CASES_DETECTED
- ENGINE_EXCEPTION
- FILE_TOO_LARGE
- INVALID_REQUEST_FORMAT
- INVALID_APPLICATION_RESPONSE
- INVALID_ARGUMENT
- ITEM_ACCESS_RESTRICTED
- LICENSE_EXCEPTION
- MEDIA_TYPE_NOT_SUPPORTED
- MEDIA_TYPE_NOT_ACCEPTABLE
- METHOD_NOT_ALLOWED
- NOT_IMPLEMENTED
- PRODUCTION_SET_FROZEN
- REQUIRED_ARGUMENT_MISSING
- RESOURCE_NOT_FOUND
- UNAUTHORISED
- UNKNOWN
- USER_SCRIPT_NOT_PROVIDED
- FOLDER_ALREADY_EXISTS
- CASE_LOCKED_BY_FUNCTION
- MISSING_THUMBNAIL
- ITEM_SET_ALREADY_EXISTS
- INVALID_LICENSE_TYPE_FOR_CASE
- SIMPLE_CASE_REQUIRED
- USER_ACCOUNT_LOCKED
- APPLICATION_NOT_REGISTERED
- INVALID_TEMPLATE
- DUPLICATE_RECORD
- CASE_MIGRATION_REQUIRED
- SERVICE_UNAVAILABLE
- RESPONSE_TOO_LARGE
- QUERY_PARSE_ERROR
- REMOTE_SYSTEM_ERROR
- FILE_SYSTEM_ERROR
TaskStatusRequest:
type: object
properties:
status:
description: The desired status of the TaskRequest
type: string
enum:
- IN_PROGRESS
- CANCELLED
- STOPPED
- PAUSED
AsyncFunctionStatus:
type: object
properties:
done:
type: boolean
description: Indicates whether the Async function has completed.
cancelled:
type: boolean
description: Indicates whether the Async function has been canceled.
result:
type: object
description: Result of the function.
token:
type: string
description: Authentication token used to initiate the function.
functionKey:
type: string
description: Async function key
progress:
type: number
description: Progress of the Async function
total:
type: number
description: total
percentComplete:
type: number
description: Percent completed, if available
updatedOn:
type: integer
description: Date at which the Async function was last updated represented in milliseconds since the epoch.
status:
type: string
description: Status of the Async function.
statusId:
type: string
description: A status ID if available.
requestTime:
type: integer
description: Date at which the Async function request was made represented in milliseconds since the epoch.
startTime:
type: integer
description: Date at which the Async function request was started represented in milliseconds since the epoch.
finishTime:
type: integer
description: Date at which the Async function request was finished represented in milliseconds since the epoch.
caseId:
type: string
description: Case identification token for the case on which the Async function
was performed.
caseName:
type: string
description: Name of the case on which the Async function was performed.
hasSuccessfullyCompleted:
type: boolean
description: Indicated whether the Async function has successfully completed.
friendlyName:
type: string
description: Friendly name for the Async function.
caseLocation:
type: string
description: Location of the case on which the Async function was performed.
requestor:
type: string
description: Username for user who requested the Async function.
licenseShortName:
type: string
description: The license used when executing the Async fucntion.
action:
type: string
description: action
options:
type: object
additionalProperties:
type: object
description: Options used during the execution of the Async function.
participatingInCaseFunctionQueue:
type: boolean
description: True if participating in the case function queue. False otherwise.
processedBy:
type: string
description: The server ID that processed the task.
error:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
CustodianResponse:
type: object
properties:
name:
type: string
description: The name of the custodian.
description:
type: string
description: The description of the custodian.
AsyncFunctionStatusObject:
type: object
properties:
done:
type: boolean
description: True if the task is done. False otherwise.
cancelled:
type: boolean
description: True if the task is cancelled. False otherwise.
result:
type: object
description: The result of the task.
token:
type: string
description: The user token for the task.
functionKey:
type: string
description: The function key to use when querying status.
progress:
type: number
description: Progress of the Async function
total:
type: number
description: The total.
percentComplete:
type: number
description: The percent complete.
updatedOn:
type: integer
description: Date at which the Async function was last updated represented in milliseconds since the epoch.
status:
type: string
description: Status of the Async function.
statusId:
type: string
description: A status ID if available.
requestTime:
type: integer
description: Date at which the Async function request was made represented in milliseconds since the epoch.
startTime:
type: integer
description: Date at which the Async function request was started represented in milliseconds since the epoch.
finishTime:
type: integer
description: Date at which the Async function request was finished represented in milliseconds since the epoch.
caseId:
type: string
description: Case identification token
caseName:
type: string
description: Name of the case on which the Async function was performed.
hasSuccessfullyCompleted:
type: boolean
description: Indicated whether the Async function has successfully completed.
friendlyName:
type: string
description: Friendly name for the Async function.
caseLocation:
type: string
description: Location of the case on which the Async function was performed.
requestor:
type: string
description: Username for user who requested the Async function.
licenseShortName:
type: string
description: The license used when executing the Async fucntion.
action:
type: string
description: Action if available.
options:
type: object
additionalProperties:
type: object
description: Options used during the execution of the Async function.
participatingInCaseFunctionQueue:
type: boolean
description: True if participating in the case function queue. False otherwise.
processedBy:
type: string
description: The server ID that processed the task.
error:
$ref: '#/components/schemas/ClusteredRestErrorResponse'
AsyncFunctionStatusesResponse:
type: object
properties:
executeImmediate:
type: array
description: List of AsyncFunctionStatus objects for Async functions which are queued to execute.
items:
$ref: '#/components/schemas/AsyncFunctionStatusObject'
singleItemQueue:
type: array
items:
$ref: '#/components/schemas/AsyncFunctionStatusObject'
description: List of AsyncFunctionStatus object for Async functions which are in the single item queue.
paused:
type: boolean
description: True if the task is paused. False otherwise.
pausedBy:
type: string
description: The auth token of the user that paused the task.
pausedUntil:
type: integer
format: int64
description: The time the task is paused until.
caseQueues:
type: array
description: List of queued case functions.
items:
$ref: '#/components/schemas/CaseFunctionQueue'
totalRunningFunctions:
type: integer
format: int32
description: The total number of running tasks.
CaseFunctionQueue:
type: object
properties:
caseId:
type: string
description: Case identification token
queue:
type: array
description: List of AsyncFunctionStatus objects for Async functions which
are queued to execute.
items:
$ref: '#/components/schemas/AsyncFunctionStatus'
AuthenticationRequest:
type: object
properties:
username:
type: string
description: The user requesting access to the service.
password:
type: string
description: The password credentials for the requesting user.
workers:
type: integer
format: int32
description: >
The number of workers being used. This field is optional and if not provided then the user will get a single worker.
licenceShortName:
type: string
description: >
The short name of the requested license. (UK Spelling). `licenseShortName` (US Spelling) is also accepted.
If the user fails to provide the licence short name, then the licence that is first in the list provided by the licence server will be used.
Both the UK and US spelling of the word are accepted.
required:
- username
- password
AuthenticationResponse:
type: object
properties:
username:
type: string
description: The successfully authenticated username.
authToken:
type: string
description: >
The authentication token to be submitted in the header of all subsequent requests to the REST service. The token should be included in the
`Authorization` header prefixed by `Bearer` and for a limited time will be accepted in the `nuix-auth-token` header field.
licenseShortName:
type: string
description: The short name of the requested license.
clusterSystemLicenseShortName:
type: string
description: The short name of the license acquired by the producer node when REST is configured for clustering ONLY.
This license will be used for non-worker based operations and syncronous operations as defined by the `cluster.license` property and
will ONLY be used when clustering is enabled.
workerCount:
type: integer
format: int32
description: The total number of workers available to the user. This number may differ from the workers granted when
operating in cluster mode.
workersGranted:
type: integer
format: int32
description: The number of workers granted by the engine.
GenericResponse:
type: object
properties:
success:
type: boolean
description: Returns true or false.
ApplyTagListRequest:
type: object
properties:
tagList:
type: array
description: List of tags used during the operation
items:
type: string
query:
type: string
description: Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items.
deduplication:
type: string
description: Deduplicate items. Defaults to none.
default: none
enum:
- none
- md5
- per custodian
relationType:
type: string
description: The relation to apply to the found items. For performance reasons, the family option is run against the top-level items. Defaults to no relation.
enum:
- family
- topTypes
- descendants
includeFamily:
type: boolean
description: Includes families of items for results of provided query. Defaults to false.
default: false
familyQuery:
type: string
description: An optional query used to select family items. Will not be
used if includeFamily is true. To exclude family items entirely, set
includeFamily to false and either omit this entry or set its value to
null.
includeDuplicates:
type: boolean
description: Includes duplicates of items for results of provided query. Defaults to false.
default: false
duplicatesQuery:
type: string
description: An optional query used to select duplicate items. Will not
be used if includeDuplicates is true. To exclude duplicate items entirely,
set includeDuplicates to false and either omit this entry or set its value
to null.
includeNearDuplicates:
type: boolean
description: Includes near duplicates of items for results of provided query. Defaults to false.
default: false
nearDuplicatesQuery:
type: string
description: An optional query used to select near duplicate items. Will
not be used if includeNearDuplicates is true. To exclude near duplicate
items entirely, set includeNearDuplicates to false and either omit this
entry or set its value to null.
nearDuplicatesThreshold:
type: number
description: The threshold used to calculate near duplicates. Defaults to 0.5.
format: float
default: 0.5
threadsQuery:
type: string
description: An optional query used to select thread items. To exclude
thread items entirely, either omit this entry or set its value to null.
required:
- tagList
ApplyTagListResponse:
type: object
properties:
tagList:
type: array
description: List of tags used during the operation
items:
type: string
successfulTags:
type: array
description: List of tags that successfully completed the operation
items:
type: string
failedTags:
type: array
description: List of tags that failed the operation
items:
type: string
TagList:
type: object
properties:
tagList:
type: array
description: List of tags used during the operation
items:
type: string
required:
- tagList
BulkApplyCaseTagListRequest:
type: object
properties:
tagList:
type: array
description: List of tags used during the operation. The tag list is optional for a `RENAME` operation.
items:
type: string
renameMap:
type: object
additionalProperties:
type: object
description: A map of tags where the key is the current tag name and the value is the new tag name.
operationType:
type: string
description: The operation to perform on the tag.
enum:
- ADD
- DELETE
- RENAME
BulkApplyItemTagListRequest:
type: object
properties:
tagList:
type: array
description: List of tags used during the operation
items:
type: string
query:
type: string
description: Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items.
deduplication:
type: string
description: Deduplicate content. Defaults to none.
default: none
enum:
- none
- md5
- per custodian
relationType:
type: string
description: The relation to apply to the found items. For performance reasons, the family option is run against the top-level items. Defaults to no relation.
enum:
- family
- topTypes
- descendants
includeFamily:
type: boolean
description: Includes families of items for results of provided query. Defaults to false.
default: false
familyQuery:
type: string
description: An optional query used to select family items. Will not be
used if includeFamily is true. To exclude family items entirely, set
includeFamily to false and either omit this entry or set its value to
null.
includeDuplicates:
type: boolean
description: Includes duplicates of items for results of provided query. Defaults to false.
default: false
duplicatesQuery:
type: string
description: An optional query used to select duplicate items. Will not
be used if includeDuplicates is true. To exclude duplicate items entirely,
set includeDuplicates to false and either omit this entry or set its value
to null.
includeNearDuplicates:
type: boolean
description: Includes near duplicates of items for results of provided query. Defaults to false.
default: false
nearDuplicatesQuery:
type: string
description: An optional query used to select near duplicate items. Will
not be used if includeNearDuplicates is true. To exclude near duplicate
items entirely, set includeNearDuplicates to false and either omit this
entry or set its value to null.
nearDuplicatesThreshold:
type: number
format: float
description: The threshold used to calculate near duplicates. Defaults to 0.5.
default: 0.5
threadsQuery:
type: string
description: An optional query used to select thread items. To exclude
thread items entirely, either omit this entry or set its value to null.
operationType:
type: string
description: The operation to perform on the tag.
enum:
- ADD
- DELETE
BulkApplyItemSetChangeResponse:
type: object
properties:
results:
description: The list of item set change responses.
type: array
items:
$ref: '#/components/schemas/ItemSetItemsResponse'
ItemSetItemsResponse:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items.
itemSetName:
type: string
description: The item set name.
operationType:
type: string
description: The operation to perform on the item set.
enum:
- ADD
- DELETE
failedItemGuidList:
type: array
description: The list of failed item guids.
items:
type: string
successfulItemGuidList:
type: array
description: The list of successful item guids.
items:
type: string
BulkApplyItemCustomMetadataRequest:
type: object
properties:
addBulkCustomMetadata:
type: array
description: The array of bulk custom metadata to add to the item.
items:
$ref: '#/components/schemas/BulkItemCustomMetadataRequest'
deleteBulkCustomMetadata:
type: array
description: The array of the bulk custom metadata to remove from the item.
items:
$ref: '#/components/schemas/BulkItemCustomMetadataDeleteRequest'
CreateTagListResponse:
type: object
properties:
tagList:
type: array
description: List of tags used during the operation
items:
type: string
createdTags:
type: array
description: List of tags that were succuessfully created
items:
type: string
failedTags:
type: array
description: List of tags that failed to be created
items:
type: string
DeleteTagListResponse:
type: object
properties:
tagList:
type: array
description: List of tags used during the operation
items:
type: string
deletedTags:
type: array
description: List of tags that were successfully deleted
items:
type: string
failedTags:
type: array
description: List of tags that failed deletion
items:
type: string
BulkExclusionRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
deduplication:
type: string
description: Deduplication content. Defaults to no deduplication.
enum:
- md5
- per custodian
- none
relationType:
type: string
description: The relation to apply to the found items. For performance reasons, the family option is run against the top-level items. Defaults to no relation.
enum:
- family
- topTypes
- descendants
includeFamily:
type: boolean
description: Includes families of items for results of provided query. Defaults to false.
default: false
familyQuery:
type: string
description: An optional query used to select family items. Will not be
used if includeFamily is true. To exclude family items entirely, set
includeFamily to false and either omit this entry or set its value to
null.
includeDuplicates:
type: boolean
description: Includes duplicates of items for results of provided query. Defaults to false.
default: false
duplicatesQuery:
type: string
description: An optional query used to select duplicate items. Will not
be used if includeDuplicates is true. To exclude duplicate items entirely,
set includeDuplicates to false and either omit this entry or set its value
to null.
includeNearDuplicates:
type: boolean
description: Includes near duplicates of items for results of provided query. Defaults to false.
default: false
nearDuplicatesQuery:
type: string
description: An optional query used to select near duplicate items. Will
not be used if includeNearDuplicates is true. To exclude near duplicate
items entirely, set includeNearDuplicates to false and either omit this
entry or set its value to null.
nearDuplicatesThreshold:
type: number
description: The threshold used to calculate near duplicates. Defaults to 0.5.
format: float
default: 0.5
threadsQuery:
type: string
description: An optional query used to select thread items. To exclude
thread items entirely, either omit this entry or set its value to null.
reason:
type: string
description: The reason for the exclusion.
excludeDescendants:
type: boolean
description: Whether or not to also exclude descendants.
default: false
required:
- reason
AsyncFunctionResponse:
type: object
properties:
functionKey:
type: string
description: The function key to use when querying status.
location:
type: string
description: The location URL for querying status. (http://nuix-restful-service:8080/svc/v1/asyncFunctions/{functionKey})
BulkInclusionRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
deduplication:
type: string
description: Deduplication content. Defaults to no deduplication.
enum:
- md5
- per custodian
- none
relationType:
type: string
description: The relation to apply to the found items. For performance reasons, the family option is run against the top-level items. Defaults to no relation.
enum:
- family
- topTypes
- descendants
includeFamily:
type: boolean
description: Includes families of items for results of provided query. Defaults to false.
default: false
familyQuery:
type: string
description: An optional query used to select family items. Will not be
used if includeFamily is true. To exclude family items entirely, set
includeFamily to false and either omit this entry or set its value to
null.
includeDuplicates:
type: boolean
description: Includes duplicates of items for results of provided query. Defaults to false.
default: false
duplicatesQuery:
type: string
description: An optional query used to select duplicate items. Will not
be used if includeDuplicates is true. To exclude duplicate items entirely,
set includeDuplicates to false and either omit this entry or set its value
to null.
includeNearDuplicates:
type: boolean
description: Includes near duplicates of items for results of provided query. Defaults to false.
default: false
nearDuplicatesQuery:
type: string
description: An optional query used to select near duplicate items. Will
not be used if includeNearDuplicates is true. To exclude near duplicate
items entirely, set includeNearDuplicates to false and either omit this
entry or set its value to null.
nearDuplicatesThreshold:
type: number
description: The threshold used to calculate near duplicates. Defaults to 0.5.
format: float
default: 0.5
threadsQuery:
type: string
description: An optional query used to select thread items. To exclude
thread items entirely, either omit this entry or set its value to null.
ClusterRunRequest:
type: object
properties:
name:
type: string
description: The name to give the cluster run.
query:
type: string
description: A query that selects the items to perform cluster analysis on.
resemblanceThreshold:
type: number
format: float
description: The resemblance threshold used for computing chained near-duplicates.
useChainedNearDuplicates:
type: boolean
description: Whether or not the clustering algorithm should use chained near-deduplication.
useEmailThreads:
type: boolean
description: Whether or not the clustering algorithm should use email threads.
saveIfEmpty:
type: boolean
description: Only create the cluster run if near-duplicates are found.
required:
- name
- query
MetadataItemDetails:
type: object
properties:
name:
type: string
description: The metadata name.
localisedName:
type: string
description: The localized name of the metadata.
type:
type: string
description: The metadata type.
SearchNativeRequest:
type: object
properties:
caseId:
type: string
description: The case identification token.
query:
type: string
description: Identifies what items should be returned. If a query is not
supplied it defaults to an empty string, which returns all items.
sortField:
type: string
description: |
Any field in the metadata profile which you want to sort by.
Use the following supported fields in the sortFields:
position,kind,duplicates
sortOrder:
type: string
description: Sets the sort order for the results. Defaults to "ASC".
enum:
- asc
- desc
default: asc
startIndex:
type: integer
default: 0
description: The index of the first record that should be returned. Defaults to 0.
format: int32
numberOfRecordsRequested:
type: integer
description: The number of records that should be returned per page. Defaults to 100 records.
format: int32
limit:
type: integer
description: The maximum number of results to return.
format: int32
deduplication:
type: string
description: Deduplicate content based on the Value field selection. Defaults to no deduplication.
enum:
- md5
- per custodian
- none
maintainDeduplicatedSearchOrder:
type: boolean
default: true
description: Specifies whether the original search result order based on the query should be maintained for
deduplicated results. Default is true. Setting this field to false may improve deduplication performance
especially for Elasticsearch cases. This field is ignored if a sort field has been specified.
metadataProfile:
type: string
description: Defines the metadata profile to be appied to the results. Needed to get custom metadata. Defaults to no metadata profile.
fieldList:
type: array
description: |
List of fields to be returned for each item in the results.
Use the following supported fields in the fieldList:
* `all` - Returns all fields for the item.
* `auditedSize` - Returns the item''s audited size.
* `children` - Returns a list of the item''s children.
* `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.
* `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.
* `comment` - Returns item comments.
* `communication` - If the item is a communication, this returns item communication information.
* `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.
* `custodian` - Returns the custodian assigned to an item.
* `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.
* `date` - Returns the item date.
* `descendants` - Gets the list of items which are descendants of this item.
* `digests` - Returns a map of the computed digests for an item.
* `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.
* `duplicates` - Returns duplicates of this item.
* `evidenceMetadata` - Returns custom evidence metadata for the item.
* `exclusion` - Returns the reason for an item''s exclusion.
* `family` - Returns a list of items in the same family.
* `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.
* `fileType` - Returns the name of the file type.
* `guid` - Returns the item''s globally unique identifier (GUID).
* `history` - Returns the item''s history in ascending order by date.
* `id` - Returns the item''s ID.
* `isAudited` - Tests whether the item is considered audited and returns true or false.
* `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it. This returns
true if the item had binary data at processing time that was not stored. This
differs from isStored() as this method returns true if the item had binary
data at processing time that was not stored.
* `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned
if stored binary exists. In this case, the source data isn''t required for
binary export.
* `isChatMessage` - Tests whether the item is a chat message.
* `isChatConversation` - Tests whether the item is a chat conversation.
* `isDeleted` - Tests whether the item was marked as deleted and returns true or false.
* `isEmailThreadMember` - Tests whether the item is part of an email thread.
* `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.
* `isExcluded` - Tests whether the item was marked as excluded.
* `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).
* `isIncuded` - Tests whether the item is included and returns true or false.
* `isLooseFile` - Tests whether the item is a loose file and returns true or false.
* `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.
* `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field
is useful when you only need to know if a printed image exists for this item.
This is faster and uses fewer resources than requesting the printedImageInfo
field.
* `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.
* `isTextStored` - Tests hether the item has text stored against it in the database. In the event
where you only want to know if the item had text but didn''t need the text
this field is considerably faster and more conservative of resources than
isTextAvailable.
* `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.
* `isTopLevel` - Tests whether this is a top-level item and returns true or false.
* `itemCategory` - Returns the item category.
* `kind` - Returns the item kind.
* `language` - Returns the language identified by the item.
* `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])
if the name is blank.
* `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.
* `name` - Returns the item name.
* `originalExtension` - Returns the original extension listed on the source file.
* `parent` - Returns the parent of this item.
* `path` - Returns an item list which represents the path from the root evidence container to the item.
* `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.
* `pathNames` - Returns a list of item names on the path from the root evidence container to the item.
* `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.
* `printedImageInfo` - Returns information about the printed image.
* `properties` - Returns item properties.
* `root` - Returns the root item. If this item is the root, the item itself is returned.
* `rootUri` - Returns the item''s root URI as a string.
* `tags` - Returns the item tags.
* `text` - Returns the text of the item as a string.
* `textHtml` - Returns the text of the item escaped for HTML.
* `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.
* `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.
* `threadItems` - Returns items that are in the same discussion thread as this item.
* `topLevelItem` - Returns the associated top-level item.
* `topLevelItemDate` - Returns the associated top-level item date.
* `type` - Returns the type name.
* `typeLocalisedName` - Returns the type name, localised appropriately for display to users.
* `uri` - Returns the item''s uniform resource identifier (URI) as a string.
items:
type: string
customMetadataList:
description: List of custom metadata fields to be returned for each item in the results.
type: array
items:
type: string
propertyList:
type: array
description: List of properties to be returned for each item in the results.
items:
type: string
itemParameterizedFields:
type: array
items:
type: string
description: Specifies parameterized fields in a key/value pair separated by a colon.
* `entities` - corresponds to item.getEntities. (e.g., "entities:company")
* `serializedItem` - returns a serialized copy of the item. (e.g., "seralizedItem:topLevelItem")
* `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., "textTruncated:10000")
* `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., "thumbnail:200x200")
* `nearDupeThreshold` - (e.g., "nearDupeThreshold:0.9")
* `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., "emailThreadCluster:cluster-1")
showAvailableThumbnails:
type: boolean
description: Show thumbnails that have been generated
useCache:
type: boolean
default: false
description: Specifies whether the results should be loaded from and stored in cache. Defaults to false.
forceCacheDelete:
type: boolean
default: false
description: Specifies whether the cached results should be deleted before performing the search. Defaults to false.
searchRetry:
type: integer
format: int32
description: Specifies the search retry count.
relationType:
type: string
description: The relation to apply to the found items. For performance reasons, the family option is run against the top-level items.
enum:
- family
- topTypes
- descendants
entities:
type: array
description: List of entity names to include in response (e.g. company,email). Maintained for backward compatibility.
items:
type: string
property:
type: array
description: List of properties to be returned for each item in the results. Deprecated use propertyList.
items:
type: string
deprecated: true
field:
type: array
description: List of fields to be returned for each item in the results. Deprecated use fieldList.
items:
type: string
deprecated: true
s:
type: integer
format: int32
description: The index of the first record that should be returned. Deprecated use startIndex.
deprecated: true
p:
type: integer
format: int32
description: The number of records that should be returned. Deprecated use numberOfRecordsRequested.
deprecated: true
customMetadataField:
type: array
description: List of custom metadata to be returned for each item in the results. Deprecated use customMetadataList.
items:
type: string
deprecated: true
SearchNativeResult:
type: object
properties:
request:
$ref: '#/components/schemas/SearchNativeRequest'
startedOn:
type: integer
description: Date the search started represented in milliseconds since the epoch.
completedOn:
type: integer
description: Date the search completed represented in milliseconds since the epoch.
elapsedTimeForSearch:
type: integer
description: Elapsed time to perform search.
format: int64
elapsedTimeForSort:
type: integer
format: int64
description: Elapsed time to perform the sort.
elapsedTimeForMarshal:
type: integer
format: int64
description: Elapsed time to perform the JSON marshalling.
elapsedTimeForDeduplicate:
type: integer
format: int64
description: Elapsed time to deduplicate items.
elapsedTotal:
type: integer
format: int64
description: Total elapsed time.
metadataItems:
type: array
description: The list of metadata item fields.
items:
type: string
deprecated: true
localizedMetadataItems:
description: The list of localized metadata item fields.
type: array
items:
type: string
deprecated: true
metadataItemDetails:
type: array
description: The list of metadata item details.
items:
$ref: '#/components/schemas/MetadataItemDetails'
resultList:
type: array
description: Results of the search
items:
type: object
additionalProperties:
type: object
count:
type: integer
description: Count of items in results
format: int32
deduplicatedCount:
type: integer
description: Count of deduplicated items
format: int32
BulkSearcherRequest:
type: object
properties:
includeFamilies:
type: boolean
description: Whether item families should also be matched. Defaults to false.
default: false
deduplicateFamilies:
type: boolean
description: Whether deduplicated item families should also be matched.
Defaults to false.
default: false
omitExcludedItems:
type: boolean
description: Whether excluded items should be excluded from matches. Defaults
to true.
default: true
omitImmaterialFamilyItems:
type: boolean
description: Whether immaterial family items should be excluded from family
item and deduplicated family item matches. Defaults to true.
default: true
tagUniqueItems:
type: boolean
description: Whether to record items that only matched a single query. Defaults
to false.
default: false
matchingItemsAction:
type: string
description: Action to take when a matching item is found. Tagging is performed
when this option is "ADD_TAGS". Defaults to "ADD_TAGS".
enum:
- addTags
- removeTags
- none
default: addTags
createUnusedTags:
type: boolean
description: Whether to create tags even if no items match them. Only has
effect if matchingItemsAction == "addTags". Defaults to false.
default: false
removeEmptyTags:
type: boolean
description: Whether to remove tags from the case if there are no longer
any items that match them. Only has effect if matchingItemsAction == "removeTags".
Defaults to false.
default: false
showTagColumns:
type: boolean
description: Whether to show the tag name columns in the results table.
Defaults to true.
default: true
allowDuplicateTags:
type: boolean
description: Whether the same tag can be applied on more than one row with
different queries. Defaults to true.
default: true
allowDuplicateQueries:
type: boolean
description: Whether the same query can be applied on more than one row
with different tags. Defaults to true.
default: true
countResponsiveItems:
type: boolean
description: Whether to compile counts for responsive items.
default: false
tagResponsiveItemsEnabled:
type: boolean
description: Whether to apply tags to responsive items. Only has an effect if countResponsiveItems is true and tagResponsiveItemsTag is non-null.
default: false
tagResponsiveItemsTag:
type: string
description: What tag to apply to responsive items. Only has an effect if both countResponsiveItems and tagResponsiveItemsEnabled are true.
default: null
missingTagsAction:
type: string
description: What to do when a tag is missing in a table row. Does not affect
blank rows. Defaults to FILL_WITH_QUERY.
enum:
- fillWithQuery
- fillWithRowNumber
- showValidationError
default: fillWithQuery
expandTags:
type: boolean
description: Whether tags for top-level item matches and family item matches
should be expanded according to the tagExpansion map. Defaults to true.
default: true
tagExpansion:
$ref: '#/components/schemas/TagExpansion'
scopingQuery:
type: string
description: A query that restricts the scope of all queries in the file.
i.e. a common query that is joined with every individual query to limit
the items that it can match. Defaults to an empty string.
default: ""
searchFields:
type: array
description: A list of fields to search. If null is passed in or this field
is not set or empty then a list of default search fields is used (which
consists of "CONTENT", "PROPERTIES", "NAME" and "PATH_NAME").
items:
type: string
enum:
- content
- properties
- name
- path-name
- evidence-metadata
tagRequests:
type: array
description: A list of tag requests to perform.
items:
$ref: '#/components/schemas/TagRequest'
required:
- tagRequests
TagExpansion:
type: object
properties:
directMatchPrefix:
type: string
description: A prefix to apply to direct matches, i.e. items that match
the given query, or null not to apply a prefix. Defaults to null.
directMatchSuffix:
type: string
description: A suffix to apply to direct matches, i.e. items that match
the given query, or null not to apply a suffix. Defaults to null.
topLevelMatchPrefix:
type: string
description: A prefix to apply to top-level item matches, or null not to
apply a prefix. Only has an effect if includeFamilies == true. Defaults
to null.
topLevelMatchSuffix:
type: string
description: A suffix to apply to top-level item matches, or null not to
apply a suffix. Only has an effect if includeFamilies == true. Defaults
to null.
familyMatchPrefix:
type: string
description: A prefix to apply to family item matches, or null not to apply
a prefix. Only has an effect if includeFamilies == true. Defaults to null.
familyMatchSuffix:
type: string
description: A suffix to apply to family item matches, or null not to apply
a suffix. Only has an effect if includeFamilies == true. Defaults to null.
deduplicatedTopLevelMatchPrefix:
type: string
description: A prefix to apply to deduplicated top-level item matches, or
null not to apply a prefix. Only has an effect if deduplicateFamilies
== true. Defaults to null.
deduplicatedTopLevelMatchSuffix:
type: string
description: A suffix to apply to deduplicated top-level item matches, or
null not to apply a suffix. Only has an effect if deduplicateFamilies
== true. Defaults to null.
deduplicatedFamilyMatchPrefix:
type: string
description: A prefix to apply to deduplicated family item matches, or null
not to apply a prefix. Only has an effect if deduplicateFamilies == true.
Defaults to null.
deduplicatedFamilyMatchSuffix:
type: string
description: A suffix to apply to deduplicated family item matches, or null
not to apply a suffix. Only has an effect if deduplicateFamilies == true.
Defaults to null.
uniqueMatchPrefix:
type: string
description: A prefix to apply to unique item matches, or null not to apply
a prefix. Only has an effect if tagUniqueItems == true. Defaults to null.
uniqueMatchSuffix:
type: string
description: A suffix to apply to unique item matches, or null not to apply
a prefix. Only has an effect if tagUniqueItems == true. Defaults to null.
TagRequest:
type: object
properties:
query:
type: string
description: The query to use to find matching items to tag.
tag:
type: string
description: The name of the tag to apply or create.
CaseResponse:
type: object
properties:
caseId:
type: string
description: The case's unique identifier
name:
type: string
description: The case name
path:
type: string
description: The path to the case
description:
type: string
description: The case description
investigator:
type: string
description: The investigator for this case
creationDate:
type: integer
description: The date/time this case was created, in milliseconds since epoch
format: int64
compound:
type: boolean
description: Whether this case is Simple or Compound
elastic:
type: boolean
description: Whether this is an Elastic case
binaryStoreLocation:
type: string
description: The binary store location for this case, if applicable
indexId:
type: string
description: The index id
caseSize:
type: integer
description: The size of the case on disk, in bytes
format: int64
casePathParent:
type: string
description: Path to the parent directory of the case
caseInvestigationTimeZone:
type: string
description: The investigation time zone, e.g. America/New_York
hasExclusions:
type: boolean
description: True if the case has exclusions
hasNuixSystemTags:
type: boolean
description: True if the case has Nuix system tags
hasProductionSets:
type: boolean
description: True if the case has production sets
hasCalculatedAuditSize:
type: boolean
description: True if the case has a calculated audit size
caseName:
type: string
description: Deprecated; use 'name' instead
casePath:
type: string
description: Deprecated; use 'path' instead
caseDescription:
type: string
description: Deprecated; use 'description' instead
caseCreationDate:
type: integer
description: Deprecated; use 'creationDate' instead
caseInvestigator:
type: string
description: Deprecated; use 'investigator' instead
MarkupSet:
type: object
properties:
guid:
type: string
description: Gets the GUID of the markup set.
name:
type: string
description: Gets the name of the markup set.
description:
type: string
description: Gets the description of the markup set.
redactionReason:
type: string
description: Gets the redaction reason for this markup set.
ClusterRunResponse:
type: object
properties:
guid:
type: string
description: The GUID of the cluster run.
clusterName:
type: string
description: The name of the cluster run.
clusters:
type: array
description: A list of all clusters associated with this cluster run.
items:
type: string
resemblanceThreshold:
type: number
description: Gets the resemblance threshold associated with the cluster run, irrespective of what clustering options are set.
format: float
useChainedNearDuplicatesEnabled:
type: boolean
description: Gets whether or not chained near-duplicates were used during
clustering.
useEmailThreadsEnabled:
type: boolean
description: Gets whether or not email threads were used during clustering.
KindTypeResponse:
type: object
properties:
itemKind:
type: string
description: Gets the kind.
localisedItemKind:
type: string
description: Gets the name of this type, localised appropriately for display to users.
itemTypes:
type: array
description: Gets the collection of all types which are of this kind.
items:
$ref: '#/components/schemas/NuixItemType'
NuixItemType:
type: object
properties:
name:
type: string
description: Gets the name of this type.
localisedName:
type: string
description: Gets the name of this type, localised appropriately for display to users.
preferredExtension:
type: string
description: Gets the preferred file extension.
kind:
type: string
description: Gets the kind.
count:
type: integer
description: Gets the count of items of this kind.
format: int64
ReviewJobResponse:
type: object
properties:
name:
type: string
description: The name of the review job.
guid:
type: string
description: The GUID for this review job.
required:
- name
- guid
CreateReviewJobOptions:
type: object
description: The review job options.
properties:
tags:
type: array
description: Tags to be used for the review job.
items:
type: string
highlights:
type: array
description: Any words to highlight.
items:
type: string
order:
type: string
description: Default sort order for items in a review job. Default is orderAdded.
enum:
- orderAdded
- ascendingItemDate
- descendingItemDate
- ascendingTopLevelItemDate
- descendingTopLevelItemDate
default: orderAdded
useNearDuplicates:
type: boolean
description: Use chained near-duplicates when batching out items to a reviewer. Default
is true.
default: true
useEmailThreads:
type: boolean
description: Use email threads when batching out items to a reviewer. Default
is false.
default: false
CreateReviewJobRequest:
type: object
properties:
name:
type: string
description: The name of the review job.
options:
$ref: '#/components/schemas/CreateReviewJobOptions'
required:
- name
ReviewJobAddItemsOptions:
type: object
properties:
user:
type: string
description: The user to assign the items to.
ReviewJobAddItemsRequest:
type: object
properties:
query:
type: string
description: Query items that should be added to the review job.
options:
$ref: '#/components/schemas/ReviewJobAddItemsOptions'
required:
- query
NuixReviewJobItem:
type: object
properties:
completionDateTime:
type: integer
description: Returns the date the review item was completed.
format: int64
item:
type: object
additionalProperties:
type: object
description: Returns the item
Success:
type: object
description: A wrapper object for a boolean.
properties:
success:
type: boolean
description: A boolean value true or false.
ItemPropertiesRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
distinct:
type: boolean
description: If true, excludes duplicate property values from the results.
Default is true.
CreateCaseRequest:
type: object
properties:
compound:
type: boolean
description: Determines whether the case is simple or compound. Default
is false
default: false
location:
type: string
description: Where the case should be created. e.g. inventory0, inventory1
default: inventory0
name:
type: string
description: The name of the case. e.g. mycase
description:
type: string
description: The case description
investigator:
type: string
description: The case investigator
elasticSearchSettings:
$ref: '#/components/schemas/ElasticSearchSettings'
binaryStoreLocation:
type: string
description: Path to file system binary store for this case. It can be shared
by cases and should be accessible from all workers. Defaults to null,
which means binary store will be within the on-disk portion of the case.
required:
- name
ElasticSearchSettings:
type: object
properties:
additionalSettings:
type: object
additionalProperties:
type: string
description: Additional ElasticSearch settings to include. This is a flattened
map (e.g. 'index.refresh_interval'). This is an advanced feature and should
only be used by those familiar with ElasticSearch. Values that can be
directly specified elsewhere in this request will be ignored if they are
provided in this map. See ElasticSearch documentation for more info.
This field is deprecated. Additional settings can now be passed in under ElasticSearchSettings
within the same level of the other settings.
deprecated: true
cluster.name:
type: string
description: Name of the cluster to join. See ElasticSearch documentation
for more info.
index.number_of_shards:
type: integer
description: Number of shards to allocate for the index. Must be greater
than zero. Cannot be changed after creating the index. See ElasticSearch
documentation for more info.
format: int32
index.number_of_replicas:
type: integer
description: Number of replicas to use. Must be a positive number. This
can be modified after creation, but only through ElasticSearch APIs. See
ElasticSearch documentation for more info.
format: int32
index.refresh_interval:
type: string
description: Refresh interval to use. Defaults to '60s'. See ElasticSearch
documentation for more info.
nuix.index.auto_close:
type: boolean
description: Should closing the case via Nuix close the index in ElasticSearch?
Defaults to 'false'.
nuix.http.hosts:
type: array
description: List of hosts (host:port) to communicate with the Elasticsearch cluster. If not provided
nuix.transport.hosts will be used.
items:
type: string
nuix.transport.hosts:
type: array
description: List of hosts (host:port) to communicate with the cluster.
This is a round-robin, load-balanced list. Other nodes may be discovered
in the cluster. If this and 'discovery.zen.ping.unicast.hosts' are not
provided it defaults to localhost.
items:
type: string
xpack.security.user:
type: string
description: The X-pack user name for transport level credentials. Note
the password is not included here as Elastic documentation recommends.
Instead it is securely stored in a separate field xpack.security.password.
xpack.security.password:
type: string
description: The X-Pack password for the user.
xpack.security.transport.ssl.enabled:
type: boolean
description: Set this to true to enable SSL connections to nodes running X-pack.
xpack.security.transport.ssl.truststore.path:
type: string
description: The path for the keystore that contains the certificates to trust.
It must be either a Java keystore (jks) or a PKCS#12 file.
xpack.security.transport.ssl.truststore.type:
type: string
description: Set this to PKCS12 to indicate that the truststore is a PKCS#12 file or jks for a Java keystore
file.
xpack.security.transport.ssl.keystore.path:
type: string
description: The path for the keystore file that contains a private key and certificate. It must be either
a Java keystore (jks) or a PKCS#12 file.
xpack.security.transport.ssl.keystore.type:
type: string
description: The format of the keystore file. It must be either jks or PKCS12. If the keystore path ends in
".p12", ".pfx", or ".pkcs12", this setting defaults to PKCS12. Otherwise, it defaults to jks.
xpack.security.transport.ssl.verification_mode:
type: string
description: Controls the verification of certificates. Valid values are full, certificate, and none.
xpack.security.http.ssl.enabled:
type: boolean
description: Used to enable or disable TLS/SSL on the HTTP networking layer, which Elasticsearch uses
to communicate with other clients. The default is false.
xpack.security.http.ssl.key:
type: string
description: The path to the SSL key file for this client's identity in
PEM format if HTTP client authentication is required. It must be signed
by the cluster's trusted CA.
xpack.security.http.ssl.key_passphrase:
type: string
description: The passphrase that is used to decrypt the private key. Since the key might not be encrypted,
this value is optional.
xpack.security.http.ssl.keystore.key_password:
type: string
description: The password for the key in the keystore. The default is the keystore password
xpack.security.http.ssl.keystore.path:
type: string
description: The path for the keystore file that contains a private key and certificate. It must be either
a Java keystore (jks) or a PKCS#12 file.
xpack.security.http.ssl.keystore.type:
type: string
description: The format of the keystore file. It must be either jks or PKCS12. If the keystore path ends
in ".p12", ".pfx", or ".pkcs12", this setting defaults to PKCS12. Otherwise, it defaults to jks.
xpack.security.http.ssl.keystore.password:
type: string
description: The password for the keystore.
xpack.security.http.ssl.truststore.path:
type: string
description: The path for the keystore that contains the certificates to trust. It must be either a Java
keystore (jks) or a PKCS#12 file.
xpack.security.http.ssl.truststore.type:
type: string
description: Set this to PKCS12 to indicate that the truststore is a PKCS#12 file or jks for a Java keystore
file.
xpack.security.http.ssl.certificate:
type: string
description: Specifies the path for the PEM encoded certificate (or certificate chain) that is
associated with the key.
xpack.security.http.ssl.certificate_authorities:
type: string
description: List of paths to PEM encoded certificate files that should be trusted.
nuix.auth.username:
type: string
description: The authenticated user's username. Used with X-Pack and SearchGuard,
this can be different to the transport level credentials.
nuix.auth.password:
type: string
description: The authenticated user's password.
searchguard.ssl.transport.keystore_filepath:
type: string
description: The path to the SSL keystore for this client's identity in
JKS format. It contains client's key and certificate signed by the cluster's
trusted CA allowing the cluster to trust Nuix.
searchguard.ssl.transport.keystore_password:
type: string
description: The password to the keystore.
searchguard.ssl.transport.truststore_filepath:
type: string
description: The path to the SSL truststore for the client's trusted CAs
in JKS format. It contains the CA certificate that signed the cluster's
certificates allowing Nuix to trust the cluster.
searchguard.ssl.transport.truststore_password:
type: string
description: The password to the truststore.
required:
- cluster.name
- nuix.transport.hosts
CaseSubsetMetadata:
type: object
properties:
name:
type: string
description: The name of the case. If not supplied the current time in
milliseconds will be used.
description:
type: string
description: The case description
investigator:
type: string
description: The case investigator
elasticSearchSettings:
$ref: '#/components/schemas/ElasticSearchSettings'
binaryStoreLocation:
type: string
description: The binary store location for this case, if applicable
CaseSubsetProcessingSettings:
type: object
properties:
analysisLanguage:
type: string
description: A supported language code. en - English, ja - Japanese. Default
is "en".
default: en
stopWords:
type: boolean
description: stopWords. Default is false.
default: false
stemming:
type: boolean
description: If true, stems words using English rules before indexing (e.g.
"fishing" -> "fish".) If false, no stemming is performed. Default is false.
default: false
enableExactQueries:
type: boolean
description: enableExactQueries. Default is false.
default: false
CreateCaseSubsetRequest:
type: object
properties:
query:
type: string
description: Query items that should be included in the subset. If a query
is not supplied it defaults to an empty string, which returns all items.
location:
type: string
description: Where the subset case should be created. e.g. inventory0, inventory1
default: inventory0
evidenceStoreCount:
type: integer
description: Specifies the maximum number of evidence stores to create. Default
is 1
format: int32
default: 1
includeFamilies:
type: boolean
description: Include item families in export. Default is false
default: false
copyTags:
type: boolean
description: Copy tags from the source case to the destination case. Default
is false
default: false
copyComments:
type: boolean
description: Copy comments from the source case to the destination case. Default
is false
default: false
copyCustodians:
type: boolean
description: Copy custodians from the source case to the destination case. Default
is false
default: false
copyItemSets:
type: boolean
description: Copy item sets from the source case to the destination case. Default
is false
default: false
copyClassifiers:
type: boolean
description: Copy classifiers from the source case to the destination case. Default
is false
default: false
copyMarkupSets:
type: boolean
description: Copy markup sets from the source case to the destination case. Default
is false
default: false
copyProductionSets:
type: boolean
description: Copy production sets from the source case to the destination
case. Default is false
default: false
copyClusters:
type: boolean
description: Copy clusters from the source case to the destination case. Default
is false
default: false
copyCustomMetadata:
type: boolean
description: Copy custom metadata from the source case to the destination
case. Default is false
default: false
caseMetadata:
$ref: '#/components/schemas/CaseSubsetMetadata'
processingSettings:
$ref: '#/components/schemas/CaseSubsetProcessingSettings'
CaseMetadataField:
type: object
properties:
name:
type: string
description: The metadata field name
type:
type: string
description: 'The metadata field type. Will be one of:
SPECIAL: Metadata
defined by the application such as GUID, Name, etc.
PROPERTY: Regular
metadata which was stored within an item.
DERIVED: Metadata identifier
using an arbitrary expression.
EVIDENCE: Metadata assigned at the
evidence level at load time.
SCRIPTED: Metadata using an arbitrary
scripted expression.
CUSTOM: User-defined custom metadata.'
BatchLoadDetailsResponse:
type: object
properties:
batchId:
type: string
description: The batch identifier.
loadedOn:
type: integer
description: The date and time the batch was loaded represented in milliseconds since the epoch.
operatingSystem:
type: string
description: The name of the operating system the batch was loaded under.
operatingSystemArchitecture:
type: string
description: The operating system architecture the batch was loaded under
processArchitecture:
type: string
description: process architecture the batch was loaded under
dataSettings:
type: object
additionalProperties:
type: object
description: The data settings for the batch load as a map.
dataProcessingSettings:
type: object
additionalProperties:
type: object
description: The data processing settings for the batch load as a map.
parallelProcessingSettings:
type: object
additionalProperties:
type: object
description: The parallel processing settings for the batch load as a map
caseEvidenceSettings:
type: object
additionalProperties:
type: object
description: The case evidence settings for the batch load as a map.
additionalSettings:
type: object
additionalProperties:
type: object
description: The additional settings for the batch load as a map.
CaseHistoryEventResponse:
type: object
properties:
cancelled:
type: boolean
description: Tests if the action was cancelled.
details:
type: object
description: Gets the details of the event.
additionalProperties:
type: object
startDate:
type: integer
description: Gets the start date (and time.) represented in milliseconds since the epoch.
endDate:
type: integer
description: Gets the end date (and time.) represented in milliseconds since the epoch.
failed:
type: boolean
description: Tests if the action failed.
succeeded:
type: boolean
description: Tests if the action succeeded.
unknown:
type: boolean
description: Tests if the action was unknown.
type:
type: string
description: Gets the type string for this event.
username:
type: string
description: Gets the user who performed the action.
NmsUser:
type: object
properties:
longName:
type: string
description: The long name of the user.
shortName:
type: string
description: The short name of the user.
LanguageResponse:
type: object
properties:
code:
type: string
description: The language code.
languageName:
type: string
description: The display name for the language.
itemCount:
type: integer
format: int64
description: The number of items in that language.
TimezoneRequest:
type: object
properties:
timezone:
type: string
description: A valid Joda timezone ID.
required:
- timezone
InvestigatorTimeZoneResponse:
type: object
properties:
timeZone:
type: string
description: "Gets the time zone ID for the case's investigation time zone.
You can find a list of valid timezones at: http://www.joda.org/joda-time/timezones.html"
CaseDeleteResponse:
type: object
properties:
caseId:
type: string
description: caseId
success:
type: boolean
description: success
errorMessage:
type: string
description: Error message if the delete operation failed
childCases:
description: The list of child cases deleted if the deleted case was a compound case
type: array
items:
$ref: '#/components/schemas/CaseDeleteResponse'
MarkupSetRequest:
type: object
properties:
name:
type: string
description: The name of the markup set.
description:
type: string
description: A description of the markup set.
redactionReason:
type: string
description: An explaination of why the redaction was added.
MarkupSetDeleteResponse:
type: object
properties:
success:
type: boolean
description: Gets whether the markup set was successfully deleted.
name:
type: string
description: The name of the deleted markup set.
AuditStatus:
type: object
properties:
unverifiedAuditReport:
type: boolean
description: Flag indicates whether an unverified audit report exists for
the case.
verifiedAuditReports:
type: array
description: The list of verified audit reports if it exists.
items:
type: string
auditReportFilename:
type: string
description: The filename of the unverified audit report if it exists.
creationDate:
type: integer
description: The creation date of the unverified audit report if it exists.
format: int64
ThumbnailUtilityRequest:
type: object
properties:
query:
type: string
description: A Nuix query to filter items.
dimensions:
type: array
description: A list of dimensions for the thumbnails to be generated. No
thumnails are generated if this is not set.
items:
$ref: '#/components/schemas/ThumbnailUtilityRequestDimension'
required:
- query
ThumbnailUtilityRequestDimension:
type: object
properties:
height:
type: integer
description: Height of the thumbnail as an integer representing number of
pixels.
format: int32
width:
type: integer
description: Width of the thumbnail as an integer representing number of
pixels.
format: int32
CaseModification:
type: object
properties:
method:
type: string
description: The method of case modification. Current this is only MIGRATE.
enum:
- MIGRATE
WordCountsRequest:
type: object
properties:
queryList:
type: array
description: The set of queries which will be executed.
items:
type: string
deduplication:
type: string
description: The deduplication to apply over each query. Defaults to 'none'
default: none
enum:
- none
- md5
field:
type: string
description: Specifies the field to search over each query. Defaults to all.
default: all
enum:
- content
- properties
- all
sort:
type: string
description: Sorts the results from most frequent to least frequent. Defaults to off.
default: off
enum:
- on
- off
minOccurs:
type: integer
description: Returns only results occurring at least this number of times.
format: int32
maxOccurs:
type: integer
description: Returns only results occurring at most this number of times.
format: int32
minWordLength:
type: integer
description: Limits results to words whose length is greater than or equal to this value.
format: int32
maxWordLength:
type: integer
description: Limits results to words whose length is less than or equal to this value.
format: int32
filter:
type: string
description: Limits results to words that match the filter. Default is 'all'
enum:
- all
- numeric
- aToZ
- foreign
- atypicalLength
default: all
maxResults:
type: integer
description: Limits the size of the returned list of word counts. Defaults to 200; use -1 for no limit.
format: int32
default: 200
WordCountsResponse:
type: object
properties:
word:
type: string
description: The word / term
count:
type: integer
description: The frequency of the word / term
format: int64
DeduplicationQueryListRequest:
type: object
properties:
queryList:
type: array
description: The set of queries which will be executed.
items:
type: string
deduplication:
type: string
description: The deduplication to apply over each query. Defaults to 'none'
default: none
enum:
- none
- md5
ItemSizeResponse:
type: object
properties:
query:
type: string
description: The specified query.
size:
type: integer
description: The relevant size.
format: int64
ItemSizesRequest:
type: object
properties:
queryList:
type: array
description: The set of queries which will be executed.
items:
type: string
deduplication:
type: string
description: The deduplication to apply over each query. Defaults to 'none'
default: none
enum:
- none
- md5
sizeType:
type: string
description: The size type to calculate.
enum:
- FILE_SIZE
- AUDIT_SIZE
FamilyStatisticsResponse:
type: object
properties:
query:
type: string
description: The specified query
auditSize:
type: integer
description: The total audit size of all family items
format: int64
itemCount:
type: integer
description: The total number of family items
format: int64
auditItemCount:
type: integer
description: The total number of family items which are audited (excludes immaterial items)
format: int64
CountResponse:
type: object
properties:
count:
type: integer
description: The count of the items in the query.
format: int64
query:
type: string
description: The query submitted.
casePath:
type: string
description: The absolute path of the case.
caseGuid:
type: string
description: The case identifier.
CustodianRequest:
type: object
properties:
name:
type: string
description: The name of the custodian.
description:
type: string
description: The description of the custodian.
CountRequest:
type: object
properties:
query:
type: string
description: Identifies what items should be returned. If a query is not supplied it defaults to an empty string, which returns all items.
CustomMetadataRequest:
type: object
properties:
fieldName:
type: string
description: The name of the custom metadata field
value:
type: object
description: The value of the custom metadata field
type:
type: string
description: The data type of the field
enum:
- integer
- float
- date-time
- text
- boolean
- binary
mode:
type: string
description: The custom metadata mode
enum:
- user
- api
params:
type: object
additionalProperties:
type: object
description: Any parameters required to parse the value field. params must contain a key "mimeType" with value being
the MIME type of the binary data being stored. The value must be a valid MIME type name known to Nuix.
required:
- fieldName
- value
- type
CustomMetadataFieldResponse:
type: object
properties:
fieldName:
type: string
description: fieldName
options:
type: array
description: The allowable option values
items:
type: object
type:
type: string
description: type
mode:
type: string
description: mode
defaultValue:
type: object
description: The default value
isNullAllowed:
type: boolean
description: true if a null value is allowed, false otherwise
CustomMetadataResponse:
type: object
properties:
fieldName:
type: string
description: The name of the custom metadata field
value:
type: object
description: The value of the custom metadata field
type:
type: string
description: The data type of the field
mode:
type: string
description: The custom metadata mode
template:
type: string
description: The name of the custom metadata template that applies to the
given custom metadata field
fieldTemplate:
$ref: '#/components/schemas/CustomMetadataFieldResponse'
BulkItemCustomMetadataRequest:
type: object
properties:
fieldName:
type: string
description: The name of the custom metadata field
value:
type: object
description: The value of the custom metadata field
type:
type: string
description: The data type of the field
enum:
- integer
- float
- date-time
- text
- boolean
- binary
mode:
type: string
description: The custom metadata mode
enum:
- user
- api
params:
type: object
additionalProperties:
type: object
description: Any parameters required to parse the value field. params must contain a key "mimeType" with value being
the MIME type of the binary data being stored. The value must be a valid MIME type name known to Nuix.
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
required:
- fieldName
- value
- type
ApplyCustomMetadataResponse:
type: object
properties:
failedItems:
type: array
description: List of item GUIDs that failed the operation
items:
type: string
successfulItems:
type: array
description: List of item GUIDs that succeeded during operation
items:
type: string
BulkItemCustomMetadataDeleteRequest:
type: object
properties:
fieldName:
type: string
description: The name of the custom metadata field
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
deduplication:
type: string
description: Deduplicate content. Defaults to none.
default: none
enum:
- none
- md5
- per custodian
relationType:
type: string
description: Result of the deduplicated query can be applied to related
items of the items. Options are 'topTypes', 'family', and 'descendants'
enum:
- family
- topTypes
- descendants
ExportOptions:
type: object
properties:
productOptions:
type: object
additionalProperties:
type: object
description: |
Adds a new type of file to produce as part of the export.
* `type` - The type of product to produce.
* `native` - Native files, including support for exporting mailboxes.
* `text` - Plain text files.
* `pdf` - PDF images.
* `tiff` - TIFF images.
* `xhtml_report` - XHTML metadata reports.
* `thumbnail` - Thumbnail files.
Supported options common to multiple product types.
* `naming` - Selects the type of naming to apply to the produced files
* `document_id` (e.g. `ABC-000000001.pdf`)
* `document_id_with_page` (e.g. `ABC-000000001_11.pdf`)
* `page_only` (e.g. `0001.pdf`)
* `full` (e.g. `ABC0010010001.pdf`)
* `full_with_periods` (e.g. `ABC.001.001.0001.pdf`)
* `item_name` (e.g. `original-name.pdf`)
* `item_name_with_path` (e.g. `mailbox/inbox/original-name.pdf`)
* `guid` (e.g. `04d/04dd8e72-f087-4f66-848a-6585bce732d5.pdf`)
* `md5` (e.g. `790/79054025255fb1a26e4bc422aef54eb4.pdf`)
Supported options for native files
* `mailFormat` - Selects the format for native exports of emails.
* `native` - exports emails in the format they are internally stored with no conversion.
* `eml` - converts all messages to RFC822 format.
* `html` - converts all messages to HTML format with headers written in.
* `mime_html` - converts all messages to MIME/HTML format with headers written in.
* `mime_html_mht` - converts all messages to MIME/HTML ( with extension "mht") format with headers written in.
* `msg` - converts all messages to Outlook MSG format.
* `dxl` - converts all messages to Lotus Notes DXL format.
* `mbox` - exports all messages into a single MBOX file.
* `pst` - exports all messages into a single PST file.
* `nsf` - exports all messages into a single NSF file.
* `includeAttachments` - If true, attachments will be left on email messages. If false, attachments will be stripped off.
* `regenerateStored` - If true, stored copies of binaries in the case will be regenerated.
Supported options for text files.
* `wrapLines` - Specifies the column to wrap text files at. If null, no wrapping will be performed.
* `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.
* `lineSeparator` - Selects the separators to place between each line of the text.
* `encoding` - The text files will be exported with the given encoding. Default "UTF-8".
Supported options for PDF files.
* `regenerateStored` - If true, stored copies of PDFs in the case will be regenerated. Default false.
Supported options for TIFF files.
* `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.
* `multiPageTiff` - Specifies whether to generate one TIFF file for each page (false) or all pages in one (true). Default false.
* `tiffDpi` - Specifies what DPI to use when generating TIFF images. Default 300.
* `72` - 72 dpi.
* `150` - 150 dpi.
* `200` - 200 dpi.
* `300` - 300 dpi.
* `tiffFormat` - Specifies what format the tiff files will be created in. Default "MONOCHROME_CCITT_T6_G4".
* `MONOCHROME_CCITT_T6_G4` - Black and white, CCITT T.6 Group 4 Fax Encoding.
* `GREYSCALE_UNCOMPRESSED` - Greyscale, uncompressed.
* `GREYSCALE_DEFLATE` - Greyscale, Zip compression.
* `GREYSCALE_LZW` - Greyscale, LZW compression.
* `COLOUR_UNCOMPRESSED` - Colour, uncompressed.
* `COLOUR_DEFLATE` - Color, zip compression.
* `COLOUR_LZW` - Color, LZW compression.
* `JPEG` - JPEG format with default compression and quality.
loadFileOptions:
type: object
additionalProperties:
type: object
description: |
Adds a new load file as a product of the export.
* `type` - The type of load file.
* `discover` - Discover.
* `ringtail` - Ringtail (MDB).
* `concordance` - Concordance.
* `summation` - Summation.
* `discovery_radar` - Discovery Radar.
* `documatrix` - DocuMatrix.
* `edrm_xml` - EDRM XML.
* `edrm_xml_zip` - EDRM v1.2 XML ZIP.
* `ipro` - IPRO.
* `xhtml_summary_report` - XHTML summary report.
* `csv_summary_report` - CSV summary report.
* `md5_digest` - MD5 digest report.
Supported options common to multiple load file types
* `metadataProfile` - Selects the metadata profile to use for additional metadata for this load file. If null, no extra metadata is used.
* `encoding` - Selects the encoding (character set) to use when writing the load file. Default "UTF-8". Used by Concordance.
* `lineSeparator` - Selects the separators to place between each line of text in the load file.
* `pathSeparator` - Selects the separators to use between directories when writing paths to exported files into the load file.
* `maxLoadFileSize` - DEPRECATED: Selects the maximum number of items written to a load file.
* `loadFileEntryLimit` - Selects the maximum number of items written to a load file.
* `loadFileByteLimit` - Selects the maximum size, in bytes, of each load file.
* `addressSeparator` - The separator of multiple addresses. Default ";".
* `compressOutput` - Whether the export output folder needs to be compressed. Default false.
Supported options for Ringtail (MDB)
* `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.
* `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.
* `removeCommas` - If true, commas will not be used in number fields. Default false.
* `directParent` - If true, the direct parent will be used for the host reference. Default false.
* `useDocumentId` - If true, the document id will be used for the page label. It is a property for Ringtail (MDB) only. Default false.
* `useNativePageCount` - If true, native page counts will be used for TIFFs in num_pages. It is a property for Ringtail (MDB) only. Default false.
* `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.
* `extrasFieldSeparator` - The separator of multi-value fields. Default ";".
Supported options for EDRM XML
* `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".
imagingOptions:
type: object
additionalProperties:
type: object
description: |
Sets the imaging options to use for the export.
* `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.
* `slipSheetContainers` - DEPRECATED: - Same as exportDescendantContainers since Nuix 7.2.
* `excelExportEngine` - Optionally select which export method to use for generating PDFs. Default "INTERNAL".
* `MS_OFFICE` - Export Excel documents using Microsoft Office.
* `INTERNAL` - Export Excel documents using the built in exporter.
* `excelPrintHiddenRows` - Optionally unhide all Excel rows.
* `excelPrintHiddenColumns` - Optionally unhide all Excel columns.
* `excelPrintHiddenWorksheets` - Optionally force hidden or very hidden Excel worksheets to be printed. Default "SHEET_VERY_HIDDEN".
* `SHEET_HIDDEN` - Show hidden worksheets.
* `SHEET_VERY_HIDDEN` - Show hidden and very hidden worksheets.
* `excelPrintComments` - Optionally set for Excel the way comments are printed with the sheet.
* `PRINT_IN_PLACE` - Print in original location.
* `PRINT_NO_COMMENTS` - Do not print.
* `PRINT_SHEETEND` - Print as end notes.
* `excelPrintNotes` - Optionally set for Excel cell notes to be printed as end notes with the sheet.
* excelPaperSize
* `PAPER_10x14` - 10 in. x 14 in.
* `PAPER_11x17` - 11 in. x 17 in.
* `PAPER_A3` - A3 (297 mm x 420 mm).
* `PAPER_A4` - A4 (210 mm x 297 mm).
* `PAPER_A4Small` - A4 Small (210 mm x 297 mm).
* `PAPER_A5` - A5 (148 mm x 210 mm).
* `PAPER_B4` - B4 (250 mm x 354 mm).
* `PAPER_B5` - A5 (148 mm x 210 mm).
* `PAPER_Csheet` - C size sheet.
* `PAPER_Dsheet` - D size sheet.
* `PAPER_Envelope10` - Envelope #10 (4-1/8 in. x 9-1/2 in.).
* `PAPER_Envelope11` - Envelope #11 (4-1/2 in. x 10-3/8 in.).
* `PAPER_Envelope12` - Envelope #12 (4-1/2 in. x 11 in.).
* `PAPER_Envelope14` - Envelope #14 (5 in. x 11-1/2 in.).
* `PAPER_Envelope9` - Envelope #9 (3-7/8 in. x 8-7/8 in.).
* `PAPER_EnvelopeB4` - Envelope B4 (250 mm x 353 mm).
* `PAPER_EnvelopeB5` - Envelope B5 (176 mm x 250 mm).
* `PAPER_EnvelopeB6` - Envelope B6 (176 mm x 125 mm).
* `PAPER_EnvelopeC3` - Envelope C3 (324 mm x 458 mm).
* `PAPER_EnvelopeC4` - Envelope C4 (229 mm x 324 mm).
* `PAPER_EnvelopeC5` - Envelope C5 (162 mm x 229 mm).
* `PAPER_EnvelopeC6` - Envelope C6 (114 mm x 162 mm).
* `PAPER_EnvelopeC65` - Envelope C65 (114 mm x 229 mm).
* `PAPER_EnvelopeDL` - Envelope DL (110 mm x 220 mm).
* `PAPER_EnvelopeItaly` - Envelope (110 mm x 230 mm).
* `PAPER_EnvelopeMonarch` - Envelope Monarch (3-7/8 in. x 7-1/2 in.).
* `PAPER_EnvelopePersonal` - Envelope (3-5/8 in. x 6-1/2 in.).
* `PAPER_Esheet` - E size sheet.
* `PAPER_Executive` - Executive (7-1/2 in. x 10-1/2 in.).
* `PAPER_FanfoldLegalGerman` - German Legal Fanfold (8-1/2 in. x 13 in.).
* `PAPER_FanfoldStdGerman` - German Legal Fanfold (8-1/2 in. x 13 in.).
* `PAPER_FanfoldUS` - U.S. Standard Fanfold (14-7/8 in. x 11 in.).
* `PAPER_Folio` - Folio (8-1/2 in. x 13 in.).
* `PAPER_Ledger` - Ledger (17 in. x 11 in.).
* `PAPER_Legal` - Legal (8-1/2 in. x 14 in.).
* `PAPER_Letter` - Letter (8-1/2 in. x 11 in.).
* `PAPER_LetterSmall` - Letter Small (8-1/2 in. x 11 in.).
* `PAPER_Note` - Note (8-1/2 in. x 11 in.).
* `PAPER_Quarto` - Quarto (215 mm x 275 mm).
* `PAPER_Statement` - Statement (5-1/2 in. x 8-1/2 in.).
* `PAPER_Tabloid` - Tabloid (11 in. x 17 in.).
* `excelPageOrientation` - Optionally set Excel page orientation (portrait or landscape) for every worksheet.
* `PORTRAIT` - Portrait mode.
* `LANDSCAPE` - Landscape mode.
* `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.
* `PERCENT_10` - 10%.
* `PERCENT_25` - 25%.
* `PERCENT_50` - 50%.
* `PERCENT_75` - 75%.
* `PERCENT_100` - 100%.
* `PERCENT_125` - 125%.
* `PERCENT_150` - 150%.
* `PERCENT_200` - 200%.
* `PERCENT_400` - 400%.
* `excelFitToPagesTall` - Optionally set for Excel the number of pages tall the worksheet will be scaled to when it's printed.
* `excelFitToPagesWide` - Optionally set for Excel the number of pages wide the worksheet will be scaled to when it's printed.
* `excelWorksheetPrintArea` - Optionally set Excel print area for every worksheet.
* `excelPageNumberLimit` - Optionally set the page number limit for Excel. The value must be a positive number.
* `excelPrintGridlines` - Optionally force Excel gridlines to be always shown or hidden.
* `excelPrintHeadings` - Optionally force Excel headers to be hidden or shown.
* `wordExportEngine` - Optionally select which export method to use for generating PDF's.
* `MS_OFFICE` - Export Word documents using Microsoft Office.
* `INTERNAL` - Export Word documents using the built in exporter.
* `wordShowMarkup` - Optionally force Word to show markup (such as track-changes) or hide it.
* `wordShowHiddenText` - Optionally force PowerPoint to show markup (such as track-changes or hidden text) or hide it.
* `powerPointExportEngine` - Optionally select which export method to use for generating PDF's. Note: Only PRINT_OUTPUT_SLIDES is supported for INTERNAL.
* `MS_OFFICE` - Export Powerpoint documents using Microsoft Office.
* `INTERNAL` - Export Powerpoint documents using the built in exporter.
* `powerPointPrintOutputType` - PRINT_OUTPUT_SLIDES A value that indicates which component (slides, handouts, notes pages, or an outline) of the presentation is to be printed.
* `PRINT_OUTPUT_BUILD_SLIDES` - Build Slides.
* `PRINT_OUTPUT_FOUR_SLIDE_HANDOUTS` - Four Slide Handouts.
* `PRINT_OUTPUT_NINE_SLIDE_HANDOUTS` - Nine Slide Handouts.
* `PRINT_OUTPUT_NOTES_PAGES` - Notes Pages.
* `PRINT_OUTPUT_ONE_SLIDE_HANDOUTS` - Single Slide Handouts.
* `PRINT_OUTPUT_OUTLINE` - Outline.
* `PRINT_OUTPUT_SIX_SLIDE_HANDOUTS` - Six Slide Handouts.
* `PRINT_OUTPUT_SLIDES` - Slides.
* `PRINT_OUTPUT_THREE_SLIDE_HANDOUTS` - Three Slide Handouts.
* `PRINT_OUTPUT_TWO_SLIDE_HANDOUTS` - Two Slide Handouts.
* `slipSheetMetadataProfile` - Optionally insert values from a metadata profile into generated slip-sheets.
numberingOptions:
type: object
additionalProperties:
type: object
description: |
* `createProductionSet` - Sets whether a production set should be created. Default true.
* `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 "."
* `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.
* `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.
* `prefix` - Specifies the prefix for numbering. If null, disables the prefix component.
* `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.
Settings for documentId components
* `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.
* `startAt` - Specifies the number to start at. Default 1.
Settings for formattedDocumentId components
* `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.
* `startAt` - Specifies the number to start at, and includes all the formatting characters in each document ID, e.g. "00.00.01". Default "1".
* `pageDelimiter` - Specifies the delimiter that will appear before individual page numbers. Default "_".
* `labelFirstPage` - Specifies whether the page number suffix will appear on the first page of a document. Default true.
Settings for box, folder, and page componenents
* `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.
* `from` - Specifies the lowest number in the sequence. When numbering wraps around, this becomes the next number. Default 1.
* `to` - Specifies the highest number in the sequence. Numbering will be wrapped around the next number after this number is used. Default 999.
* `startAt` - Specifies the number to start at. Default 1.
stampingOptions:
type: object
additionalProperties:
type: object
description: |
The stamping options.
Specifies the options for the respective stamping area of the page. Options supported inside the nested hash are detailed below.
* `headerLeft`, `headerCentre`, `headerRight`, `footerLeft`, `footerCentre`, `footerRight`
Supported options for stamper areas (headerLeft, footerCentre, etc.)
* `type` - Specifies what type of information to write into the stamper location.
* `name` - The name of the item.
* `guid` - The GUID of the item.
* `document_number` - The document number of the page of the item (changes each page.)
* `first_document_number` - The document number of the first page of the item.
* `page_number` - The number of the current page within the item.
* `page_count` - The count of all pages within the item.
* `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.
* `produced_by` - A string indicating the software producing the export products.
* `md5` - The MD5 digest for the item.
* `sha1` - The SHA-1 digest for the item.
* `sha256` - The SHA-256 digest for the item.
* `document_id` - The document ID of the item within the production set used to export.
* `production_set_name` - The name of the production set used to export.
* `custom` - custom text which will be the same for every item. Requires the customText option to be specified as well.
* `metadata` - reference to a metadata column by name. Requires either the metadataItem or metadataText option to be specified as well.
* `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).
* `metadataItem` - Specifies the metadata column to put in the header when type is "metadata".
* `metadataText` - DEPRECATED: metadataText is deprecated and replaced with metadataItem.
* `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.
* `family` - Specifies the font family by name.
* `style` - Specifies the style to use. If null, plain style will be used.
* `size` - Specifies the size to draw the text at.
* `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.
* `footerLine` - Default false.
* `increasePageSize` - Default false. Specifies whether to increase the size of the page to accommodate the header and footer.
traversalOptions:
type: object
additionalProperties:
type: object
description: |
Sets the traversal options to use for the export.
* `strategy` - Selects the method of selecting which items to export based on the items which are passed into exportItems. Default "items".
* `items` - Exports only the items specified.
* `items_and_descendants` - Exports the items specified, and any descendants.
* `top_level_items` - Exports the top-level items for the items specified.
* `top_level_items_and_descendants` - Exports the top-level items for the items specified, and any descendants of the top-level items.
* `deduplicated_top_level_items` - DEPRECATED - Same as "top_level_items" with deduplicate set to "md5".
* `deduplicated_top_level_items_and_descendants` - DEPRECATED - Same as "top_level_items_and_descendants" with deduplicate set to "md5".
* `deduplication` - Selects the method of deduplication to use when a top-level item export is being used. Default "none".
* `none` - Performs no deduplication.
* `md5` - Performs deduplication by md5.
* `per custodian` - Performs deduplication as md5 per custodian.
* `sortOrder` - Selects the method of sorting items during the export. Default "none" if strategy is "items", "position" otherwise.
* `none` - Exports the items in the original order. This order will only give sensible results if strategy is "items"
* `position` - Sorts by position.
* `top_level_item_date` - Sorts by top level item date.
* `top_level_item_date_descending` - Sorts by top level item date descending.
* `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.
* `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".
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.
* `resemblanceThreshold` - Specifies the resemblance threshold to use for the export of any metadata items that require the computation of (chained) near-duplicates.
promoteToDiscoverOptions:
type: object
additionalProperties:
type: object
description: |
Sets the options to promote to Nuix Discover.
* `caseId` - REQUIRED. The unique identifier of the Discover case.
* `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.
* `jobId` - The unique identifier of the job.
* `level` - The base name of the folder where the binaries will be uploaded to. For example, Promotions//.
* `docsPerLevel` - Number of documents per level. New sub-folders under level will be created once this limit is reached.
* `deduplication` - Whether or not Nuix Discover should deduplicate imported items.
ExportRequest:
type: object
properties:
id:
type: string
description: The folder ID. A folder with this ID will be created under
the export path
productionSets:
type: array
description: The production set GUIDs to export
items:
type: string
productTypes:
type: array
description: The list of product types. Defaults to [ "native" ].
items:
type: string
enum:
- native
- text
- pdf
- tiff
- xhtml_report
- thumbnail
default:
- native
loadFileTypes:
type: array
description: The load file types to add to the export. By default, no load
file types are selected
items:
type: string
enum:
- concordance
- summation
- discovery_radar
- documatrix
- edrm_xml
- ipro
- ringtail
- xhtml_summary_report
- csv_summary_report
queries:
type: array
description: The list of queries to export. Only applicable for ITEM exports
items:
type: string
exportType:
type: string
description: Defaults to ITEM
enum:
- item
- legal
default: item
path:
type: string
description: Root export path folder
exportOptions:
$ref: '#/components/schemas/ExportOptions'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
required:
- path
ParallelProcessingSettings:
type: object
properties:
workerCount:
type: integer
description: Number of worker processes to use. This defaults to number
of CPU cores on the machine. This value is also limited by settings in
the current licence / session.
format: int32
workerMemory:
type: integer
description: "Maximum amount of memory to allocate to each worker process
in megabytes. The provided value must be >= 768. Default is calculated
based on the number of workers and available machine memory."
format: int32
workerTemp:
type: string
description: Base directory that workers will use to store temporary files
generated during process. Can be a string file path, File, Path or URI.
The default is a directory under the case directory.
embedBroker:
type: boolean
description: If true, the JMS broker will be run within the current process,otherwise
it will be run in a new process. Default is true.
default: true
brokerMemory:
type: integer
description: Amount of memory to allocate to the JMS broker when it is run
in a separate process. The provided value must be >= 768. Default is
4096.
format: int32
default: 4096
workerBrokerAddress:
type: string
description: 'Worker broker address in the format host:port. '
useRemoteWorkers:
description: True to use remote workers when possible, false otherwise.
type: boolean
default: false
SlipsheetsRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
metadataProfile:
type: string
description: Defines the metadata profile to be used when generating slipsheets. Defaults
to no metadata profile.
PopulateStoresRequest:
type: object
properties:
itemGuids:
type: array
description: list of item GUIDs
items:
type: string
imagingProfileName:
type: string
description: Optional value, if not then default value is Default.
overwriteExisting:
type: boolean
description: If true, the items will be overwritten. Default is false.
populateBinaryStores:
type: boolean
description: If true, the binary store will be regenerated. If populateBinaryStores is false, then populatePrintedImageStores must be true.
populatePrintedImageStores:
type: boolean
description: If true, the printed store will be regenerated. If populatePrintedImageStores is false, then populateBinaryStores must be true.
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
BulkIngestionRequest:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
deprecated: true
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
repositories:
type: array
description: The list of evidence repositories to create
items:
$ref: '#/components/schemas/EvidenceRepository'
containers:
type: array
description: The list of evidence containers to create
items:
$ref: '#/components/schemas/EvidenceContainerWithTargets'
EvidenceContainerWithTargets:
type: object
properties:
name:
type: string
description: Sets the name for the evidence container that is created during
ingestion.
customMetadata:
type: object
additionalProperties:
type: string
description: Sets a map of custom metadata for the evidence container.
encoding:
type: string
description: Sets the encoding for the evidence container. If the encoding
is not set the default system encoding will be used.
custodian:
type: string
description: Sets the name of the initial custodian for the data.
timeZone:
type: string
description: Sets the time zone for the evidence container. If the time
zone is not set the system's default time zone will be used.
description:
type: string
description: Sets the description for the evidence container.
locale:
type: string
description: Sets the locale for the evidence container. Some file types
and named entities require a locale for them to be ingested accurately.
If not set then the system's default locale will be used. Format is that
required by IETF BCP 47 (e.g. 'en-US').
files:
type: array
description: A list of ingestible files to ingest.
items:
$ref: '#/components/schemas/IngestibleFile'
exchangeMailboxes:
type: array
description: A list of ingestible exchange mailboxes to ingest.
items:
$ref: '#/components/schemas/IngestibleExchangeMailbox'
s3Buckets:
type: array
description: A list of ingestible S3 buckets to ingest.
items:
$ref: '#/components/schemas/IngestibleS3Bucket'
sqlServers:
type: array
description: A list of ingestible SQL servers to ingest.
items:
$ref: '#/components/schemas/IngestibleSQLServer'
oracleServers:
type: array
description: A list of ingestible Oracle servers to ingest.
items:
$ref: '#/components/schemas/IngestibleOracleServer'
enterpriseVaults:
type: array
description: A list of ingestible enterprise vaults to ingest.
items:
$ref: '#/components/schemas/IngestibleEnterpriseVault'
sharepointSites:
type: array
description: A list of ingestible sharepoint sites to ingest.
items:
$ref: '#/components/schemas/IngestibleSharepoint'
mailStores:
type: array
description: A list of ingestible mail stores to ingest.
items:
$ref: '#/components/schemas/IngestibleMailStore'
loadFiles:
type: array
description: A list of ingestible load files to ingest.
items:
$ref: '#/components/schemas/IngestibleLoadFile'
centeraClusters:
type: array
description: A list of ingestible centera clusters to ingest.
items:
$ref: '#/components/schemas/IngestibleCenteraCluster'
splitFiles:
type: array
description: A list of ingestible split files to ingest.
items:
$ref: '#/components/schemas/IngestibleSplitFileList'
dropboxes:
type: array
description: A list of ingestible Dropbox accounts to ingest.
items:
$ref: '#/components/schemas/IngestibleDropbox'
sshServers:
type: array
description: A list of SSH-based servers to ingest.
items:
$ref: '#/components/schemas/IngestibleSSH'
twitterLocations:
type: array
description: A list of historical twitter locations to ingest.
items:
$ref: '#/components/schemas/IngestibleTwitter'
documentumServers:
type: array
description: A list of documentum servers to ingest.
items:
$ref: '#/components/schemas/IngestibleDocumentum'
ms365Locations:
type: array
description: A list of Microsoft 365 locations to ingest.
items:
$ref: '#/components/schemas/IngestibleMicrosoft365'
slackLocations:
type: array
description: A list of slack locations to ingest.
items:
$ref: '#/components/schemas/IngestibleSlack'
EvidenceRepository:
type: object
properties:
path:
type: string
description: The path of the evidence repository folder. Each folder or
file immediately inside this path will become a new evidence container.
custodianLevel:
type: integer
description: If custodian names are present in the repository, this is a
positive integer of the number of folder levels nesting inside the repository
where custodians are defined. For example custodianLevel = 1 indicates
that each folder immediately inside the repository folder is a custodian
name, while custodianLevel = 2 indicates that each folder nested two levels
inside the repository folder is a custodian name. If the repository does
not contain custodian names then this parameter can be either omitted
or set to -1.
default: -1
format: int32
evidenceContainerNaming:
type: string
enum:
- content
- numbered
default: content
description: If "content" then evidence containers created from folders or files
in the evidence repository will take their name from those folders and files
(this was the only behaviour prior to Nuix 6.2), if "numbered" then evidence
containers will be given sequentially numbered names instead.
evidenceContainerNamingPrefix:
type: string
description: If not null then all evidence containers created will have the given
prefix appended to the beginning of their name. For example to obtain Nuix's default
evidence naming scheme of "Evidence 1", "Evidence 2", "Evidence 3", etc you would use
evidenceContainerNamingPrefix="Evidence ",evidenceContainerNaming="numbered"
(note the trailing space in the prefix string).
timeZone:
type: string
description: Sets the repository time zone.
charset:
type: string
description: Sets the repository character set.
language:
type: string
description: Sets the repository language.
countryCode:
type: string
description: Sets the repository country code.
IngestibleCenteraCluster:
type: object
properties:
ipsFile:
type: string
description: Location of a file containing IP addresses separated by new-line
characters. Both File and String instances are supported.
clipsFile:
type: string
description: Location of a file containing Centera Clip IDs separated by
new-line characters. Both File and String instances are supported.
IngestibleDropbox:
type: object
properties:
authCode:
type: string
description: A string retrieved via a webpage on Dropbox that enables
access to an account. The account credentials are provided only to Dropbox.
To get the URL pass dropbox without this parameter, then get the authCode by
following the instructions at the URL provided in the MissingAccessTokenException
and invoke this method again using the retrieved authCode parameter. These codes
have an expiry time of the order of minutes.
team:
type: boolean
description: Whether or not a Dropbox team is being ingested. This optional parameter
should be present and set to true for all invocations when adding a Dropbox team to
evidence. It can be omitted to add an individual Dropbox account.
accessToken:
type: string
description: A string retrieved using the authCode that enables access to an account.
For dropbox, if the access token to an account is already known, provide it directly
using this parameter instead of authCode. This code doesn't expire unless the account
owner revokes access for Nuix.
IngestibleEnterpriseVault:
type: object
properties:
computer:
type: string
description: The hostname or IP address of the target server.
from:
type: string
description: This optional parameter limits the evidence to a date range
beginning from the specified date/time. It must be accompanied by the
'to' parameter. Accepted date formats are RFC-3339 or a simple date
format (yyyy-MM-dd) which will use the default timezone of the server.
format: date-time
to:
type: string
description: This optional parameter limits the evidence to a date range
ending at the specified date/time. It must be accompanied by the 'from'
parameter. Accepted date formats are RFC-3339 or a simple date
format (yyyy-MM-dd) which will use the default timezone of the server.
format: date-time
vault:
type: string
description: This optional parameter limits the evidence to the specified
Enterprise Vault vault.
archive:
type: string
description: This optional parameter limits the evidence to the specified
Enterprise Vault archive.
custodian:
type: string
description: This optional parameter limits the evidence to the specified
custodian or author.
keywords:
type: string
description: This optional parameter limits the evidence to results matching
Enterprise Vault's query using the words in this string. Subject and message/document
content are searched by Enterprise Vault and it will match any word in
the string unless specified differently in the flag parameter.
flag:
type: string
description: This optional parameter specifies how keywords are combined
and treated for keyword-based queries. It must be accompanied by the 'keywords'
parameter but will default to any if it is omitted. A value from any,
all, allnear, phrase, begins, beginany, exact, exactany, ends, endsany.
IngestibleExchangeMailbox:
type: object
properties:
username:
type: string
description: The username needed to access the server account.
password:
type: string
description: The password needed to access the server account.
uri:
type: string
description: Protocol, host, port and path can all be specified. For SharePoint
the address is the site address. For Exchange the address is the path
to the Exchange Web Service (e.g., https://ex2010/ews/exchange.asmx) and
it can be omitted to use auto-discovery based on the mailbox or username
address.
domain:
type: string
description: This optional parameter defines the Windows networking domain
of the server account.
to:
type: string
description: This optional parameter limits the evidence to a date range
ending at the specified date/time. It must be accompanied by the 'from'
parameter. Accepted date formats are RFC-3339 or a simple date
format (yyyy-MM-dd) which will use the default timezone of the server.
format: date-time
from:
type: string
description: This optional parameter limits the evidence to a date range
beginning from the specified date/time. It must be accompanied by the
'to' parameter. Accepted date formats are RFC-3339 or a simple date
format (yyyy-MM-dd) which will use the default timezone of the server.
format: date-time
mailbox:
type: string
description: The mailbox (specified by email address) to ingest if it differs
from the username.
impersonating:
type: boolean
description: Instructs Exchange to impersonate the mailbox user instead
of delegating when the mailbox and username are different. Defaults to
false.
mailboxRetrieval:
type: array
description: 'A list containing one or more of the following string values:
mailbox, archive, purges, deletions, recoverable_items, archive_purges,
archive_deletions, archive_recoverable_items, public_folders. Determines
whether to extract from the user''s mailbox, archive, recoverable items.'
items:
type: string
IngestibleFile:
type: object
properties:
path:
type: string
description: Absolute path to the directory or file to be ingested.
required:
- path
IngestibleLoadFile:
type: object
properties:
csvFile:
type: string
description: Location of a UTF-8 encoded CSV file containing an ITEMPATH
column with values containing relative paths to the native items. Currently
all other columns become metadata for that item. Not used if missing,
but one load file type is required.
idxFile:
type: string
description: Location of a UTF-8 encoded IDX file. Not used if missing,
but one load file type is required.
EvidenceContainer:
type: object
properties:
name:
type: string
description: Sets the name for the evidence container that is created during ingestion.
customMetadata:
type: object
additionalProperties:
type: string
description: Sets a map of custom metadata for the evidence container.
encoding:
type: string
description: Sets the encoding for the evidence container. If the encoding is not set the default system encoding will be used.
custodian:
type: string
description: Sets the name of the initial custodian for the data.
timeZone:
type: string
description: Sets the time zone for the evidence container. If the time zone is not set the system's default time zone will be used.
description:
type: string
description: Sets the description for the evidence container.
locale:
type: string
description: Sets the locale for the evidence container. Some file types
and named entities require a locale for them to be ingested accurately.
If not set then the system's default locale will be used. Format is that
required by IETF BCP 47 (e.g. 'en-US').
IngestibleMailStore:
type: object
properties:
protocol:
type: string
description: 'Mailstore protocol, supported values: pop, pops, imap, imaps, gwta.'
host:
type: string
description: The host server IP or hostname.
port:
type: integer
description: The port number.
format: int32
username:
type: string
description: The username for the mail store.
password:
type: string
description: The password.
IngestibleS3Bucket:
type: object
properties:
access:
type: string
description: This parameter specifies the access key ID for an Amazon Web
Service account.
secret:
type: string
description: This parameter specifies the secret access key for an Amazon
Web Service account.
bucket:
type: string
description: This optional parameter specifies a bucket and optionally a
path to a folder within the bucket that contains the evidence to ingest.
For example, 'com.nuix.mybucket/top folder/sub folder'. Omitting this
parameter will cause all buckets to be added to evidence.
endpoint:
type: string
description: This optional parameter specifies a particular Amazon Web Service
server endpoint. This can be used to connect to a particular regional
server e.g., https://s3.amazonaws.com.
useCredentialDiscovery:
type: boolean
description: Use credential discovery instead of anonymous access.
IngestibleSQLServer:
type: object
properties:
domain:
type: string
description: This optional parameter defines the Windows networking domain
of the server account.
username:
type: string
description: The username needed to access the server account.
password:
type: string
description: The password needed to access the server account.
computer:
type: string
description: The hostname or IP address of the target server.
instance:
type: string
description: This parameter specifies the database instance.
query:
type: string
description: This optional parameter specifies the SQL query used to filter
the content.
maxRowsPerTable:
type: integer
description: The maximum number of rows to return from each table or query. This parameter is optional. It can save time when processing tables
or query results with very many rows. The selection of which rows will be returned should be considered arbitrary.
IngestibleDocumentum:
type: object
properties:
domain:
type: string
description: This optional parameter defines the Windows networking domain of the server account.
username:
type: string
description: The username needed to access the server account.
password:
type: string
description: The password needed to access the server account.
port:
type: integer
description: The port number
default: 1489
query:
type: string
description: This optional parameter specifies a DQL (documentum) query used to filter the content.
server:
type: string
description: This parameter specifies the Documentum server address.
docBase:
type: string
description: This parameter specifies the Documentum docbase repository.
propertyFile:
type: string
description: This optional parameter specifies the Documentum property file.
IngestibleOracleServer:
type: object
properties:
username:
type: string
description: The username needed to access the server account.
password:
type: string
description: The password needed to access the server account.
database:
type: string
description: The hostname or IP address of the database server.
query:
type: string
description: This optional parameter specifies the SQL query used to filter
the content.
driverType:
type: string
description: This parameter specifies the driver type. See www.oracle.com
enum:
- thin
- oci
- kprb
role:
type: string
description: A string representation of the role to login as, such as SYSDBA or SYSOPER. For normal logins, this should be blank.
maxRowsPerTable:
type: integer
description: The maximum number of rows to return from each table or query. This parameter is optional. It can save time when processing tables
or query results with very many rows. The selection of which rows will be returned should be considered arbitrary.
format: int32
IngestibleSSH:
type: object
properties:
username:
type: string
description: The username needed to access the server account.
password:
type: string
description: The password needed to access the server account.
computer:
type: string
description: The hostname or IP address of the target server.
sudoPassword:
type: string
description: The password needed to access protected files when using SSH
key based authentication.
keyFolder:
type: string
description: Points to a folder on the local system which holds the SSH
authentication key pairs.
portNumber:
type: integer
description: The port number to connect on.
format: int32
hostFingerprint:
type: string
description: The expected host fingerprint for the host being connected
to. If this value is not set then any host fingerpint will be allowed,
leaving the possibility of a man in the middle attack on the connection.
remoteFolder:
type: string
description: This optional parameter limits the evidence to items underneath
this starting folder.
accessingRemoteDisks:
type: boolean
description: When set to true remote disks (e.g. '/dev/sda1') will be exposed
as evidence instead of the remote system's file system structure.
initialLocation:
type: string
description: Sets the location to use local disks with initial location.
IngestibleTwitter:
type: object
properties:
accessToken:
type: string
description: The access token of your twitter app. You can create a new app at https://apps.twitter.com and generate this if you don't have one already.
accessTokenSecret:
type: string
description: The access token secret of your twitter app. You can create a new app at https://apps.twitter.com and generate this if you don't have one already.
consumerKey:
type: string
description: The consumer key (API key) of your twitter app. You can create a new app at https://apps.twitter.com and generate this if you don't have one already.
consumerSecret:
type: string
description: The consumer secret (API secret) of your twitter app. You can create a new app at https://apps.twitter.com and generate this if you don't have one already.
IngestibleSharepoint:
type: object
properties:
domain:
type: string
description: This optional parameter defines the Windows networking domain
of the server account.
username:
type: string
description: The username needed to access the server account.
password:
type: string
description: The password needed to access the server account.
uri:
type: string
description: Protocol, host, port and path can all be specified. For SharePoint
the address is the site address. It can be omitted to use auto-discovery based
on site address.
IngestibleSplitFileList:
type: object
properties:
files:
type: array
description: The list of files to add. Absolute paths are recommended.
items:
type: string
IngestibleMicrosoft365:
type: object
properties:
tenantId:
type: string
description: The tenant ID for the Azure Active Directory tenant.
clientId:
type: string
description: The client/application ID for an app that has been registered with your Azure Active Directory tenant and granted the necessary privileges.
clientSecret:
type: string
description: The client secret that has been configured for the clientId provided, for authentication.
username:
type: string
description: The optional username for a user that is a member of the Teams to be processed, only needed for ingesting Team Calendars.
password:
type: string
description: The password for the username if it is present.
certificateStorePath:
type: string
description: The path to a PKCS#12 certificate store, usable instead of clientSecret for authentication.
certificateStorePassword:
type: string
description: The password to the PKCS#12 certificate store.
from:
type: string
format: date-time
description: Sets the start date on the location. The start date and end date are both required, and if retrievals(Collection) includes
USERS_CALENDARS or TEAMS_CALENDARS, then the date range cannot exceed five years. Accepted date formats are RFC-3339 or a simple date
format (yyyy-MM-dd) which will use the default timezone of the server.
to:
type: string
format: date-time
description: Sets the end date on the location. The start date and end date are both required, and if retrievals(Collection) includes
USERS_CALENDARS or TEAMS_CALENDARS, then the date range cannot exceed five years. Accepted date formats are RFC-3339 or a simple date
format (yyyy-MM-dd) which will use the default timezone of the server.
retrievals:
type: array
description: Sets the content to be retrieved from Microsoft Graph. Available options are
TEAMS_CHANNELS, TEAMS_CALENDARS, USERS_CHATS, USERS_CONTACTS, USERS_CALENDARS, USERS_EMAILS, ORG_CONTACTS, SHAREPOINT
items:
type: string
enum:
- TEAMS_CHANNELS
- TEAMS_CALENDARS
- USERS_CHATS
- USERS_CONTACTS
- USERS_CALENDARS
- USERS_EMAILS
- ORG_CONTACTS
- SHAREPOINT
mailFolderRetrievals:
type: array
description: Sets the mail folder retrieval areas for Exchange Online.
items:
type: string
enum:
- ALL
- MAILBOX_ALL
- RECOVERABLE_ITEMS_ALL
- ARCHIVE
- CLUTTER
- CONVERSATION_HISTORY
- DELETED_ITEMS
- DRAFTS
- INBOX
- JUNK
- OUTBOX
- SENT_ITEMS
- SYNC_ISSUES
- OTHER
- RECOVERABLE_ITEMS_DELETIONS
- RECOVERABLE_ITEMS_PURGES
- RECOVERABLE_ITEMS_DISCOVERY_HOLDS
- RECOVERABLE_ITEMS_SUBSTRATE_HOLDS
- RECOVERABLE_ITEMS_OTHER
mailboxRetrievals:
type: array
deprecated: true
description: list of possible areas to retrieve from. Defaults to [ "MAILBOX" ]. Possible values MAILBOX, ARCHIVE, PURGES, DELETIONS, RECOVERABLE_ITEMS,
ARCHIVE_PURGES, ARCHIVE_DELETIONS, ARCHIVE_RECOVERABLE_ITEMS, PUBLIC_FOLDERS.
default:
- MAILBOX
items:
type: string
enum:
- MAILBOX
- ARCHIVE
- PURGES
- DELETIONS
- RECOVERABLE_ITEMS
- ARCHIVE_PURGES
- ARCHIVE_DELETIONS
- ARCHIVE_RECOVERABLE_ITEMS
- PUBLIC_FOLDERS
teamNames:
type: array
description: Sets the team names on the location.
items:
type: string
userPrincipalNames:
type: array
description: Sets the user principal names on the location.
items:
type: string
versionFilters:
$ref: '#/components/schemas/Microsoft365VersionFilterOptions'
licenseModel:
description: The payment models and licensing requirements for Microsoft Teams APIs in Microsoft Graph. If not provided, evaluation
mode will be used. Model 'A' is restricted to applications performing a security or compliance function. Model 'B' is restricted to applications
that don't perform a security or compliance function. Please see https://learn.microsoft.com/en-us/graph/teams-licenses for
more information regarding Microsoft Teams APIs.
type: string
enum:
- A
- B
required:
- tenantId
- clientId
- from
- to
IngestibleSlack:
type: object
properties:
tempAuthCode:
type: string
description: The temporary authorization code obtained from Slack's OAuth flow. Not required if storedCredentialName is provided.
storedCredentialName:
type: string
description: The name of the slack credentials stored in credentials store. Not required if tempAuthCode is provided.
from:
type: string
format: date-time
description: Sets the start date on the location. The start date and end date are both required, and if retrievals(Collection) includes
USERS_CALENDARS or TEAMS_CALENDARS, then the date range cannot exceed five years. Accepted date formats are RFC-3339 or a simple date
format (yyyy-MM-dd) which will use the default timezone of the server.
to:
type: string
format: date-time
description: Sets the end date on the location. The start date and end date are both required, and if retrievals(Collection) includes
USERS_CALENDARS or TEAMS_CALENDARS, then the date range cannot exceed five years. Accepted date formats are RFC-3339 or a simple date
format (yyyy-MM-dd) which will use the default timezone of the server.
userIds:
type: array
description: The Set of user IDs to filter Slack messages and files from.
items:
type: string
Microsoft365VersionFilterOptions:
type: object
description: The version filter options.
properties:
versionRetrievalEnabled:
type: boolean
description: True if all versions should be retrieved, false for current version only.
default: false
versionRetrievalLimit:
type: integer
description: Integer value limiting the number of versions retrieved if versionRetrievalEnabled is set to true. -1 (all available versions)
KeyStoreKeyParameters:
type: object
properties:
filePassword:
type: string
description: Specifies the password protecting the file (e.g. for PKCS#12)
keyPasswords:
type: object
additionalProperties:
type: string
description: Specifies the passwords protecting individual keys when extracting
multiple password-protected keys from a single file.
target:
type: string
description: For Lotus Notes ID files, this value should contain the file
name of the NSF file protected by this key.
keystoreName:
type: string
description: The name of the keystore file being used.
MimeTypeProcessingSetting:
type: object
properties:
mimeType:
type: string
description: Sets the MIME type
settings:
$ref: '#/components/schemas/MimeTypeSpecificProcessingSettings'
MimeTypeSpecificProcessingSettings:
type: object
properties:
enabled:
type: boolean
description: Controls whether items matching this MIME type, and their embedded
descendants, will be processed. Default is true
processEmbedded:
type: boolean
description: Controls whether embedded descendants matching this MIME type
will be processed. Default is true
processText:
type: boolean
description: Controls whether items matching this MIME type will have their
text processed. This setting takes precedence over 'textStrip' if both
are set to true. Set this and 'textStrip' to false in order to skip text
processing. Default is true
textStrip:
type: boolean
description: Controls whether items matching this MIME type will have their
binary data text stripped. Set this and 'processText' to false in order
to skip text processing. Default is false
processNamedEntities:
type: boolean
description: Controls whether items matching this MIME type will have their
named entities processed. This setting only takes effect if either 'extractNamedEntitiesFromText'
or 'extractNamedEntitiesFromProperties' is enabled in 'ProcessorSettings'.
Default is true
processImages:
type: boolean
description: Controls whether items matching this MIME type will have their
image data processed. This setting only takes effect if 'createThumbnails'
is enabled in 'ProcessorSettings'. Default is true
storeBinary:
type: boolean
description: Controls whether items matching this MIME type will have their
binary data stored. This setting only takes effect if 'storeBinary' is
enabled in 'ProcessorSettings'. Default is true
NamedEntity:
type: object
properties:
regularExpression:
type: string
description: Gets the regular expression used by the entity.
name:
type: string
description: Gets the name of the entity.
PasswordDiscoverySettings:
type: object
properties:
mode:
type: string
description: Sets password discovery settings to use for encrypted items.
enum:
- none
- word_list
wordList:
type: string
description: The name of a word list accessible in the system. If the mode is set to "word-list",
then this word-list will be used as the basis for password discovery
ProcessorSettings:
type: object
properties:
processText:
type: boolean
description: If true, stores and indexes the text of data items. Default
is true.
default: true
traversalScope:
type: string
description: |
Selects the traversal scope for ingestion.
* `full_traversal` - Processes all items and their descendants during processing except where specific MIME type settings apply.
* `loose_files` - Processes loose files but not their contents.
* `loose_files_and_forensic_images` - Processes loose files and forensic images but not their contents. This can be used to 'explode' forensic
images without processing all the files inside. Note: `identifyPhysicalFiles` must be set to true to explode forensic images.
enum:
- full_traversal
- loose_files
- loose_files_and_forensic_images
processLooseFileContents:
type: boolean
description: If true, the contents of loose files will be extracted and
processed. If false metadata about loose files will be extracted but their
contents will not be processed. Default is true. Deprecated in Nuix 7.0,
eplaced with traversalScope.
deprecated: true
default: true
processForensicImages:
type: boolean
description: If true, the contents of forensic images will be exposed. If
false metadata about forensic images will be extracted but their contents
will not be processed. This settings can be used in combination with processLooseFileContents
to explode forensic images but not process their contents. Default is
true. Deprecated in Nuix 7.0, replaced with traversalScope.
deprecated: true
default: true
analysisLanguage:
type: string
description: 'Specifies the language to use for text analysis when indexing.
A supported language code. Example codes are: "en" - English, "ja" - Japanese. Default is
"en".'
default: "en"
stopWords:
type: boolean
description: If true, removes English stop words ("a", "and", "the", etc.)
from the text index. If false, no stop words are removed. Default is false.
default: false
stemming:
type: boolean
description: If true, stems words using English rules before indexing (e.g.
"fishing" -> "fish".). If false, no stemming is performed. Default is
false.
default: false
enableExactQueries:
type: boolean
description: If true, enables search using "exact" queries. Default is
false.
default: false
extractNamedEntities:
type: boolean
description: 'If true, extract named entities from the text of a document. Default
is false. NOTE: This is deprecated and will be removed in future release. Deprecated in Nuix 6.0.'
deprecated: true
default: false
extractNamedEntitiesFromText:
type: boolean
description: If true, extracts named entities from the text of a document. Default
is false
default: false
extractNamedEntitiesFromProperties:
type: boolean
description: If true, extracts named entities from the properties of a document. Default
is false
default: false
extractNamedEntitiesFromTextStripped:
type: boolean
description: If true, extracts named entities from the text of text-stripped
items, if and only if 'extractNamedEntitesFromText' is true. The 'extractNamedEntitiesFromProperties'
setting is independent of this property. Default is false
default: false
extractNamedEntitiesFromTextCommunications:
type: boolean
description: If true, extract named entities from the communication metadata of a document. Default is false.
default: false
extractShingles:
type: boolean
description: If true, extract shingles from item text. Enabling this setting
enables near deduplication. Default is true.
default: true
processTextSummaries:
type: boolean
description: If true, process item text and summarise. Default is true.
default: true
calculateSSDeepFuzzyHash:
type: boolean
description: If true, calculate SSDeep fuzzy hash values for item. Default
is false.
default: false
calculatePhotoDNARobustHash:
type: boolean
description: If true, calculate PhotoDNA robust hash values for image items.
default: false
detectFaces:
type: boolean
description: If true, detect faces in photographic items. Default is false.
default: false
classifyImagesWithDeepLearning:
type: boolean
description: "If true, classify images using Deep Learning. Requires additional following settings: imageClassificationModelUrl. Default is false."
default: false
imageClassificationModelUrl:
type: string
description: URL pointing to Deep Learning model - can be a local file too, but in URL format (file://path/to/model).
extractFromSlackSpace:
type: boolean
description: If true, extract deleted data from mailbox file formats and
slack space from the end of file records in file system disk images. Default
is false.
default: false
carveFileSystemUnallocatedSpace:
type: boolean
description: If true, carve data out of file system unallocated space for
disk images. Default is false.
default: false
carveUnidentifiedData:
type: boolean
description: If true, carve data out of unidentified data items. Default
is false.
default: false
carvingBlockSize:
type: integer
description: If null, the block size of the file system is used. Otherwise
the given block size is used. File identification is attempted at start
of each block, so the smaller the value the longer processing will take.
Avoid values smaller than 512 bytes except in specific cases. Default
is null.
format: int32
recoverDeletedFiles:
type: boolean
description: If true, recover deleted file records from disk images. Default
is true.
default: true
extractEndOfFileSlackSpace:
type: boolean
description: If true, extract the slack space from the end of file records
in disk images. Default is false.
default: false
smartProcessRegistry:
type: boolean
description: If true, only process sections of the Registry that have decoders
of have been explicitly selected. Default is false
default: false
identifyPhysicalFiles:
type: boolean
description: If false, only file system metadata is extracted for physical
files on disk. Default is true.
default: true
createThumbnails:
type: boolean
description: If true, create and store thumbnails of image data items. Default
is true.
default: true
skinToneAnalysis:
type: boolean
description: If true, perform analysis on images to detect skintones. Default
is false.
default: false
calculateAuditedSize:
type: boolean
description: If true, calculates audited size. Default is false.
default: false
storeBinary:
type: boolean
description: If true, store the binary of data items. Default is false.
default: false
maxStoredBinarySize:
type: integer
description: Specifies the maximum size of binary which will be stored into
the binary store, in bytes. Default is 250000000 (250 MB).
default: 250000000
format: int32
maxDigestSize:
type: integer
description: Specifies the maximum size of binary which will be digested,
in bytes. Default is 250000000 (250 MB).
default: 250000000
format: int64
digests:
type: array
description: A list of digests to calculate. Valid values "MD5", "SHA-1" or "SHA-256". Default is [ "MD5" ].
default:
- MD5
items:
type: string
addBccToEmailDigests:
type: boolean
description: If true, adds the Bcc field when computing email digests. Using
the Bcc field in email digests may prevent the sender and recipients digests
from matching. This is because only the sender will have the Bcc field
if it is present. Default is false.
default: false
addCommunicationDateToEmailDigests:
type: boolean
description: If true, adds the communication date when computing email digests.
Using the communication date in the email digests may prevent the sender
and recipients digests from matching. This is because the sender and recipients
communication date / times can be slightly different for the same email.
Default is false.
default: false
reuseEvidenceStores:
type: boolean
description: If true, existing evidence stores are used to add any additional
data into. Default is false.
default: false
processFamilyFields:
type: boolean
description: If true, top-level items will contain search fields containing
text from their family. Default is false.
default: false
hideEmbeddedImmaterialData:
type: boolean
description: If true, hides embedded immaterial data items such as embedded
images in documents. Default is false.
default: false
reportProcessingStatus:
type: string
description: If "physical_files", then the total evidence physical file
size is calculated before processing starts. If "none", then no up-front
calculation is performed. Non-file data will always be treated as "none".
Default is none.
default: none
enableCustomProcessing:
type: array
description: Which aspects of the data to expose in the callback from whenItemProcessed(ItemProcessedCallback). They are accessible from
ProcessedItem.getProperties(), ProcessedItem.getTextFile() and ProcessedItem.getBinaryFile() respectively. All other processing options will be
skipped when this option is enabled.
items:
type: string
enum:
- properties
- binary
- text
workerItemCallback:
type: string
description: A string prefixed with "java:" followed by the name of a class
with a no argument constructor which implements Consumer, or the name
of a scripting engine followed by a colon character follow by the script to execute.
Example scripting engine names include "ruby", "python" and "ecmascript". For
scripting languages, this string is the actual script code.
workerItemCallbacks:
type: array
description: A list of strings specifying worker scripts. See workerItemCallback for script details. Scripts are processed in list order.
items:
type: string
performOcr:
type: boolean
description: If true, performs the OCR on the items based on the selected OCR profile. Default is false.
default: false
ocrProfileName:
type: string
description: This must be set to an OCR profile name that exists.
default: Default
createPrintedImage:
type: boolean
description: If true, creates a printed image for items based on an imaging profile. Default is false.
default: false
imagingProfileName:
type: string
description: If createPrintedImage is set to true, this specifies the name of the imaging profile to use during processing. This must be set to the
name of an existing imaging profile that can be reached within the current context.
default: Processing Default
exportMetadata:
type: boolean
description: If true, exports an item's metadata using a given metadata export profile. Default is false.
default: false
metadataExportProfileName:
type: string
description: If exportMetadata is set to true, this specifies the name of the metadata export profile to use during processing. This must be set
to the name of a metadata export profile that can be reached within the current context.
namedEntities:
type: array
description: Passes in the list of named entities to be used in processing. If null, the default named entity settings are used.
items:
$ref: '#/components/schemas/NamedEntity'
RescanEvidenceRepositoriesSettings:
type: object
description: Settings when rescanning the case's evidence repositories.
properties:
depth:
type: integer
description: Maximum depth of directories to be rescanned.
format: int32
SingleRepositoryIngestionRequest:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
repository:
$ref: '#/components/schemas/EvidenceRepository'
SingleContainerIngestionRequestIngestibleFile:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleFile'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleLoadFile:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleLoadFile'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleMailStore:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleMailStore'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleExchangeMailbox:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleExchangeMailbox'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleSharepoint:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleSharepoint'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleSQLServer:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleSQLServer'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleOracleServer:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleOracleServer'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleEnterpriseVault:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleEnterpriseVault'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleS3Bucket:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleS3Bucket'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleCenteraCluster:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleCenteraCluster'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleSplitFileList:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleSplitFileList'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleDropbox:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleDropbox'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleSSH:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
type: boolean
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleSSH'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleTwitter:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleTwitter'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleMicrosoft365:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleMicrosoft365'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleSlack:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleSlack'
container:
$ref: '#/components/schemas/EvidenceContainer'
SingleContainerIngestionRequestIngestibleDocumentum:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
deprecated: true
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
target:
$ref: '#/components/schemas/IngestibleDocumentum'
container:
$ref: '#/components/schemas/EvidenceContainer'
ReloadItemsIngestionRequest:
type: object
properties:
processorSettings:
$ref: '#/components/schemas/ProcessorSettings'
mimeTypeProcessorSettings:
type: array
description: Sets the processing settings for individual mime types.
items:
$ref: '#/components/schemas/MimeTypeProcessingSetting'
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
keystoreKeyParameters:
type: array
description: Sets the settings used to apply a keystore file to the ingestion.
items:
$ref: '#/components/schemas/KeyStoreKeyParameters'
rescanEvidenceRepositories:
type: boolean
description: If true, the case's Evidence Repositories will be rescanned
to discover new Evidence Containers within them and new files within existing
Evidence Containers which are themselves within the cases's Evidence Repositories.
Default is false.
rescanEvidenceRepositoriesSettings:
$ref: '#/components/schemas/RescanEvidenceRepositoriesSettings'
passwordDiscoverySettings:
$ref: '#/components/schemas/PasswordDiscoverySettings'
configurationProfile:
type: string
description: Deprecated in favor of processingProfile. Configuration profile
to use as base set of processor, parallel processing, and mime type settings. Values
present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings
will override anything defined by this profile.
processingProfile:
type: string
description: The name of the Processing Profile to use. If you use this
setting then do not use any other settings from processorSettings as everything
will be overridden by the loaded Processing profile.
query:
type: string
description: All items matching the query will be reloaded from source.
CaseDigest:
type: object
properties:
caseId:
type: string
description: The case's unique identifier
name:
type: string
description: The case name
path:
type: string
description: The path to the case
description:
type: string
description: The case description
investigator:
type: string
description: The investigator for this case
creationDate:
type: integer
description: The date/time this case was created, in milliseconds since
epoch
format: int64
compound:
type: boolean
description: Whether this case is Simple or Compound
elastic:
type: boolean
description: Whether this is an Elastic case
binaryStoreLocation:
type: string
description: The binary store location for this case, if applicable
indexId:
type: string
description: The index id
productName:
type: string
description: The name of the product that created / opened this case
version:
type: string
description: The version of Nuix that most recently opened this case
isOpen:
type: boolean
description: Whether or not this case is currently open, which means something
in REST is working with this case
childCases:
type: array
description: The child cases of this case, when applicable. If the child
case is known to this REST instance then the value will be the child case's
GUID. Otherwise it will be the absolute path to the child case
items:
type: string
url:
type: string
description: The URL of the REST instance that contains this case
serverId:
type: string
description: The Server ID of the REST instance that contains this case
ItemTextResponse:
type: object
properties:
text:
type: string
description: text
binaryAvailable:
type: boolean
description: binaryAvailable
htmlEscape:
type: boolean
description: htlmEscape
totalTextLength:
type: integer
description: The total length of the text.
format: int64
blank:
type: boolean
description: blank
SearchHitRequest:
type: object
properties:
query:
type: string
description: Search hits query. If a query is not supplied, it defaults to an empty string which will not return search hits.
SearchHit:
type: object
properties:
term:
type: string
description: Search hit term.
count:
type: integer
description: The number of occurrances for this term
format: int32
SearchHitResponse:
type: object
properties:
terms:
uniqueItems: true
type: array
description: Set of matching terms
items:
type: string
text:
uniqueItems: true
type: array
description: Set of search hits matching the text content
items:
$ref: '#/components/schemas/SearchHit'
properties:
type: object
additionalProperties:
type: object
description: Map containing the set of search hits by property name. Objects
are map[string, array[SearchHit]
ItemCommentRequest:
type: object
properties:
itemComment:
type: string
description: Comments about the item.
required:
- itemComment
ItemCommentResponse:
type: object
properties:
itemGuid:
type: string
description: The guid of the item.
itemComment:
type: string
description: Comments for this item
ItemCustodianRequest:
type: object
properties:
itemCustodian:
type: string
description: Custodian for the item.
required:
- itemCustodian
ItemGuids:
type: object
properties:
itemGuids:
type: array
description: list of item GUIDs
items:
type: string
required:
- itemGuids
GenericItemGuidResponse:
type: object
properties:
itemGuids:
type: array
description: complete list of item GUIDs
items:
type: string
successfulItemGuids:
type: array
description: list of item GUIDs successfuly completed the operation
items:
type: string
failedItemGuids:
type: array
description: list of item GUIDs failed the to complete the operation
items:
type: string
ItemCustodianResponse:
type: object
properties:
itemGuid:
type: string
description: The guid of the item.
itemCustodian:
type: string
description: Custodian for this item
ItemsShinglesRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items.
deduplication:
type: string
description: deduplication. Default is 'none'.
default: none
enum:
- md5
- per custodian
- none
maxItems:
type: integer
description: maxItems. Default is 1000 items.
default: 1000
format: int32
maxShingleResponse:
type: integer
description: The maximum number of shingles to return. Default is 100 shingles.
default: 100
format: int32
ItemMarshallingOptions:
type: object
properties:
caseId:
type: string
description: The case identification token.
query:
type: string
description: Identifies what items should be returned if the endpoint can make use of a query.
startIndex:
type: integer
description: The index of the first record that should be returned. Defaults to 0.
format: int32
default: 0
numberOfRecordsRequested:
type: integer
description: Number of records to return, defaults to 100.
format: int32
default: 100
deduplication:
type: string
description: Deduplicate content. Defaults to none.
default: none
enum:
- none
- md5
- per custodian
metadataProfile:
type: string
description: Defines the metadata profile to be appied to the results. Needed to get custom metadata. Defaults to no metadata profile.
fieldList:
type: array
description: |
Use this operation to search a case. For large query strings, use the POST method.
Use the following supported fields in the fieldList:
* `all` - Returns all fields for the item.
* `auditedSize` - Returns the item''s audited size.
* `children` - Returns a list of the item''s children.
* `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.
* `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.
* `comment` - Returns item comments.
* `communication` - If the item is a communication, this returns item communication information.
* `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.
* `custodian` - Returns the custodian assigned to an item.
* `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.
* `date` - Returns the item date.
* `descendants` - Gets the list of items which are descendants of this item.
* `digests` - Returns a map of the computed digests for an item.
* `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.
* `duplicates` - Returns duplicates of this item.
* `evidenceMetadata` - Returns custom evidence metadata for the item.
* `exclusion` - Returns the reason for an item''s exclusion.
* `family` - Returns a list of items in the same family.
* `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.
* `fileType` - Returns the name of the file type.
* `guid` - Returns the item''s globally unique identifier (GUID).
* `history` - Returns the item''s history in ascending order by date.
* `id` - Returns the item''s ID.
* `isAudited` - Tests whether the item is considered audited and returns true or false.
* `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it. This returns
true if the item had binary data at processing time that was not stored. This
differs from isStored() as this method returns true if the item had binary
data at processing time that was not stored.
* `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned
if stored binary exists. In this case, the source data isn''t required for
binary export.
* `isChatMessage` - Tests whether the item is a chat message.
* `isChatConversation` - Tests whether the item is a chat conversation.
* `isDeleted` - Tests whether the item was marked as deleted and returns true or false.
* `isEmailThreadMember` - Tests whether the item is part of an email thread.
* `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.
* `isExcluded` - Tests whether the item was marked as excluded.
* `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).
* `isIncuded` - Tests whether the item is included and returns true or false.
* `isLooseFile` - Tests whether the item is a loose file and returns true or false.
* `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.
* `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field
is useful when you only need to know if a printed image exists for this item.
This is faster and uses fewer resources than requesting the printedImageInfo
field.
* `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.
* `isTextStored` - Tests hether the item has text stored against it in the database. In the event
where you only want to know if the item had text but didn''t need the text
this field is considerably faster and more conservative of resources than
isTextAvailable.
* `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.
* `isTopLevel` - Tests whether this is a top-level item and returns true or false.
* `itemCategory` - Returns the item category.
* `kind` - Returns the item kind.
* `language` - Returns the language identified by the item.
* `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])
if the name is blank.
* `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.
* `name` - Returns the item name.
* `originalExtension` - Returns the original extension listed on the source file.
* `parent` - Returns the parent of this item.
* `path` - Returns an item list which represents the path from the root evidence container to the item.
* `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.
* `pathNames` - Returns a list of item names on the path from the root evidence container to the item.
* `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.
* `printedImageInfo` - Returns information about the printed image.
* `properties` - Returns item properties.
* `root` - Returns the root item. If this item is the root, the item itself is returned.
* `rootUri` - Returns the item''s root URI as a string.
* `tags` - Returns the item tags.
* `text` - Returns the text of the item as a string.
* `textHtml` - Returns the text of the item escaped for HTML.
* `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.
* `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.
* `threadItems` - Returns items that are in the same discussion thread as this item.
* `topLevelItem` - Returns the associated top-level item.
* `topLevelItemDate` - Returns the associated top-level item date.
* `type` - Returns the type name.
* `typeLocalisedName` - Returns the type name, localised appropriately for display to users.
* `uri` - Returns the item''s uniform resource identifier (URI) as a string.
items:
type: string
customMetadataList:
type: array
description: List of custom metadata fields to be returned for each item in the results.
items:
type: string
propertyList:
type: array
description: List of properties to be returned for each item in the results.
items:
type: string
itemParameterizedFields:
type: array
description: Specifies parameterized fields in a key/value pair separated by a colon.
* `entities` - corresponds to item.getEntities. (e.g., "entities:company")
* `serializedItem` - returns a serialized copy of the item. (e.g., "seralizedItem:topLevelItem")
* `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., "textTruncated:10000")
* `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., "thumbnail:200x200")
* `nearDupeThreshold` - (e.g., "nearDupeThreshold:0.9")
* `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., "emailThreadCluster:cluster-1")
items:
type: string
sortField:
type: string
description: Any field in the metadata profile which you want to sort by.
sortOrder:
type: string
description: Sets the sort order for the results. Defaults to "ASC".
enum:
- asc
- desc
default: asc
s:
type: integer
description: The index of the first record that should be returned. Maintained for backward compatibility.
format: int32
deprecated: true
p:
type: integer
description: The number of records that should be returned. Defaults to 100 records. Maintained for backward compatibility.
format: int32
deprecated: true
MarshalledItems:
type: object
properties:
request:
$ref: '#/components/schemas/ItemMarshallingOptions'
metadataItems:
type: array
description: The list of metadata item fields.
items:
type: string
localizedMetadataItems:
type: array
description: The list of localized metadata item fields.
items:
type: string
metadataItemDetails:
type: array
description: The list of metadata item details.
items:
$ref: '#/components/schemas/MetadataItemDetails'
resultList:
type: array
description: The list of items.
items:
type: object
additionalProperties:
type: object
count:
type: integer
description: The total item count. This may differ from the size of the items list depending on paging settings.
format: int32
deduplicatedCount:
type: integer
description: The deduplicated item count. This may differ from the size of the items list depending on paging settings.
format: int32
ItemSetBatchResponse:
type: object
properties:
batchName:
type: string
description: Defaults to date in format yy/MM/dd kk:mm:ss z
createdOn:
type: integer
description: The created date for the batch
format: int64
ItemSetResponse:
type: object
properties:
guid:
type: string
description: The item set guid
name:
type: string
description: name
description:
type: string
description: description
batches:
type: array
description: A list of batches for the item set
items:
$ref: '#/components/schemas/ItemSetBatchResponse'
ItemSetDuplicatesResponse:
type: object
properties:
duplicates:
type: array
description: The list of GUIDs representing duplicate items
items:
type: string
ItemSetNameChangeRequest:
type: object
properties:
newName:
type: string
description: New name for the Item Set
required:
- newName
ItemSetRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
batchName:
type: string
description: Defaults to date in format yy/MM/dd kk:mm:ss z
name:
type: string
description: name
deduplication:
type: string
description: How the deduplication is applied. None returns all items matching
the query including duplicates. Other options return deduplicated items
based on the deduplication methods used. Defaults to None
enum:
- md5
- per custodian
- md5 ranked custodian
- none
default: none
description:
type: string
description: The itemset description.
deduplicateBy:
type: string
description: deduplicateBy. Defaults to INDIVIDUAL
enum:
- individual
- family
default: individual
custodianRanking:
type: array
description: List of custodian names ordered from highest ranked to lowest
ranked. If this parameter is present and the deduplication parameter
has not been specified, MD5 Randed Custodian is assumed. If deduplication
is any value other than MD5 Randed Custodian this list is ignored.
items:
type: string
required:
- name
ItemSetCreateRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
batchName:
type: string
description: Defaults to date in format yy/MM/dd kk:mm:ss z
name:
type: string
description: name
deduplication:
type: string
description: How the deduplication is applied. None returns all items matching
the query including duplicates. Other options return deduplicated items
based on the deduplication methods used. Defaults to None
enum:
- md5
- per custodian
- md5 ranked custodian
- none
default: none
description:
type: string
description: The itemset description.
deduplicateBy:
type: string
description: deduplicateBy. Defaults to INDIVIDUAL
enum:
- individual
- family
default: individual
custodianRanking:
type: array
description: List of custodian names ordered from highest ranked to lowest
ranked. If this parameter is present and the deduplication parameter
has not been specified, MD5 Randed Custodian is assumed. If deduplication
is any value other than MD5 Randed Custodian this list is ignored.
items:
type: string
required:
- name
ItemSetAddItemsRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
batchName:
type: string
description: Defaults to date in format yy/MM/dd kk:mm:ss z
BulkItemSetItemsRequest:
type: object
properties:
addItems:
type: array
description: The items to add to the itemset.
items:
$ref: '#/components/schemas/ItemSetAddItemsRequest'
removeItems:
type: array
description: The items to remove from the itemset.
items:
$ref: '#/components/schemas/ItemSetRemoveItemsRequest'
ItemSetRemoveItemsRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns all items.
deduplication:
type: string
description: Deduplicate content. Defaults to none.
default: none
enum:
- none
- md5
- per custodian
relationType:
type: string
description: The relation to apply to the found items. For performance reasons, the family option is run against the top-level items. Defaults to no relation.
enum:
- family
- topTypes
- descendants
removeDuplicates:
type: boolean
description: removeDuplicates. Default is true.
default: true
ConfigurationChangeResponse:
type: object
properties:
message:
type: string
description: A message describing the result of the operation.
status:
type: string
description: The status result of the operation.
enum:
- PERSISTENT
- TRANSIENT
- FAILED
LicenseDescription:
type: object
properties:
source:
type: string
description: Gets a string value identifying information about the source of the license.
type:
type: string
description: Gets a string value identifying the type of license source.
location:
type: string
description: Gets the location of the license.
shortname:
type: string
description: Gets the short name of this license type.
count:
type: integer
format: int32
description: Gets the number of licenses of this type which are currently available.
configuredCount:
type: integer
format: int32
description: Gets the total number of licenses of this type regardless of the state.
description:
type: string
description: Gets a longer description of this license type.
workers:
type: integer
format: int32
description: Gets the number of workers available for use with licenses of this type.
configuredWorkers:
type: integer
format: int32
description: Gets the total number of workers for the licenses of this type regardless of state.
canChooseWorkers:
type: boolean
description: Tests if the client gets a choice over the number of workers.
audited:
type: boolean
description: Tests if the licence is audited in any fashion.
auditThreshold:
type: integer
format: int64
description: Gets the threshold for auditing in bytes.
expiry:
type: string
format: integer
description: Gets the expiry date of the license represented in milliseconds since the epoch.
features:
type: array
description: A list of all enabled license features.
items:
type: string
legalHoldHoldCountLimit:
type: integer
format: int64
description: Gets the Legal Hold "hold count limit" from a license.
concurrentUserLimit:
type: integer
format: int64
description: Retrieves the concurrent user limit from a license.
NuixItemKindResponse:
type: object
properties:
name:
type: string
description: The name of the item kind.
localisedName:
type: string
description: The localized name of the item kind.
SearchMacroResponse:
description: The search macro response object which is a file name/expansion pair.
type: object
properties:
name:
type: string
description: The search macro file name without the extension.
expansion:
type: string
description: The expanded search macro text.
SearchMacroStructuredResponse:
type: object
description: A list of search macro file names without the extension and a folder map of the structured response.
properties:
files:
uniqueItems: true
type: array
description: A list of search macro file names without the extension.
items:
$ref: '#/components/schemas/SearchMacroResponse'
folders:
type: object
description: A map of folder name to a structured search macro.
additionalProperties:
$ref: '#/components/schemas/SearchMacroStructuredResponse'
BulkApplyCustomMetadataResponse:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items.
operation:
type: string
description: The bulk operation that was performed.
enum:
- ADD
- DELETE
fieldName:
type: string
description: The custom metadata field name that was operated on.
results:
$ref: '#/components/schemas/ApplyCustomMetadataResponse'
NuixItemTypeResponse:
type: object
properties:
name:
type: string
description: The content type.
localisedName:
type: string
description: The localized type name.
preferredExtension:
type: string
description: The file extension of the type.
kind:
type: string
description: The item kind.
count:
type: integer
description: The count.
format: int64
FileUpload:
type: object
properties:
success:
type: boolean
description: Boolean true/false depending on whether the upload was successful.
filePath:
type: string
description: The physical path of the uploaded file on disk.
size:
type: integer
format: int64
description: The size of the uploaded file in bytes.
FileUploadResponse:
type: object
properties:
fileUploads:
type: array
description: The array of file upload results
items:
$ref: '#/components/schemas/FileUpload'
ImagingOptions:
type: object
properties:
imageExcelSpreadsheets:
type: boolean
default: false
deprecated: true
description: Specifies whether to image Excel spreadsheets, instead of generating a slip sheet. Defaults to false.
This is replaced with Imaging Profiles since Nuix 7.2.
slipSheetContainers:
type: boolean
default: false
deprecated: true
description: Deprecated - same as exportDescendantContainers in BatchExporter.setTraversalOptions(Map)
since Nuix 7.2. Defaults to false
excelExportingEngine:
type: string
enum:
- INTERNAL
- MS_OFFICE
description: >
Excel Exporting Engine:
* `MS_OFFICE` - Exports Excel documents using Microsoft.
* `INTERNAL` - Exports Excel documents using the built in exporter.
excelPrintHiddenRows:
type: boolean
description: Optionally unhide all Excel rows. Defaults to null which uses the settings present in the document
excelPrintHiddenColumns:
type: boolean
description: Optionally unhide all Excel columns. Defaults to null which uses the settings present in the document
excelPrintHiddenWorksheets:
type: string
default: SHEET_VERY_HIDDEN
enum:
- SHEET_HIDDEN
- SHEET_VERY_HIDDEN
- PRINT_IN_PLACE
- PRINT_NO_COMMENTS
- PRINT_SHEETEND
description: >
Excel Print Hidden Worksheets:
* `SHEET_HIDDEN` - Show hidden worksheets.
* `SHEET_VERY_HIDDEN` - Show hidden and very hidden worksheets.
excelPrintComments:
type: string
enum:
- PRINT_IN_PLACE
- PRINT_NO_COMMENTS
- PRINT_SHEETEND
description: >
Print Comments:
* `PRINT_IN_PLACE` - Print in original location.
* `PRINT_NO_COMMENTS` - Do not print.
* `PRINT_SHEETEND` - Print as end notes.
excelPrintNotes:
type: boolean
description: Optionally set for Excel cell notes to be printed as end notes with the sheet.
Defaults to null which uses the settings present in the document.
excelPaperSize:
type: string
description: >
Excel Paper Size:
* `PAPER_10x14` - 10 in. x 14 in.
* `PAPER_11x17` - 11 in. x 17 in.
* `PAPER_A3` - A3 (297 mm x 420 mm)
* `PAPER_A4` - A4 (210 mm x 297 mm)
* `PAPER_A4Small` - A4 Small (210 mm x 297 mm)
* `PAPER_A5` - A5 (148 mm x 210 mm)
* `PAPER_B4` - B4 (250 mm x 354 mm)
* `PAPER_B5` - A5 (148 mm x 210 mm)
* `PAPER_Csheet` - C size sheet
* `PAPER_Dsheet` - D size sheet
* `PAPER_Envelope10` - Envelope 10 (4-1/8 in. x 9-1/2 in.)
* `PAPER_Envelope11` - Envelope 11 (4-1/2 in. x 10-3/8 in.)
* `PAPER_Envelope12` - Envelope 12 (4-1/2 in. x 11 in.)
* `PAPER_Envelope14` - Envelope 14 (5 in. x 11-1/2 in.)
* `PAPER_Envelope9` - Envelope 9 (3-7/8 in. x 8-7/8 in.)
* `PAPER_EnvelopeB4` - Envelope B4 (250 mm x 353 mm)
* `PAPER_EnvelopeB5` - Envelope B5 (176 mm x 250 mm)
* `PAPER_EnvelopeB6` - Envelope B6 (176 mm x 125 mm)
* `PAPER_EnvelopeC3` - Envelope C3 (324 mm x 458 mm)
* `PAPER_EnvelopeC4` - Envelope C4 (229 mm x 324 mm)
* `PAPER_EnvelopeC5` - Envelope C5 (162 mm x 229 mm)
* `PAPER_EnvelopeC6` - Envelope C6 (114 mm x 162 mm)
* `PAPER_EnvelopeC65` - Envelope C65 (114 mm x 229 mm)
* `PAPER_EnvelopeDL` - Envelope DL (110 mm x 220 mm)
* `PAPER_EnvelopeItaly` - Envelope (110 mm x 230 mm)
* `PAPER_EnvelopeMonarch` - Envelope Monarch (3-7/8 in. x 7-1/2 in.)
* `PAPER_EnvelopePersonal` - Envelope (3-5/8 in. x 6-1/2 in.)
* `PAPER_Esheet` - E size sheet
* `PAPER_Executive` - Executive (7-1/2 in. x 10-1/2 in.)
* `PAPER_FanfoldLegalGerman` - German Legal Fanfold (8-1/2 in. x 13 in.)
* `PAPER_FanfoldStdGerman` - German Legal Fanfold (8-1/2 in. x 13 in.)
* `PAPER_FanfoldUS` - U.S. Standard Fanfold (14-7/8 in. x 11 in.)
* `PAPER_Folio` - Folio (8-1/2 in. x 13 in.)
* `PAPER_Ledger` - Ledger (17 in. x 11 in.)
* `PAPER_Legal` - Legal (8-1/2 in. x 14 in.)
* `PAPER_Letter` - Letter (8-1/2 in. x 11 in.)
* `PAPER_LetterSmall` - Letter Small (8-1/2 in. x 11 in.)
* `PAPER_Note` - Note (8-1/2 in. x 11 in.)
* `PAPER_Quarto` - Quarto (215 mm x 275 mm)
* `PAPER_Statement` - Statement (5-1/2 in. x 8-1/2 in.)
* `PAPER_Tabloid` - Tabloid (11 in. x 17 in.)
enum:
- PAPER_10x14
- PAPER_11x17
- PAPER_A3
- PAPER_A4
- PAPER_A4Small
- PAPER_A5
- PAPER_B4
- PAPER_B5
- PAPER_Csheet
- PAPER_Dsheet
- PAPER_Envelope10
- PAPER_Envelope11
- PAPER_Envelope12
- PAPER_Envelope14
- PAPER_Envelope9
- PAPER_EnvelopeB4
- PAPER_EnvelopeB5
- PAPER_EnvelopeB6
- PAPER_EnvelopeC3
- PAPER_EnvelopeC4
- PAPER_EnvelopeC5
- PAPER_EnvelopeC6
- PAPER_EnvelopeC65
- PAPER_EnvelopeDL
- PAPER_EnvelopeItaly
- PAPER_EnvelopeMonarch
- PAPER_EnvelopePersonal
- PAPER_Esheet
- PAPER_Executive
- PAPER_FanfoldLegalGerman
- PAPER_FanfoldStdGerman
- PAPER_FanfoldUS
- PAPER_Folio
- PAPER_Ledger
- PAPER_Legal
- PAPER_Letter
- PAPER_LetterSmall
- PAPER_Note
- PAPER_Quarto
- PAPER_Statement
- PAPER_Tabloid
excelPageOrientation:
type: string
enum:
- PORTRAIT
- LANDSCAPE
description: >
Excel Page Orientation
* `PORTRAIT` - Portrait mode
* `LANDSCAPE` - Landscape mode
excelPageZoom:
type: string
enum:
- PERCENT_10
- PERCENT_25
- PERCENT_50
- PERCENT_75
- PERCENT_100
- PERCENT_125
- PERCENT_150
- PERCENT_200
- PERCENT_400
description: >
Excel Page Zoom:
* `PERCENT_10` - 10%
* `PERCENT_25` - 25%
* `PERCENT_50` - 50%
* `PERCENT_75` - 75%
* `PERCENT_100` - 100%
* `PERCENT_125` - 125%
* `PERCENT_150` - 150%
* `PERCENT_200` - 200%
* `PERCENT_400` - 400%
excelFitToPagesTall:
type: integer
description: Optionally set for Excel the number of pages tall the worksheet will be scaled to when it's printed.
Defaults to null which uses the settings present in the document
format: int32
excelFitToPagesWide:
type: integer
description: Optionally set for Excel the number of pages wide the worksheet will be scaled to when it's printed.
Defaults to null which uses the settings present in the document
format: int32
excelWorksheetPrintArea:
type: string
description: Optionally set Excel print area for every worksheet. Empty string for entire worksheet or standard excel range string
(e.g., $A$1:$J$10). Defaults to empty string
excelPageNumberLimit:
type: integer
description: Optionally set the page number limit for Excel. The value must be a positive number. Defaults to null which uses the settings present in the document
format: int32
excelPrintGridlines:
type: boolean
default: true
description: Optionally force Excel gridlines to be always shown or hidden. Defaults to true
excelPrintHeadings:
type: boolean
default: true
description: Optionally force Excel headers to be hidden or shown. Defaults to true
wordExportingEngine:
type: string
default: INTERNAL
enum:
- MS_OFFICE
- INTERNAL
description: >
Word Exporting Engine:
* `MS_OFFICE` - Export Word documents using Microsoft Office
* `INTERNAL` - Export Word documents using built in exporter
wordShowMarkup:
type: boolean
description: Optionally force Word to show markup (such as track-changes) or hide it.
Defaults to null which uses the settings present in the document
wordShowHiddenText:
type: boolean
description: Optionally force PowerPoint to show markup (such as track-changes or hidden text) or hide it.
Defaults to null which uses the settings present in the document
powerpointExportEngine:
type: string
default: INTERNAL
enum:
- MS_OFFICE
- INTERNAL
description: >
Powerpoint Exporting Engine:
* `MS_OFFICE` - Export Powerpoint documents using Microsoft Office
* `INTERNAL` - Export Powerpoint documents using built in exporter
powerPointPrintOutputType:
type: string
default: PRINT_OUTPUT_SLIDES
enum:
- PRINT_OUTPUT_BUILD_SLIDES
- PRINT_OUTPUT_FOUR_SLIDE_HANDOUTS
- PRINT_OUTPUT_NINE_SLIDE_HANDOUTS
- PRINT_OUTPUT_NOTES_PAGES
- PRINT_OUTPUT_ONE_SLIDE_HANDOUTS
- PRINT_OUTPUT_OUTLINE
- PRINT_OUTPUT_SIX_SLIDE_HANDOUTS
- PRINT_OUTPUT_SLIDES
- PRINT_OUTPUT_THREE_SLIDE_HANDOUTS
- PRINT_OUTPUT_TWO_SLIDE_HANDOUTS
description: >
Powerpoint Print Output Type:
* `PRINT_OUTPUT_BUILD_SLIDES` - Build Slides
* `PRINT_OUTPUT_FOUR_SLIDE_HANDOUTS` - Four Slide Handouts
* `PRINT_OUTPUT_NINE_SLIDE_HANDOUTS` - Nine Slide Handouts
* `PRINT_OUTPUT_NOTES_PAGES` - Notes Pages
* `PRINT_OUTPUT_ONE_SLIDE_HANDOUTS` - Single Slide Handouts
* `PRINT_OUTPUT_OUTLINE` - Outline
* `PRINT_OUTPUT_SIX_SLIDE_HANDOUTS` - Six Slide Handouts
* `PRINT_OUTPUT_SLIDES` - Slides
* `PRINT_OUTPUT_THREE_SLIDE_HANDOUTS` - Three Slide Handouts
* `PRINT_OUTPUT_TWO_SLIDE_HANDOUTS` - Two Slide Handouts
slipSheetMetadataProfile:
type: string
description: Optionally insert values from a metadata profile into generated slip-sheets.
Defaults to null which uses the settings present in the document
OcrOptions:
type: object
properties:
regeneratePdfs:
type: boolean
default: false
description: Specifies whether to regenerate PDFs before they are sent to
the OCR processor. Defaults to false
updatePdf:
type: boolean
default: true
description: Specifies whether to update PDFs in the print store with the
PDF created by the OCR processor. Defaults to true
updateText:
type: boolean
default: true
description: Specifies whether to update the item's text with the text extrated
with the OCR processor. Defaults to true
textModification:
type: string
default: append
enum:
- append
- overwrite
description: Specifies whether to append or overwrite new text to the item's
existing text. Ignored if 'updateText' is set to false. Defaults to append.
quality:
type: string
default: document_archiving_accuracy
enum:
- default
- document_archiving_accuracy
- document_archiving_speed,
- book_archiving_accuracy
- book_archiving_speed
- document_conversion_accuracy
- document_conversion_speed
- text_extraction_accuracy
- text_extraction_speed
- field_level_recognition
- fast
- mid_range
- high_quality
description: >
OCR Quality:
* `default` - will use default values which usually produce a good result in a reasonable time.
* `document_archiving_accuracy` - Is suitable for creating an electronic archive (e.g. PDF). Enables detection
of maximum text on an image, including text embedded into the image. Full synthesis of the logical structure
of a document is not performed.
* `document_archiving_speed` - Has an emphasis on speed rather than accuracy. See document_archiving_accuracy.
* `book_archiving_accuracy` - Is suitable for creating an electronic library (e.g. PDF). Enables detection
of font styles and full synthesis of the logical structure of a document.
* `book_archiving_speed` - Has an emphasis on speed rather than accuracy. See book_archiving_accuracy.
* `document_conversion_accuracy` - Is suitable for converting documents into an editable format (e.g. RTF,
DOCX). Enables detection of font styles and full synthesis of the logical structure of a document.
* `document_conversion_speed` - Has an emphasis on speed rather than accuracy. See document_conversion_accuracy.
* `text_extraction_accuracy` - Is suitable for extracting text from a document. Enables detection of all text on an image,
including small text areas of low quality (pictures and tables are not detected). Full synthesis of the logical
structure of a document is not performed.
* `text_extraction_speed` - Has an emphasis on speed rather than accuracy. See text_extraction_accuracy.
* `field_level_recognition` - Is suitable for recognizing short text fragments
* `fast` - Deprecated. See default.
* `mid_range` - Deprecated. See document_archiving_speed
* `high_quality` - Deprecated. See document_archiving_accuracy
rotation:
type: string
enum:
- auto
- no_rotation
- left
- right
- upside_down
default: auto
description: |
Specifies the page rotation to use on the images. This will
rotate the images before processing.
* `left` Indicates the top of the image is on the left side of the document i.e. it is rotated 90 degrees counter-clockwise.
* `right` - Indicates the top of the image is on the right side of the document i.e. it is rotate 90 degrees clockwise.
* `upside_down` - Indicates the document should be rotate 180 degrees before processing.
deskew:
type: boolean
default: true
description: Whether to deskew text. This will attempt to correct images
where text is not level with the page. Defaults to true
clearOcrCache:
type: boolean
default: true
description: Specifies whether to clear OCR cache. By default the OCR cache
will be deleted upon completion. The default location for this cache is
under the case directory. See also 'outputDirectory' for customising the
location of this cache. Defaults to true
outputDirectory:
type: string
description: Specifies the output directory. Defaults to the temporary directory
languages:
type: string
default: English
description: Specifies the language to use during recognition. Defaults to English
timeout:
type: integer
default: 90
description: The timeout duration in minutes for processing an item. Must
be greater than 1 minute. Defaults to 90
format: int32
updateDuplicates:
type: boolean
default: false
description: Update all duplicate items in the case. Defaults to false
OcrRequest:
type: object
deprecated: true
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns everything.
ocrOptions:
$ref: '#/components/schemas/OcrOptions'
ocrImagingOptions:
$ref: '#/components/schemas/ImagingOptions'
tags:
type: object
description: a map of tags to apply to the items. The map must contain keys
'add' or 'remove' and the value is the tag to apply or delete.
additionalProperties:
type: string
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
OcrOptionsV2:
type: object
properties:
regeneratePdfs:
type: boolean
default: false
description: Specifies whether to regenerate PDFs before they are sent to
the OCR processor. Defaults to false
updatePdf:
type: boolean
default: true
description: Specifies whether to update PDFs in the print store with the
PDF created by the OCR processor. Defaults to true
updateText:
type: boolean
default: true
description: Specifies whether to update the item's text with the text extrated
with the OCR processor. Defaults to true
textModification:
type: string
default: append
enum:
- append
- overwrite
description: Specifies whether to append or overwrite new text to the item's
existing text. Ignored if 'updateText' is set to false. Defaults to append.
quality:
type: string
enum:
- default
- document_archiving_accuracy
- document_archiving_speed,
- book_archiving_accuracy
- book_archiving_speed
- document_conversion_accuracy
- document_conversion_speed
- text_extraction_accuracy
- text_extraction_speed
- field_level_recognition
- fast
- mid_range
- high_quality
description: >
OCR Quality:
* `default` - will use default values which usually produce a good result in a reasonable time.
* `document_archiving_accuracy` - Is suitable for creating an electronic archive (e.g. PDF). Enables detection
of maximum text on an image, including text embedded into the image. Full synthesis of the logical structure
of a document is not performed.
* `document_archiving_speed` - Has an emphasis on speed rather than accuracy. See document_archiving_accuracy.
* `book_archiving_accuracy` - Is suitable for creating an electronic library (e.g. PDF). Enables detection
of font styles and full synthesis of the logical structure of a document.
* `book_archiving_speed` - Has an emphasis on speed rather than accuracy. See book_archiving_accuracy.
* `document_conversion_accuracy` - Is suitable for converting documents into an editable format (e.g. RTF,
DOCX). Enables detection of font styles and full synthesis of the logical structure of a document.
* `document_conversion_speed` - Has an emphasis on speed rather than accuracy. See document_conversion_accuracy.
* `text_extraction_accuracy` - Is suitable for extracting text from a document. Enables detection of all text on an image,
including small text areas of low quality (pictures and tables are not detected). Full synthesis of the logical
structure of a document is not performed.
* `text_extraction_speed` - Has an emphasis on speed rather than accuracy. See text_extraction_accuracy.
* `field_level_recognition` - Is suitable for recognizing short text fragments
* `fast` - Deprecated. See default.
* `mid_range` - Deprecated. See document_archiving_speed
* `high_quality` - Deprecated. See document_archiving_accuracy
rotation:
type: string
enum:
- auto
- no_rotation
- left
- right
- upside_down
default: auto
description: |
Specifies the page rotation to use on the images. This will
rotate the images before processing.
* `left` Indicates the top of the image is on the left side of the document i.e. it is rotated 90 degrees counter-clockwise.
* `right` - Indicates the top of the image is on the right side of the document i.e. it is rotate 90 degrees clockwise.
* `upside_down` - Indicates the document should be rotate 180 degrees before processing.
deskew:
type: boolean
default: true
description: Whether to deskew text. This will attempt to correct images where text is not level with the page. Defaults to true
clearOcrCache:
type: boolean
default: true
description: Specifies whether to clear OCR cache. By default the OCR cache
will be deleted upon completion. The default location for this cache is
under the case directory. See also 'outputDirectory' for customising the
location of this cache. Defaults to true
outputDirectory:
type: string
description: Specifies the output directory. Defaults to the temporary directory
languages:
type: array
description: Specifies the languages to use during recognition. Defaults
to English
items:
$ref: '#/components/schemas/Languages'
timeout:
type: integer
default: 90
description: The timeout duration in minutes for processing an item. Must
be greater than 1 minute. Defaults to 90
format: int32
updateDuplicates:
type: boolean
default: false
description: Update all duplicate items in the case. Defaults to false
ocrProfileName:
type: string
description: The OCR profile name.
OcrRequestV2:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied
it defaults to an empty string, which returns everything.
ocrOptions:
$ref: '#/components/schemas/OcrOptionsV2'
ocrImagingOptions:
$ref: '#/components/schemas/ImagingOptions'
ocrProfile:
type: string
description: The name of the OCR Profile to use. If you use this setting
then do not use any other settings to perform OCR from ocrOptions as everything
will be overridden by the loaded OCR profile.
imagingProfile:
type: string
description: The name of the Imaging Profile to use. If you use this setting
then do not use any settings from ocrImagingOptions as those settings
will be overridden by the ones from the profile.
tags:
type: object
description: a map of tags to apply to the items. The map must contain keys
'add' or 'remove' and the value is the tag to apply or delete.
additionalProperties:
type: string
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
ProductionSetRequest:
type: object
properties:
name:
type: string
description: The name of the production set.
description:
type: string
description: A description for the production set.
prefix:
type: string
description: Prefix used for document numbering.
startingNumber:
type: string
description: The first number used for document numbering.
query:
type: string
description: Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items.
includeFamilies:
type: boolean
description: If true, includes family items for the collection of items returned by the query. Default is false.
default: false
markupSets:
type: array
description: Sets the given markup sets to be used during the export.
items:
type: string
applyRedactions:
type: boolean
description: If true, applies redactions in the markup sets. Default is true.
default: true
applyHighlights:
type: boolean
description: If true, applies highlights in the markup sets. Default is true.
default: true
generatePdfStores:
type: boolean
description: Generates print previews for the selected items in this production set. Default is false.
default: false
pdfStoresQuery:
type: string
description: Query that identifies which production set items should have print previews generated. If a query is not supplied it defaults to an
empty string, which returns all items.
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
required:
- name
ApplicationHealth:
type: object
properties:
directories:
type: array
description: A list of critical directories and their access permissions.
items:
$ref: '#/components/schemas/DirectoryAccess'
ok:
description: A boolean indicating the cumulative health of the critical directories.
type: boolean
ClusterHealth:
type: object
properties:
hasConsumer:
type: boolean
description: Boolean indicating whether the cluster has a consumer present.
hasProducer:
type: boolean
description: Boolean indicating whether the cluster has a producer present.
ok:
type: boolean
description: Boolean indicating the overall cluster health.
nodes:
type: array
description: A list of nodes and their cluster health.
items:
$ref: '#/components/schemas/NodeHealth'
DirectoryAccess:
type: object
properties:
path:
type: string
description: The path to the directory.
readPermission:
type: boolean
description: A boolean indicating whether the directory has read permission.
requiresRead:
type: boolean
description: A boolean indicating whether the directory requires read permission.
writePermission:
type: boolean
description: A boolean indicating whether the directory has write permission.
requiresWrite:
type: boolean
description: A boolean indicating whether the directory requires write permission.
executePermission:
type: boolean
description: A boolean indicating whether the directory has execute permission.
requiresExecute:
type: boolean
description: A boolean indicating whether the directory requires execute permission.
ok:
type: boolean
description: Boolean indicating the overall directory health.
NodeHealth:
type: object
properties:
hostAddress:
type: string
description: The host address.
hostName:
type: string
description: The host name.
port:
type: integer
format: int32
description: The port.
applicationHealth:
$ref: '#/components/schemas/ApplicationHealth'
Cluster:
type: object
properties:
nodes:
type: array
description: List of nodes in the cluster. There should be at least one node in the list.
items:
$ref: '#/components/schemas/ClusterNode'
ClusterNode:
type: object
properties:
hostAddress:
type: string
description: The host address of the server.
hostName:
type: string
description: The hostname of the server.
port:
type: integer
description: The port number of the node for communication between other cluster members.
format: int32
details:
$ref: '#/components/schemas/ClusterNodeDetails'
ClusterNodeDetails:
type: object
properties:
guid:
type: string
description: The unique identifier for the node. This is generated based upon the serverId.
serverId:
type: string
description: The id of the node.
publicURL:
type: string
description: The public URL of the node.
contextPath:
type: string
description: server context path
name:
type: string
description: The friendly name of the node.
maxWorkers:
type: integer
description: The max number of workers of the node.
availableWorkers:
type: integer
description: The number of workers available on the node.
busyWorkers:
type: integer
description: The number of workers in use on the node.
tags:
type: array
description: An array of tags applied to the node. This can be used for node filtering when processing in a cluster.
items:
type: string
roles:
type: array
description: A list of cluster roles the node has been assigned.
items:
type: string
enum:
- PRODUCER
- CONSUMER
restVersion:
type: string
description: The customer version of the node.
osInfo:
$ref: '#/components/schemas/OperatingSystemDigest'
engineVersion:
type: string
description: The engine version of the node.
OperatingSystemDigest:
type: object
properties:
name:
type: string
description: The name of the operating system.
version:
type: string
description: The version of the operating system.
arch:
type: string
description: The arch of the operating system.
description:
type: string
description: The description of the operating system.
family:
type: string
description: The family of the operating system.
patchLevel:
type: string
description: The patch level of the operating system.
vendorName:
type: string
description: The vendor name of the operating system.
vendorCodeName:
type: string
description: The vendorCodeName of the operating system.
QueueStateNuixTaskRequest:
type: object
properties:
capacity:
type: integer
description: The capacity of the queue.
format: int64
head:
type: integer
description: The head of the queue.
format: int64
tail:
type: integer
description: The tail of the queue.
format: int64
size:
type: integer
description: The size of the queue.
tasks:
type: array
description: The filtered array of tasks in the queue.
items:
$ref: '#/components/schemas/NuixTaskRequest'
NuixTaskRequest:
type: object
properties:
caseId:
type: string
description: caseId
processedBy:
type: string
description: The name of the server processing the task.
url:
type: string
writeOnly: true
description: The URL of the server.
body:
type: string
writeOnly: true
description: The body of the task.
status:
type: string
description: The task status.
enum:
- NOT_STARTED
- IN_PROGRESS
- COMPLETE
- CANCELLED
- ERROR
- UNKNOWN
sequence:
$ref: '#/components/schemas/Sequence'
description: The sequence assigned by the cluster to the task.
finishTime:
type: integer
description: Time the task finished.
format: int64
startTime:
type: integer
description: Time the task started.
format: int64
Sequence:
type: object
ProductionSetResponse:
type: object
properties:
name:
type: string
description: Name of the production set.
description:
type: string
description: Description of the production set.
guid:
type: string
description: Production set GUID.
frozen:
type: boolean
description: Indicates whether or not the production set is frozen.
nextDocumentNumber:
type: string
description: Document number that will be used for the next item added to
this production set.
prefix:
type: string
description: Prefix used for document numbering.
nextDocumentId:
type: string
description: Document ID that will be used for the next item added to this production set.
firstDocumentNumber:
type: string
description: Document number for the first item in this production set.
itemCount:
type: integer
description: Number of items in the production set.
format: int64
BulkProductionSetWithProfilesRequest:
type: object
properties:
query:
type: string
description: Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items.
deduplication:
type: string
description: Deduplicate items. Defaults to none.
default: none
enum:
- none
- md5
- per custodian
relationType:
type: string
description: The relation to apply to the found items. For performance reasons, the family option is run against the top-level items. Defaults to no relation.
enum:
- family
- topTypes
- descendants
includeFamily:
type: boolean
description: Includes families of items for results of provided query. Defaults to false.
default: false
familyQuery:
type: string
description: An optional query used to select family items. Will not be
used if includeFamily is true. To exclude family items entirely, set
includeFamily to false and either omit this entry or set its value to
null.
includeDuplicates:
type: boolean
description: Includes duplicates of items for results of provided query. Defaults to false.
default: false
duplicatesQuery:
type: string
description: An optional query used to select duplicate items. Will not
be used if includeDuplicates is true. To exclude duplicate items entirely,
set includeDuplicates to false and either omit this entry or set its value
to null.
includeNearDuplicates:
type: boolean
description: Includes near duplicates of items for results of provided query. Defaults to false.
default: false
nearDuplicatesQuery:
type: string
description: An optional query used to select near duplicate items. Will
not be used if includeNearDuplicates is true. To exclude near duplicate
items entirely, set includeNearDuplicates to false and either omit this
entry or set its value to null.
nearDuplicatesThreshold:
type: number
description: The threshold used to calculate near duplicates. Defaults to 0.5.
format: float
default: 0.5
threadsQuery:
type: string
description: An optional query used to select thread items. To exclude
thread items entirely, either omit this entry or set its value to null.
productionProfileName:
type: string
description: The name of the production profile to use.
imagingProfileName:
type: string
description: The name of the imaging profile to use.
skipNativesSlipsheetedItems:
type: boolean
description: Sets whether this production set skips export of natives for slip-sheeted items.
description:
type: string
description: Set the long description of the production set.
name:
type: string
description: The name of the production set to operate on.
required:
- name
- productionProfileName
- imagingProfileName
SystemPropertyResponse:
type: object
properties:
name:
type: string
description: The name of the system property.
value:
type: string
description: The current value of the system property, or null if there
was no property with that key.
previousValue:
type: string
description: The previous value of the system property, or null if there
was no property with that key.
SystemPropertyRequest:
type: object
properties:
value:
type: string
description: The value of the system property.
required:
- value
UserScriptRequest:
type: object
deprecated: true
properties:
fileName:
type: string
description: The path location of a script file, relative to the 'userScriptsLocation'
property. If this field has a value, it will be used and has priority
over the "script" field. The "fileName" field or "script" field is required for this
request.
script:
type: string
description: A script to execute as a literal string. If the "filename" property
has a value, this field will be ignored and the script will be run from
the provided file location instead. The "script" field or "filename" field is required
for this request.
language:
type: string
description: Language that the script is written in.
enum:
- RUBY
- JAVASCRIPT
- PYTHON
name:
type: string
description: Sets the name of the script.
description:
type: string
description: A brief description of what the script does.
relativeOutputDirectory:
type: string
description: The script output directory relative to the case path. Output is only written
if the `writeOutputToFileSystem` property is true.
async:
type: boolean
description: Specifies whether this script should run asynchronously. Defaults
to true.
default: true
customArguments:
type: object
additionalProperties:
type: object
description: Used to map any arguments the user wants to add and reference
later in the script.
writeOutputToFileSystem:
description: True to writes the script output to the file system, false otherwise.
type: boolean
default: false
UserScriptRequestV2:
type: object
properties:
fileName:
type: string
description: The path location of a script file, relative to the 'userScriptsLocation'
property. If this field has a value, it will be used and has priority
over the "script" field. The "fileName" field or "script" field is required for this request.
script:
type: string
description: A script to execute as a literal string. If the "filename" property
has a value, this field will be ignored and the script will be run from
the provided file location instead. The "script" field or "filename" field is required for this
request.
language:
type: string
description: Language that the script is written in.
enum:
- RUBY
- JAVASCRIPT
- PYTHON
name:
type: string
description: Sets the name of the script.
description:
type: string
description: A brief description of what the script does.
relativeOutputDirectory:
type: string
description: The script output directory relative to the case path. Output is only written
if the `writeOutputToFileSystem` property is true.
customArguments:
type: object
additionalProperties:
type: object
description: Used to map any arguments the user wants to add and reference
later in the script.
writeOutputToFileSystem:
description: True to writes the script output to the file system, false otherwise.
type: boolean
default: false
AboutResponse:
type: object
properties:
server:
type: string
description: The URL of the server as configured by the publicURL property.
nuixRestfulVersion:
type: string
description: The version of the service.
engineVersion:
type: string
description: The version of the Nuix engine the service is running.
startupTime:
type: string
description: The startup time of the server in milliseconds.
serverId:
type: string
description: The server ID as configured by the serverId property.
AboutResponseV1:
type: object
properties:
server:
type: string
description: The URL of the server as configured by the publicURL property.
deprecated: true
nuixRestfulVersion:
type: string
description: The version of the service.
deprecated: true
engineVersion:
type: string
description: The version of the Nuix engine the service is running.
deprecated: true
startupTime:
type: string
description: The startup time of the server in milliseconds.
deprecated: true
serverId:
type: string
description: The server ID as configured by the serverId property.
deprecated: true
licenceSource:
description: The license source. Note this is always server.
deprecated: true
casePrivilegeSecurityEnabled:
type: boolean
description: Unused and deprecated. Always false.
deprecated: true
itemSecurityEnabled:
type: boolean
description: Unused and deprecated. Always false.
deprecated: true
specificLicenseRequiredAtLogin:
type: boolean
description: Unused and deprecated. Always false.
deprecated: true
userManagementUrl:
type: string
description: Unused and deprecated. Always empty string.
deprecated: true
textHighlightingEnabled:
type: boolean
description: Unused and deprecated. Return value as configured based on the textHighlightingEnabled property.
deprecated: true
phraseHighlightingEnabled:
type: boolean
description: Unused and deprecated. Return value as configured based on the phraseHighlightingEnabled property.
deprecated: true
QueryValidationResponse:
type: object
properties:
valid:
type: boolean
description: valid
query:
type: string
description: query
exception:
type: string
description: exception
CharsetResponse:
type: object
description: An object describing a system charset.
properties:
name:
type: string
description: The name of the charset.
displayName:
type: string
description: A description of the charset.
EntityTypesResponse:
type: object
description: The types of named entities associated with a case.
properties:
entityTypes:
description: A list of entity types
type: array
items:
$ref: '#/components/schemas/EntityType'
EntityType:
type: object
description: A named entity.
properties:
name:
type: string
description: Gets the name of the entity type.
localisedName:
type: string
description: Gets the name of the entity type, localised appropriately for display to users.
Languages:
type: string
enum:
- Abkhaz
- Adyghe
- Afrikaans
- Agul
- Albanian
- Altaic
- Arabic
- ArmenianEastern
- ArmenianGrabar
- ArmenianWestern
- Awar
- Aymara
- AzeriCyrillic
- AzeriLatin
- Bashkir
- Basque
- Belarusian
- Bemba
- Blackfoot
- Breton
- Bugotu
- Bulgarian
- Buryat
- Catalan
- Chamorro
- Chechen
- ChinesePRC
- ChineseTaiwan
- Chukcha
- Chuvash
- Corsican
- CrimeanTatar
- Croatian
- Crow
- Czech
- Danish
- Dargwa
- Dungan
- Dutch
- DutchBelgian
- English
- EskimoCyrillic
- EskimoLatin
- Esperanto
- Estonian
- Even
- Evenki
- Faeroese
- Fijian
- Finnish
- French
- Frisian
- Friulian
- GaelicScottish
- Gagauz
- Galician
- Ganda
- German
- GermanLuxembourg
- GermanNewSpelling
- Greek
- Guarani
- Hani
- Hausa
- Hawaiian
- Hebrew
- Hungarian
- Icelandic
- Ido
- Indonesian
- Ingush
- Interlingua
- Irish
- Italian
- Japanese
- Kabardian
- Kalmyk
- KarachayBalkar
- Karakalpak
- Kasub
- Kawa
- Kazakh
- Khakas
- Khanty
- Kikuyu
- Kirgiz
- Kongo
- Korean
- Koryak
- Kpelle
- Kumyk
- Kurdish
- Lak
- Lappish
- Latin
- Latvian
- LatvianGothic
- Lezgin
- Lithuanian
- Luba
- Macedonian
- Malagasy
- Malay
- Malinke
- Maltese
- Mansi
- Maori
- Mari
- Maya
- Miao
- Minankabaw
- Mohawk
- Mongol
- Mordvin
- Nahuatl
- Nenets
- Nivkh
- Nogay
- Norwegian
- NorwegianBokmal
- NorwegianNynorsk
- Nyanja
- Occidental
- Ojibway
- Ossetic
- Papiamento
- PidginEnglish
- Polish
- PortugueseBrazilian
- PortugueseStandard
- Provencal
- Quechua
- RhaetoRomanic
- Romanian
- RomanianMoldavia
- Romany
- Ruanda
- Rundi
- Russian
- RussianOldSpelling
- RussianWithAccent
- Samoan
- Selkup
- SerbianCyrillic
- SerbianLatin
- Shona
- Sioux
- Slovak
- Slovenian
- Somali
- Sorbian
- Sotho
- Spanish
- Sunda
- Swahili
- Swazi
- Swedish
- Tabassaran
- Tagalog
- Tahitian
- Tajik
- Tatar
- Thai
- Tinpo
- Tongan
- Tswana
- Tun
- Turkish
- Turkmen
- TurkmenLatin
- Tuvin
- Udmurt
- UighurCyrillic
- UighurLatin
- Ukrainian
- UzbekCyrillic
- UzbekLatin
- Vietnamese
- Visayan
- Welsh
- Wolof
- Xhosa
- Yakut
- Yiddish
- Zapotec
- Zulu
ThirdPartyDependencyResponse:
type: object
properties:
description:
description: Gets the localised description of this prerequisite in the system's current locale.
type: string
version:
description: The version of the application.
type: string
message:
description: Gets the status of this prerequisite.
type: string
comment:
description: Gets the comment.
type: string
attentionRequired:
description: Tests whether the user's attention is required.
type: boolean
ClusterThirdPartyDependency:
type: object
properties:
hostAddress:
type: string
description: node host URL
thirdPartyDependency:
description: a summary of third party dependencies and their availability
type: object
items:
$ref: '#/components/schemas/ThirdPartyDependencyResponse'
OcrTemplateDetails:
type: object
properties:
id:
type: string
description: The id of the template.
name:
type: string
description: The name of the template.
description:
type: string
description: The template description.
appendText:
type: boolean
description: Gets whether to append text to item.
updateText:
type: boolean
description: Gets whether to update item text.
updatePdf:
type: boolean
description: Gets whether to update PDF.
pageRotation:
type: string
description: Gets the page rotation of the printed image.
deprecated: true
textRotations:
type: array
items:
type: string
description: Gets the text page rotations.
multiProcessingMode:
type: string
description: Gets the multi-processing mode.
languages:
type: array
items:
type: string
description: Gets the languages.
deskew:
type: boolean
description: Gets whether to deskew.
autoPageRotationEnabled:
type: boolean
description: Gets whether to use auto page rotation.
customPageRotationEnabled:
type: boolean
description: Gets whether to use custom page rotation.
noPageRotationEnabled:
type: boolean
description: Gets whether to OCR without rotating.
clockwisePageRotationEnabled:
type: boolean
description: Gets whether to run OCR with clockwise rotation.
counterClockwisePageRotationEnabled:
type: boolean
description: Gets whether to run OCR with counter-clockwise rotation.
oneEightyPageRotationEnabled:
type: boolean
description: Gets whether to run OCR with upside-down rotation.
ocrProcessingProfile:
type: string
description: Gets the OCR processing profile provided by Abbyy.
timeout:
type: integer
description: Gets the timeout duration.
printedImageRotation:
type: string
description: Gets the printed image rotation.
useNative:
type: boolean
description: Gets whether to use native item for OCR.
PromoteToDiscoverRequest:
type: object
properties:
query:
type: string
description: Identifies what items should be promoted. If a query is not supplied it defaults to an empty string, which returns all items.
deduplication:
type: string
description: Deduplicate items before promotion. Defaults to none.
default: none
enum:
- none
- md5
- per custodian
discoverDeduplication:
type: boolean
description: Whether or not Nuix Discover should perform deduplication.
apiAccessToken:
type: string
description: A valid Nuix Discover API Access token
parallelProcessingSettings:
$ref: '#/components/schemas/ParallelProcessingSettings'
required:
- apiAccessToken
securitySchemes:
ApiKeyAuth:
type: apiKey
name: nuix-auth-token
in: header
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
examples:
SimpleCaseCreation:
value:
name: SimpleCase
location: inventory0
description: About My simple Case
compound: false
investigator: Inspector Gadget
CompoundCaseCreation:
value:
name: CompoundCase
location: inventory0
description: About My compound Case
compound: true
investigator: Inspector Gadget
ElasticsearchCaseCreation:
value:
name: ElasticssearchCase
location: inventory0
description: About My Elasticsearch Case
compound: false
investigator: Inspector Gadget
elasticSearchSettings:
cluster.name: myClusterName
index.number_of_shards: 1
index.number_of_replicas: 0
nuix.transport.hosts: [ "127.0.0.1" ]
nuix.http.hosts: [ "127.0.0.1" ]
SimpleCaseCreationResponse:
value:
caseId: 559710fa433a44c0a8b3a5805c4c8ba0
name: SimpleCase
path: /opt/nuix/cases/SimpleCase
description: About My simple Case
investigator: Inspector Gadget
creationDate: 1606248486451
compound: false
elastic: false
binaryStoreLocation: ""
indexId: ""
caseSize: 0
casePathParent: /opt/nuix/cases
caseInvestigationTimeZone: Etc/GMT
hasExclusions: null
hasNuixSystemTags: null
hasProductionSets: null
hasCalculatedAuditSize: null
casePath: /opt/nuix/cases/SimpleCase
caseName: SimpleCase
caseDescription: About My simple Case
caseCreationDate: 1606248486451
caseInvestigator: Inspector Gadget
CompoundCaseCreationResponse:
value:
caseId: 559710fa433a44c0a8b3a5805c4c8ba0
name: CompoundCase
path: /opt/nuix/cases/CompoundCase
description: About My compound Case
investigator: Inspector Gadget
creationDate: 1606248486451
compound: true
elastic: false
binaryStoreLocation: ""
indexId: ""
caseSize: 0
casePathParent: /opt/nuix/cases
caseInvestigationTimeZone: Etc/GMT
hasExclusions: null
hasNuixSystemTags: null
hasProductionSets: null
hasCalculatedAuditSize: null
casePath: /opt/nuix/cases/Compound
caseName: CompoundCase
caseDescription: About My compound Case
caseCreationDate: 1606248486451
caseInvestigator: Inspector Gadget
ElasticCaseResponse:
value:
caseId: 058d9a61faf04e4ca320cb64a166715b
name: ElasticCase
path: /opt/nuix/cases/ElasticCase
description: About My Elasticsearch Case
investigator: Inspector Gadget
creationDate: 1607687810636
compound: false
elastic: true
binaryStoreLocation: /opt/nuix/cases/ElasticCase/Stores/BinaryStore
indexId: nuix-058d9a61faf04e4ca320cb64a166715b
caseSize: 0
casePathParent: /opt/nuix/cases
caseInvestigationTimeZone: Etc/GMT
hasExclusions: null
hasNuixSystemTags: null
hasProductionSets: null
hasCalculatedAuditSize: null
casePath: /opt/nuix/cases/ElasticCase
caseDescription: About My Elasticsearch Case
caseCreationDate: 1607687810636
caseInvestigator: Inspector Gadget
caseName: ElasticCase