Nuix SDK – Introduction to Nuix RESTful Service

Getting Started: Part 1: Verifying your Installation

Tue, 09 Feb 2021 00:00:00 +0000

About

Before you begin, it is a good idea to verify your installation and make sure Nuix REST is up and running. You can easily do this by using the /v2/about endpoint.

The unauthenticated version of this endpoint will only return the server and serverId fields. All other fields will be null and require an authentication token to view them.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v2/about'

{
    "server": "http://localhost:8080",
    "serverId": "nuix-restful-server-1",
    "startupTime": null,
    "nuixRestfulVersion": null,
    "engineVersion": null
}

Getting Started: Part 2: Verifying your Licenses

Tue, 09 Feb 2021 00:00:00 +0000

Licensing

Prior to consuming endpoints from the Nuix RESTful Service, it is important to have your licensing properly configured. You can check if your license server has been properly configured by invoking the /v1/licenses endpoint. This endpoint does not require authentication.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/licenses'

[
    {
        "source": null,
        "type": null,
        "location": null,
        "shortname": "enterprise-workstation",
        "count": 10,
        "configuredCount": 10,
        "description": "Nuix eDiscovery Workstation",
        "workers": 10,
        "configuredWorkers": 10,
        "audited": false,
        "auditThreshold": 0,
        "expiry": null,
        "features": null,
        "legalHoldHoldCountLimit": null,
        "concurrentUserLimit": null,
        "canChooseWorkers": true
    }
]

Getting Started: Part 3: Authentication

Tue, 09 Feb 2021 00:00:00 +0000

Authentication

Now that you know your server is properly installed and configured, the first thing you will want to do is authenticate.

curl --location --request PUT 'http://localhost:8080/nuix-restful-service/svc/v1/authenticatedUsers/login' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
	"username":"username",
	"password":"password",
    "licenceShortName": "enterprise-workstation",
    "workers": 2
}'

{
    "username": "username", 
    "authToken": "9729a460-eda7-48dc-ba70-d12b3aae3c8d",
    "licenseShortName": "enterprise-workstation",
    "workersGranted": 2
}

Note

The licenceShortName and workers fields in the request body are optional. If they are excluded any license will be selected and 1 worker will be granted.

Note

Please note the authToken field returned in the response will need to be submitted in the nuix-auth-token request header field on all subsequent requests.

You have now successfully authenticated to Nuix RESTful Service!

Getting Started: Part 4: Case Creation

Tue, 09 Feb 2021 00:00:00 +0000

Nuix supports four types of cases. These are Simple, Compound, Elasticsearch, and Compound Elasticsearch cases. In this section, we will demonstrate how to create these case types.

Getting Started: Part 5: Ingestion

Wed, 10 Feb 2021 00:00:00 +0000

Ingestion

For the purposes of this example, we are going to use the following request to ingest the Nuix Engine documentation that is distributed as part of the Nuix RESTful Service installation. After performing the request, an asynchronous function key will be returned which can then be polled for status.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/evidence/file' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
   "processorSettings": {
   	"storeBinary": true
   },
   "target": {
    "path": "/Engines/9.0.0.171/doc"
  }
}
'

{
    "functionKey": "814388bb-d0fe-4a75-a4cb-02d1f46213e2", 
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/814388bb-d0fe-4a75-a4cb-02d1f46213e2"
}

Ingestion Status

The functionKey field returned from the ingestion endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/814388bb-d0fe-4a75-a4cb-02d1f46213e2' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
   "done":true,
   "cancelled":false,
   "result":true,
   "token":"db63fbfc-a5fd-494e-974b-cc17f6b2a56a",
   "functionKey":"814388bb-d0fe-4a75-a4cb-02d1f46213e2",
   "progress":7581225,
   "total":0,
   "percentComplete":null,
   "updatedOn":1612973812631,
   "status":null,
   "statusId":null,
   "requestTime":1612973782299,
   "startTime":1612973782299,
   "finishTime":1612973817411,
   "caseId":"43b070164ce8453ca30ed9e2dfcce67b",
   "caseName":"HelloWorld",
   "hasSuccessfullyCompleted":true,
   "friendlyName":"Evidence Ingestion Function",
   "caseLocation":"/Cases/HelloWorld",
   "requestor":"nuixadmin",
   "action":"AsyncBulkIngestionFunction",
   "options":{
      "reloadQuery":null,
      "processorSettings":{
         "processText":null,
         "processLooseFileContents":null,
         "processForensicImages":null,
         "analysisLanguage":null,
         "stopWords":null,
         "stemming":null,
         "enableExactQueries":null,
         "extractNamedEntities":null,
         "extractNamedEntitiesFromText":null,
         "extractNamedEntitiesFromProperties":null,
         "extractNamedEntitiesFromTextStripped":null,
         "extractShingles":null,
         "processTextSummaries":null,
         "calculateSSDeepFuzzyHash":null,
         "detectFaces":null,
         "extractFromSlackSpace":null,
         "carveFileSystemUnallocatedSpace":null,
         "carveUnidentifiedData":null,
         "carvingBlockSize":null,
         "recoverDeletedFiles":null,
         "extractEndOfFileSlackSpace":null,
         "smartProcessRegistry":null,
         "identifyPhysicalFiles":null,
         "createThumbnails":null,
         "skinToneAnalysis":null,
         "calculateAuditedSize":null,
         "storeBinary":true,
         "maxStoredBinarySize":null,
         "maxDigestSize":null,
         "digests":[
            
         ],
         "addBccToEmailDigests":null,
         "addCommunicationDateToEmailDigests":null,
         "reuseEvidenceStores":null,
         "processFamilyFields":null,
         "hideEmbeddedImmaterialData":null,
         "reportProcessingStatus":null,
         "workerItemCallback":null,
         "workerItemCallbacks":null
      },
      "evidence":[
         {
            "guid":null,
            "name":null,
            "customMetadata":null,
            "encoding":null,
            "custodian":null,
            "timeZone":null,
            "description":null,
            "locale":null,
            "files":[
               {
                  "path":"/Engines/9.0.0.171/doc"
               }
            ],
            "exchangeMailboxes":null,
            "s3Buckets":null,
            "sqlServers":null,
            "enterpriseVaults":null,
            "sharepointSites":null,
            "mailStores":null,
            "loadFiles":null,
            "centeraClusters":null,
            "splitFiles":null,
            "dropboxes":null,
            "sshServers":null
         }
      ],
      "localWorkerCount":2,
      "repositories":[
         
      ],
      "parallelProcessingSettings":{
         "workerCount":null,
         "workerMemory":null,
         "workerTemp":null,
         "brokerMemory":null,
         "workerBrokerAddress":null,
         "useRemoteWorkers":false,
         "embedBroker":true
      },
      "rescanEvidenceRepositories":false,
      "loadProcessingJob":{
         "casePath":"/Cases/HelloWorld",
         "jobGuid":"e22b159b-477e-41fe-878f-91984f60e3c9",
         "processingMode":"Load",
         "startDate":1612973784905,
         "workerCount":2,
         "finished":true,
         "paused":false,
         "masterAddress":"1.1.1.1",
         "bytesProcessed":7581225,
         "itemsProcessed":192,
         "jobSizeTotalBytes":0
      }
   },
   "participatingInCaseFunctionQueue":true,
   "processedBy":"nuix-restful-server-1",
   "errorMsg":null
}

Getting Started: Part 6: Asynchronous Functions

Thu, 05 Aug 2021 00:00:00 +0000

Asynchronous Functions

Asynchronous functions are used for long-running operations. Some examples of operations that return asynchronous function keys include:

Ingestions
Optical Character Recognition (OCR)
Bulk Operations
- Case Subset
- Exclude
- Include

Asynchronous Responses

An asynchronous response contains a function key and a location that can be polled for status. It has the following structure:

{
    "functionKey": "814388bb-d0fe-4a75-a4cb-02d1f46213e2", 
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/814388bb-d0fe-4a75-a4cb-02d1f46213e2"
}

Polling for Status

To retrieve the status of an asynchronous function, use the GET /asyncFunctions/{functionKey} endpoint. When polling for status, an AsyncFunctionResponse is returned. Asynchronous function responses have a set of common fields as well as a result field.

Note

The result field will be different depending on the return type of function.

All asynchronous functions have the following fields:

Field	Description	Examples
done	A boolean value indicating that the function is no longer running.
cancelled	A boolean value indicating if the function was cancelled.
result	The result of the function. This will differ based on the return type of the function.
token	The user token executing the function.
functionKey	A unique identifier for the function.
progress	The value of the progress indicator for the function. This will differ from type to type.
total	The value of the total progress indicator for the function. This will differ from type to type.
percentComplete	The percent complete for the function if available.
updatedOn	The time in milliseconds that the function was last updated.
status	The status of the function if available.	ABORTED, STOPPING, CANCELLED
statusId	A status identifier if available.
requestTime	The time in milliseconds the function was requested.
startTime	The time in milliseconds the function started.
finishTime	The time in milliseconds the function finished.
caseId	The case ID the function is executing on.
caseName	The name of the case.
hasSuccessfullyCompleted	A boolean value indicating that the function has successfully completed.
friendlyName	The name of the function.
caseLocation	The path to the case on disk.
requestor	The user who ran the function.
action	The function class.
options	The options for the function. This will differ from type to type.
participatingInCaseFunctionQueue	A boolean value indicating whether the function is participating in the case queue.
processedBy	The server ID that processed the function.
errorMsg	The error message if an error occurred.

Incomplete Function

A function that is still running will have the done flag set to false. The following response is truncated for brevity.

{
    "done": false,
    "cancelled": false,
    "result": null,
    "token": "6ddef3c9-b40e-45fa-9d96-03765ac0f7a8",
    "functionKey": "814388bb-d0fe-4a75-a4cb-02d1f46213e2",
    "caseId": "6d0029b6a9204d75a1812713571253f1",
    "caseName": "AsyncPolling",
    "hasSuccessfullyCompleted": false,
    "friendlyName": "Evidence Ingestion Function",
    "caseLocation": "/Cases/AsyncPolling",
    "requestor": "user1",
    "action": "AsyncBulkIngestionFunction",
    "participatingInCaseFunctionQueue": true
}

Completed Function

A completed function will have the done flag set to true. Additionally, if the function completed successfully, the hasSuccessfullyCompleted flag will bet set to true.

The following truncated example is of an Evidence Ingestion Function that completed successfully. This particular function returns a boolean, indicated within the result field with the value true. The licenseShortName used to process the data is also included in the response and in this example is enterprise-workstation. The progress field shows the number of bytes ingested. Lastly, the processedBy field shows the server ID of the server that processed the request.

{
    "done": true,
    "cancelled": false,
    "result": true,
    "token": "6ddef3c9-b40e-45fa-9d96-03765ac0f7a8",
    "functionKey": "814388bb-d0fe-4a75-a4cb-02d1f46213e2",
    "progress": 8453258,
    "updatedOn": 1628696051251,
    "requestTime": 1628695978730,
    "startTime": 1628695978749,
    "finishTime": 1628696053912,
    "caseId": "6d0029b6a9204d75a1812713571253f1",
    "caseName": "AsyncPolling",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Evidence Ingestion Function",
    "caseLocation": "/Cases/AsyncPolling",
    "requestor": "user1",
    "licenseShortName": "enterprise-workstation",
    "action": "AsyncBulkIngestionFunction",
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-2"
}

Getting Started: Part 7: Search

Thu, 05 Aug 2021 00:00:00 +0000

Search

Now that we have data in a case. Let’s search it. As part of a search we can specify a Default metadata profile to use. This will return the fields Name, File Type, and File Path for each item. Note that we can also limit the number of results returned using the request parameter numberOfRecordsRequested. In this example we are only returning 5 results at a time. The total number of hits was 364 as noted by the count field in the response.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v2/cases/43b070164ce8453ca30ed9e2dfcce67b/search?query=*&metadataProfile=Default&numberOfRecordsRequested=5' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "request": {
        "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
            "query": "*",
            "sortField": null,
            "sortOrder": null,
            "startIndex": 0,
            "numberOfRecordsRequested": 5,
            "deduplicate": null,
            "metadataProfile": "Default",
            "fieldList": null,
            "customMetadataList": null,
            "propertyList": null,
            "itemParameterizedFields": null,
            "showAvailableThumbnails": false,
            "useCache": false,
            "forceCacheDelete": false,
            "searchRetry": 0,
            "relationType": null,
            "entities": [],
            "p": 5,
            "s": 0,
            "customMetadataField": null,
            "field": null,
            "property": null
    },
    "startedOn": 1612985518529,
        "completedOn": 1612985518552,
        "elapsedTimeForSearch": 17,
        "elapsedTimeForSort": 0,
        "elapsedTimeForMarshal": 2,
        "elapsedTimeForDeduplicate": 0,
        "elapsedTotal": 23,
        "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": "Hypertext Markup Language Document",
            "Name": "allclasses.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "4350a26e-0582-4cdd-8903-feb2454b66ad"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "allclasses-index.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "48fdd676-ecdf-4271-8fb0-a312570888a5"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "allpackages-index.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "b5d26466-0b5f-4b01-bc2e-7ebe6c6d3294"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "index.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "8bc28b97-6d5a-4755-8066-4fa2102705de"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "constant-values.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "ee4cb26f-30b5-4a76-8789-dfbd7fdecf65"
        }
    ],
        "count": 364,
        "deduplicatedCount": 364
}

Paging

When limiting the numberOfRecordsRequested field, we need to page the result list. To get the next page of results set the startIndex request paramter equal to 5. Now we are retrieving the next 5 results.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v2/cases/43b070164ce8453ca30ed9e2dfcce67b/search?query=*&metadataProfile=Default&numberOfRecordsRequested=5&startIndex=5' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "request": {
        "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
        "query": "*",
        "sortField": null,
        "sortOrder": null,
        "startIndex": 5,
        "numberOfRecordsRequested": 5,
        "deduplicate": null,
        "metadataProfile": "Default",
        "fieldList": null,
        "customMetadataList": null,
        "propertyList": null,
        "itemParameterizedFields": null,
        "showAvailableThumbnails": false,
        "useCache": false,
        "forceCacheDelete": false,
        "searchRetry": 0,
        "relationType": null,
        "entities": [],
        "p": 5,
        "s": 5,
        "customMetadataField": null,
        "field": null,
        "property": null
    },
    "startedOn": 1612985803142,
    "completedOn": 1612985803161,
    "elapsedTimeForSearch": 13,
    "elapsedTimeForSort": 0,
    "elapsedTimeForMarshal": 2,
    "elapsedTimeForDeduplicate": 0,
    "elapsedTotal": 19,
    "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": "Ini Style Configuration File",
            "Name": "member-search-index.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "a5ee8532-868e-4abf-bc74-c066e82f234a"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "deprecated-list.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "be263fae-48e5-4c3f-bcd1-3c354960173b"
        },
        {
            "File Type": "JSON Data File",
            "Name": "member-search-index.json",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/member-search-index.zip",
            "guid": "ae36f963-93c6-43b4-b359-70f9e937d197"
        },
        {
            "File Type": "Plain Text",
            "Name": "element-list",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "a6230532-2bff-445a-9fa3-9a683dcbaadc"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "overview-summary.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "d5ead71c-08ac-49f9-a27c-ee2257706c63"
        }
    ],
    "count": 364,
    "deduplicatedCount": 364
}

Getting Started: Part 8: Exclusions

Thu, 05 Aug 2021 00:00:00 +0000

Exclusions

As part of the culling process, it is sometimes necessary to exclude items from your case. For this example, let’s exclude all Javascript files (*.js) from the case using the excludedItems endpoint.

curl --location --request PUT 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/excludedItems' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
  "excludeDescendants": true,
  "includeDuplicates": true,
  "includeFamily": true,
  "includeNearDuplicates": true,
  "nearDuplicatesThreshold": 0,
  "query": "file-extension:js",
  "reason": "Exclude script files from the case"
}'

{
    "functionKey": "575f4966-1103-43fb-b6bb-03f52b7b3022",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/575f4966-1103-43fb-b6bb-03f52b7b3022"
}

Exclusion Status

The functionKey field returned from the excludedItems endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/575f4966-1103-43fb-b6bb-03f52b7b3022' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": true,
    "token": "37741b6c-43e2-49d1-9354-04bd397984b5",
    "functionKey": "575f4966-1103-43fb-b6bb-03f52b7b3022",
    "progress": 1,
    "total": 1,
    "percentComplete": 100.0000,
    "updatedOn": 1613578572593,
    "status": null,
    "statusId": null,
    "requestTime": 1613578565663,
    "startTime": 1613578565663,
    "finishTime": 1613578572594,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Bulk Exclude Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "username",
    "action": "AsyncBulkExcludeFunction",
    "options": {
        "exclusionName": "Exclude script files from the case",
        "query": "file-extension:js"
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-1",
    "errorMsg": null
}

Verifying Exclusions

Let’s verify the items have been excluded from the case using the search endpoint.

Note

The search endpoint will return ALL items regardless of whether they have been excluded. It is the responsibility of the client to exclude items from search. This can be done by appending an exclusion suffix to the query. For example, tag:HTMLFiles AND has-exclusion: 0.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v2/cases/43b070164ce8453ca30ed9e2dfcce67b/search?query=has-exclusion:1&metadataProfile=Default&numberOfRecordsRequested=100' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "request": {
        "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
        "query": "has-exclusion:1",
        "sortField": null,
        "sortOrder": null,
        "startIndex": 0,
        "numberOfRecordsRequested": 16,
        "deduplicate": null,
        "metadataProfile": "Default",
        "fieldList": null,
        "customMetadataList": null,
        "propertyList": null,
        "itemParameterizedFields": null,
        "showAvailableThumbnails": false,
        "useCache": false,
        "forceCacheDelete": false,
        "searchRetry": 0,
        "relationType": null,
        "entities": [],
        "s": 0,
        "p": 16,
        "customMetadataField": null,
        "property": null,
        "field": null
    },
    "startedOn": 1613579723060,
    "completedOn": 1613579723087,
    "elapsedTimeForSearch": 13,
    "elapsedTimeForSort": 0,
    "elapsedTimeForMarshal": 10,
    "elapsedTimeForDeduplicate": 0,
    "elapsedTotal": 27,
    "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": "Plain Text",
            "Name": "jquery-3.3.1.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery",
            "guid": "192d4465-4120-4f70-9ecc-21e75fa00fdb"
        },
        {
            "File Type": "Ini Style Configuration File",
            "Name": "member-search-index.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "a5ee8532-868e-4abf-bc74-c066e82f234a"
        },
        {
            "File Type": "Plain Text",
            "Name": "jszip.min.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery/jszip/dist",
            "guid": "fae2d24a-d398-46e1-aad1-2d3ba315680e"
        },
        {
            "File Type": "Ini Style Configuration File",
            "Name": "package-search-index.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "985bf725-9480-407c-a149-6295dbbff792"
        },
        {
            "File Type": "Plain Text",
            "Name": "jszip-utils-ie.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery/jszip-utils/dist",
            "guid": "0734cf5b-626b-48ee-accb-feae91f6d333"
        },
        {
            "File Type": "Plain Text",
            "Name": "script.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "edf629f6-2183-4b61-8ab5-cc38ee6c2fe6"
        },
        {
            "File Type": "Plain Text",
            "Name": "jszip-utils-ie.min.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery/jszip-utils/dist",
            "guid": "2f014b44-1f68-4604-aa91-16aa9b03df45"
        },
        {
            "File Type": "Plain Text",
            "Name": "search.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "3c284b55-d0e3-414a-93b6-549b3483c090"
        },
        {
            "File Type": "Plain Text",
            "Name": "jszip-utils.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery/jszip-utils/dist",
            "guid": "11b2e9cd-b61c-4b0b-9977-c0140c8d3ee8"
        },
        {
            "File Type": "Ini Style Configuration File",
            "Name": "type-search-index.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "d5d111b5-eda3-40bb-ac55-ae9c5267e1ee"
        },
        {
            "File Type": "Plain Text",
            "Name": "jszip-utils.min.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery/jszip-utils/dist",
            "guid": "25662c95-f31d-4ccf-8cde-f30d3d209801"
        },
        {
            "File Type": "Plain Text",
            "Name": "jquery-migrate-3.0.1.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery",
            "guid": "7f53b31e-dbb6-40a8-9094-c95ed8b26ee5"
        },
        {
            "File Type": "Plain Text",
            "Name": "jquery.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery/external/jquery",
            "guid": "1dfd0e2f-1c60-4e59-b5d4-8afeba538368"
        },
        {
            "File Type": "Plain Text",
            "Name": "jquery-ui.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery",
            "guid": "76e84607-0fed-423a-a8e8-bcd3ae41738e"
        },
        {
            "File Type": "Plain Text",
            "Name": "jquery-ui.min.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery",
            "guid": "3c0cc58f-5b3f-40fb-8aec-6176126bd855"
        },
        {
            "File Type": "Plain Text",
            "Name": "jszip.js",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api/jquery/jszip/dist",
            "guid": "2613381e-a406-4e3e-afaa-f0366f818887"
        }
    ],
    "count": 16,
    "deduplicatedCount": 16
}

Viewing Exclusion Reasons

We can retrieve the list of exclusion reasons from a case using the exclusions endpoint.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/exclusions' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

[
    "Exclude script files from the case"
]

Getting Started: Part 9: Item Sets and Deduplication

Thu, 05 Aug 2021 00:00:00 +0000

Item Sets

An item set is a collection of items that have been classified as originals or duplicates based on whether there are multiple items with the same hash value. For the purposes of this tutorial, let’s ingest the Nuix Engine documentation into this case again for a second time, create an item set, and deduplicate the items.

Ingestion of Duplicate Data

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/evidence/file' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
   "processorSettings": {
   	"storeBinary": true
   },
   "target": {
    "path": "/Engines/9.0.0.171/doc"
  }
}
'

{
    "functionKey": "2322f9d3-678b-4ff4-b2bd-3a04d61510cb",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/2322f9d3-678b-4ff4-b2bd-3a04d61510cb"
}

Ingestion Status

The functionKey field returned from the ingestion endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/2322f9d3-678b-4ff4-b2bd-3a04d61510cb' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": true,
    "token": "1091c265-fce6-44ff-b5d4-3a30ff5273fa",
    "functionKey": "2322f9d3-678b-4ff4-b2bd-3a04d61510cb",
    "progress": 7581225,
    "total": 0,
    "percentComplete": null,
    "updatedOn": 1613591215161,
    "status": null,
    "statusId": null,
    "requestTime": 1613591186910,
    "startTime": 1613591186910,
    "finishTime": 1613591217939,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Evidence Ingestion Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "username",
    "action": "AsyncBulkIngestionFunction",
    "options": {
        "reloadQuery": null,
        "processorSettings": {
            "processText": null,
            "processLooseFileContents": null,
            "processForensicImages": null,
            "analysisLanguage": null,
            "stopWords": null,
            "stemming": null,
            "enableExactQueries": null,
            "extractNamedEntities": null,
            "extractNamedEntitiesFromText": null,
            "extractNamedEntitiesFromProperties": null,
            "extractNamedEntitiesFromTextStripped": null,
            "extractShingles": null,
            "processTextSummaries": null,
            "calculateSSDeepFuzzyHash": null,
            "detectFaces": null,
            "extractFromSlackSpace": null,
            "carveFileSystemUnallocatedSpace": null,
            "carveUnidentifiedData": null,
            "carvingBlockSize": null,
            "recoverDeletedFiles": null,
            "extractEndOfFileSlackSpace": null,
            "smartProcessRegistry": null,
            "identifyPhysicalFiles": null,
            "createThumbnails": null,
            "skinToneAnalysis": null,
            "calculateAuditedSize": null,
            "storeBinary": true,
            "maxStoredBinarySize": null,
            "maxDigestSize": null,
            "digests": [],
            "addBccToEmailDigests": null,
            "addCommunicationDateToEmailDigests": null,
            "reuseEvidenceStores": null,
            "processFamilyFields": null,
            "hideEmbeddedImmaterialData": null,
            "reportProcessingStatus": null,
            "workerItemCallback": null,
            "workerItemCallbacks": null
        },
        "evidence": [
            {
                "guid": null,
                "name": null,
                "customMetadata": null,
                "encoding": null,
                "custodian": null,
                "timeZone": null,
                "description": null,
                "locale": null,
                "files": [
                    {
                        "path": "/Engines/9.0.0.171/doc"
                    }
                ],
                "exchangeMailboxes": null,
                "s3Buckets": null,
                "sqlServers": null,
                "enterpriseVaults": null,
                "sharepointSites": null,
                "mailStores": null,
                "loadFiles": null,
                "centeraClusters": null,
                "splitFiles": null,
                "dropboxes": null,
                "sshServers": null
            }
        ],
        "localWorkerCount": 1,
        "repositories": [],
        "parallelProcessingSettings": {
            "workerCount": null,
            "workerMemory": null,
            "workerTemp": null,
            "brokerMemory": null,
            "workerBrokerAddress": null,
            "useRemoteWorkers": false,
            "embedBroker": true
        },
        "rescanEvidenceRepositories": false,
        "loadProcessingJob": {
            "casePath": "/Cases/HelloWorld",
            "jobGuid": "3658161a-2a7d-423c-b288-0f839f2da367",
            "processingMode": "Load",
            "startDate": 1613591191176,
            "workerCount": 1,
            "finished": true,
            "paused": false,
            "masterAddress": "1.1.1.1",
            "bytesProcessed": 7581225,
            "itemsProcessed": 192,
            "jobSizeTotalBytes": 0
        }
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-1",
    "errorMsg": null
}

Create an Item Set

Let’s go ahead and create an item set. By default, items are deduplicated by their MD5 hash.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/itemSets' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
	"name": "HelloItemSet",
	"description": "My first item set"
}'

{
    "functionKey": "12d214b2-d4fc-4f6d-8142-b33df4c18f89",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/12d214b2-d4fc-4f6d-8142-b33df4c18f89"
}

Item Set Status

The functionKey field returned from the ingestion endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/12d214b2-d4fc-4f6d-8142-b33df4c18f89' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": true,
    "token": "1091c265-fce6-44ff-b5d4-3a30ff5273fa",
    "functionKey": "12d214b2-d4fc-4f6d-8142-b33df4c18f89",
    "progress": 730,
    "total": 730,
    "percentComplete": 100.0000,
    "updatedOn": 1613591533221,
    "status": null,
    "statusId": null,
    "requestTime": 1613591533023,
    "startTime": 1613591533023,
    "finishTime": 1613591533501,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Item Set Creation Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "username",
    "action": "AsyncItemSetCreationFunction",
    "options": {
        "itemSetName": "HelloItemSet",
        "batchName": null,
        "itemSetDescription": "My first item set",
        "dedupByArg": null,
        "itemSetContructionQuery": "",
        "custodianList": null,
        "dedupArg": "MD5"
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-1",
    "errorMsg": null
}

Adding Items to an Item Set

Next, we are going to add our items to the item set and deduplicate.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/itemSets/HelloItemSet/items' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
	"batchName": "AllItems",
	"query": ""
}'

{
    "functionKey": "9490cb69-508b-43a2-8e60-351e42c7db4d",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/9490cb69-508b-43a2-8e60-351e42c7db4d"
}

Add Items Status

The functionKey field returned from the add items endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/9490cb69-508b-43a2-8e60-351e42c7db4d' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": true,
    "token": "1091c265-fce6-44ff-b5d4-3a30ff5273fa",
    "functionKey": "9490cb69-508b-43a2-8e60-351e42c7db4d",
    "progress": 0,
    "total": 730,
    "percentComplete": 0.0000,
    "updatedOn": 1613592046841,
    "status": null,
    "statusId": null,
    "requestTime": 1613592046840,
    "startTime": 1613592046840,
    "finishTime": 1613592046898,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Item Set Add Items Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "username",
    "action": "AsyncItemSetAddItemsFunction",
    "options": {
        "itemSetName": "HelloItemSet",
        "batchName": "AllItems",
        "itemSetContructionQuery": ""
    },
    "participatingInCaseFunctionQueue": false,
    "processedBy": "nuix-restful-server-1",
    "errorMsg": null
}

Item Set Details

Let’s retrieve some details about the item set we just created.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/itemSets/HelloItemSet' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "name": "HelloItemSet",
    "description": "My first item set",
    "batches": [
        {
            "batchName": "AllItems",
            "createdOn": 1613592046847
        },
        {
            "batchName": "21/02/17 14:52:13 EST",
            "createdOn": 1613591533141
        }
    ]
}

Item Set Duplicates

Let’s retrieve the duplicate items from the item set. There are 344 duplicates in this item set.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/itemSets/HelloItemSet/duplicates' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "duplicates": [
        "192d4465-4120-4f70-9ecc-21e75fa00fdb",
        "69204627-94dc-441a-a285-ba30ba5889f9",
        "50ce3b7d-8eb5-49a5-af5b-0ad69367b8f5",
        "5cd8a487-37e9-43b3-aec3-1f5b47a18f52",
        "6392ced4-f3af-4978-a61a-a1543bdbf235",
        "59585660-9ade-4856-950d-fb606a6f9dd5",
        "615768ce-8421-42a2-a9aa-e2e38323073f",
        "d4fc148f-db20-4a56-89e0-c1689fe920cd",
        "33dcbb88-eb12-40f5-aab4-fbf1fa56194f",
        "d7eec968-5034-4c82-a16a-a2ab0004b2e4",
        "1ba9ae97-c48c-42eb-a640-5395fd6a9947",
        "cd147740-2323-4b8c-8302-75b8d1152062",
        "7d93b4b9-49c2-42d8-8f4e-becbf06a2f7d",
        "e7cf0ef5-3863-4b9b-b056-b2db5662ec40",
        "fb0a2f1c-f605-48d3-97ca-2eacbb819b7b",
        "49e1273a-dc20-4ab5-a844-c947c24ff653",
        "d0689df1-b19e-45e8-87f9-f603a4e6229a",
        "2d2beb9d-9a8a-4c86-a06c-d0c8b780929f",
        "f5be4e17-b3d0-427c-9e45-228d1401f62c",
        "36b5af07-d640-49c8-89d2-6982bd9ce2e8",
        "5909249c-f595-49a0-9083-8dbb7aa9adef",
        "b0a336df-7160-4e34-9c67-0c52f305f60e",
        "70a65d83-f82f-4d98-ad63-301a93d5a62d",
        "421b9636-d756-453e-b4ae-011df0bb3a40",
        "3aa3110a-f877-4d9f-9e45-6e5c84ee7b03",
        "3943799e-eb7c-4215-bf01-1748fcfb7c35",
        "d965949d-34bb-403c-ae0a-c5a43c229574",
        "98da888b-7e03-4a78-bcc2-0e53087ff45b",
        "e797ff62-086e-40a7-a08f-4a1acc989d12",
        "def5ba51-1c23-4f2b-9e85-5a6ce76a015d",
        "641d4627-1c5a-4b29-86ff-deb63d682da9",
        "354e021f-a375-47be-9379-638ee14d6dd0",
        "02c32fdf-2f5f-4d65-95aa-64ea73d301c5",
        "5c05e778-f348-4c1a-80d1-d25563a51a6c",
        "cdf87e96-6ba6-4fca-9d74-54dbf9849c69",
        "82547af3-8eb6-401f-9264-d81314864f52",
        "9aae6735-3e64-4047-9e10-8260d8dd61db",
        "8f430563-6c7d-4870-81d3-f206735eb0e8",
        "7d57b451-2bd6-4128-aade-137839abccf8",
        "f15f6647-ee54-435e-8627-c1617d7e4a5b",
        "6ed745e9-7c3f-4323-90f3-510d49e081fa",
        "3eb87859-b52e-4c29-81fa-3d1e9adcd488",
        "5afb1fdb-d363-4da0-add9-d86825e28a3c",
        "80620833-afb1-45e0-9384-337dec5028d0",
        "1fed7de1-d150-4cf6-b5aa-eb2e5f87058d",
        "3099fd8e-2633-4071-97fc-3a337a954fda",
        "25c0b8dc-c783-4ad2-adc6-b2f303ed92da",
        "f1b05001-3b14-4c85-b07c-e6aa9a49d611",
        "c8fb7bc7-600b-4fd0-80e2-114a97c87f9b",
        "e22cdd4d-2cea-463c-893c-e3bf55e2ec5a",
        "1d5845dd-8f42-4aa0-9fc9-60028b846126",
        "596e9178-e3b5-474c-bcce-bd26af84174b",
        "81f69274-3707-4d03-8608-1e4a3a7ab8ac",
        "77897169-4839-4ff8-bfde-f5be066f7bb6",
        "48783fea-ed1e-4da4-afb4-e4e13168b77b",
        "62877335-b628-4f2c-951f-beb64e9221e7",
        "accce1a5-c5ff-498f-88a8-987d662c8f98",
        "5b07a955-fdcb-409a-a3b6-a6be82b80652",
        "24a64dfc-6a10-41f9-9912-3ba32a482e1e",
        "2ff5b86c-7d80-488b-bee9-564a8df3d05b",
        "8edbe74e-f3f7-44e5-9bb8-86364069e82c",
        "966da79b-abaa-4c7a-a55e-169d598e1cb2",
        "70f97097-e8c8-4e07-af68-3dc5733170ea",
        "d8918e4c-bca9-4426-9637-cde92619f4c2",
        "011d60e8-6ea2-4590-82ec-7ca1e809b6d5",
        "a32a3ac8-8df3-4836-9a94-5a9cc1e50791",
        "9ffd7d91-8c01-49f3-892c-bf86e9ccb176",
        "d78913f2-d9e5-481c-8bad-0d6632022e03",
        "45233604-6d08-4684-bf21-b96ed6c6bf0c",
        "48bea607-903e-40cc-968f-7940536f9553",
        "060af451-7949-4ae9-a35b-c4bdae9347f9",
        "51933023-0e3d-4d17-9804-5bfe125ddbaa",
        "6c1f742a-2f09-4b72-bf5b-ca226d49e2a6",
        "c0ed30f7-2451-45af-9af0-6ded2a2211cf",
        "e1b8a691-3a14-4648-b9d5-d4e1057cc0f8",
        "0f2a5eed-5843-450a-8207-4712c4e1bafb",
        "bb1d853d-b4a0-47bf-9aa0-092631bde92b",
        "90f2b351-0fd9-4257-99aa-243294515067",
        "3d26cf69-a12c-45b4-b464-17b0a225213e",
        "16f852e0-ffe8-4acd-92c5-68535f51d3f5",
        "9ad7d617-a6cd-42e3-8871-b133f102945a",
        "a046d0a1-eff4-40ec-9eda-fea5ef30c914",
        "5dc0b129-ffa1-4367-9a92-d322a8b2569b",
        "ace342cd-3f1e-463b-a5a3-3be751362227",
        "7401ef1e-eb92-4132-9c88-059a53a52ccf",
        "9f7f2dcd-0578-4c9f-891e-39fadd7c872e",
        "7163b094-4e5e-4a6b-9058-0c723f464a3a",
        "bd7afaf5-99e6-4e1d-8951-a7f291160b5c",
        "12329d30-93b1-46fa-872c-9b27f571050e",
        "5b8a3812-16d5-45d6-bceb-85b639a34a1e",
        "a68939f0-502c-482a-bf3a-68bc0d4a5a7d",
        "9d2c8516-4d6e-4056-a512-f5421fb6e4c7",
        "5655c3ec-1ed7-4a07-8862-62826de5320d",
        "a9e2dad3-1e14-4e99-b91f-7dffbd8a06e9",
        "fa40773a-c889-4f04-8066-b3dce8d3cef0",
        "15e575fb-fcf9-445e-b165-64f1c55354a1",
        "befb11ed-0851-4e21-8089-8e11562721fc",
        "3afa6979-4039-4b48-8303-c683c163cc4a",
        "4dc31d4b-0fe5-43cf-be45-0a993307e2b7",
        "0dba92f2-9098-4ef3-a4f8-b43f1de44b47",
        "a93485a2-c9b6-439f-a35d-a2f2143f2870",
        "f0e13f75-0b47-4369-8e10-94676b01bba4",
        "69b19079-2baf-47e0-9c5a-c4919225b4ac",
        "68e04266-6e0a-49d8-ae2d-51428b349d93",
        "ff7374b0-5e60-4603-8026-08e0b0f657f9",
        "1b427285-83a5-46eb-97db-0c09b5734b66",
        "eb6fef94-d43e-4916-9b11-12704b531f03",
        "a611ca69-7d1d-4736-a6a3-05cbca76bc16",
        "8c2d3f75-2f27-4e22-80df-900b3b004de0",
        "37f04030-03aa-4d4e-9b38-6836465944c6",
        "0a80c14f-f299-4985-9366-c7d5f112d595",
        "fded93d5-49ef-4d25-a581-9b9eab8a7255",
        "2b0d8e22-a7c6-43f2-825e-1eece4b9cfbf",
        "33c9fbea-5151-42c7-be04-871adddb7e12",
        "be2bc1bc-ccf1-4d0b-a1e3-011258e2dcfe",
        "f5a9e1e3-0b4c-4b97-b2e2-ece62a02e750",
        "ea233053-720e-4bc2-9898-51d99707fd1f",
        "f5ffbedf-b5e4-4274-8572-77e5655feb26",
        "5b7b695f-6b69-4b77-80cb-95e31f74b108",
        "7082f088-e558-4f5b-9ae8-418db1e1a3b1",
        "91738acd-8f4d-4ac5-874a-5ef97e3bdd05",
        "74a80c52-1649-4af4-a230-3effd3f89f06",
        "845ec518-629a-41ba-aa5e-05d41fc079ad",
        "ecdfe041-7e28-4159-ad11-95bb74680e43",
        "f1801614-7286-4a76-a9ac-0e1d5c8ec25c",
        "cd1172bd-1edb-4e66-bbd6-0f7a30cfd869",
        "8e1b2483-2924-4961-8d01-5e8228f2a1bf",
        "b518a531-1fb5-4d6d-9608-940a57b59c02",
        "53eed8ec-7204-4da7-8179-0c0f6fb276ab",
        "1305823c-272f-4e6f-b1b2-19b8bd2e1da2",
        "4d27d90c-597d-47b6-bec5-10ec58f76929",
        "914ea784-706c-4da4-b138-bb6e81939ac6",
        "77219f44-f9b3-4636-8f40-c485f0b1386a",
        "2c91111f-776f-49db-a260-f30b00729ad2",
        "d95adc83-2051-486e-8c22-ab9ad9b9b856",
        "7afbc31f-9d76-4bce-a185-ae3e28f690f4",
        "5a048e18-d437-4be9-baa1-fd8b4f5e08f3",
        "f466612d-bbeb-4739-a895-a6a8e1f74832",
        "4eaca35e-0adc-4996-a52b-1114ee85170e",
        "875df35a-aedb-43f2-aca5-7cd3b87fc2e5",
        "00ae438b-5547-4495-94c1-c3a4cec30829",
        "7f43d3b0-2840-4e4c-8cb0-21d27de6d181",
        "2571bb06-3a07-4633-ad07-802c6ab60242",
        "f593a196-d6c5-43ee-8672-e4c470bb01e6",
        "c9c0daaa-df79-424a-8e08-51b0b3947783",
        "dfcfa2d3-3823-43e0-b07d-d609daa41451",
        "a568caec-05e4-4fde-b952-39f8df69eb0e",
        "d582ee4c-9246-466c-96a3-2b174c462169",
        "f9d0e1b9-2150-41c1-8af6-3301000d3ebb",
        "cc720409-02a5-46cf-9fa2-9ab05b0da254",
        "46763e9c-243b-43c5-87a9-f3e9c8a1fcab",
        "e5fcf39b-bce8-49bb-abe7-063422d9f752",
        "08d89c1d-f1e0-4a28-81f1-e7c72217d71f",
        "4b191168-c260-4d09-a2e2-ec9df3cdb47b",
        "1944dbf4-ff4f-46d8-b15b-aee2ba5b0a60",
        "48a6181e-55ce-455b-a29b-59195b73a31d",
        "bbc7b8b9-9838-4404-9359-37c2a5750670",
        "59c0ad6e-d6a2-4dd9-8462-1a48568ca75f",
        "ea651780-173a-451d-b0eb-882ce356c545",
        "267242a0-95a0-4a20-a64f-1779d8d605ac",
        "d2fb2fe0-94d7-4185-a8e9-f0b8c78ecba2",
        "e50ce77b-e07e-4c90-8216-c572e6f7af87",
        "a4a1ef9e-f1e2-4745-afef-23ab7ce13ca0",
        "58cfa2d7-41b7-4156-9d1e-f7ef14c4f924",
        "531273a9-5e9f-42e3-863e-85ae1308d7d6",
        "1ade2935-089e-4260-a3ed-55418746e848",
        "c2d8c530-d96d-436c-bc2a-d279276b5ae2",
        "9694266a-6950-4bff-97e4-ed1aabb38cc1",
        "888512af-2564-4ef7-ab7b-87997a33041d",
        "e27dd502-3d55-4b93-b006-51531ada6886",
        "02259947-ff53-4c41-ad92-ebae6bc10841",
        "dece6369-361b-46e8-a3bf-e0012a3407b3",
        "cee2bb44-2306-4077-be25-ed3539285fa0",
        "6d21e34b-96f6-4009-8c87-5b77c5693b22",
        "d7ac1c40-7581-4df9-a9d8-064affdc5bfc",
        "bb2cbf39-fc89-42a0-b076-7153020cae76",
        "be55540c-699c-4d67-abb9-1cc4405ae92d",
        "20935378-c0ed-49b8-ac5c-144f6c298520",
        "56061170-6d14-4be9-9956-9abdc8319622",
        "5564662f-58b1-4e9e-970a-551593b87321",
        "00605178-da28-4e22-804e-9d68c18d2852",
        "89157531-b38b-4366-89df-eaf8568c4a24",
        "d96c1bb1-8f4b-46f0-9f0f-db954d2e594a",
        "6b1fab8f-9a35-4e47-8b8b-6d8fea2ac42a",
        "eca63772-7be1-4ea8-8219-7416848ec249",
        "fe7bb180-696f-4dee-88e3-f223872974c6",
        "ae8d40d5-6ad1-4698-ad17-0b418d8fb52c",
        "ba9cc861-3609-4ca6-88d8-43a3fb9cb728",
        "5cc8867d-2fcc-4724-b4f6-fd738ba1c671",
        "99a1979d-cb2b-42e0-b67b-e9059ff5137f",
        "fd35756a-ebec-4784-9588-449b8600010d",
        "33362229-520a-45c1-b843-2072ee029ce5",
        "4306b9b7-d37d-461a-b88e-fd2370989c51",
        "ac645149-f832-4af7-8b91-47aa5f72d3c4",
        "c7d03133-060d-46a4-ad63-59c57eb2144a",
        "f3f197af-84ec-4aaf-af8a-116f30531f5b",
        "2162cbcb-9ece-422a-821c-12f1b1de2e8c",
        "1053bffc-5646-4b4f-bc95-1ba843b6088d",
        "b6a21b72-a9b1-42cc-8b4c-c34f9e454c66",
        "a736384b-89e4-4284-9f71-e1843a9d478b",
        "afcdb5fb-36be-44b1-9320-501d7f487355",
        "a222f874-d5f5-46f5-9454-75a5e6d808cb",
        "41ccc128-0991-4d4f-accf-70ad2ea41d95",
        "5ff74eba-f3cc-4a3a-98b9-066b2886c2c8",
        "6c248e89-94bc-4255-84c7-cb09a42e086c",
        "d1773f81-601c-43e2-9f1e-d978e5e09656",
        "21b7aa8a-c7cf-4847-8bff-07eaa570e8a0",
        "f0d0944e-34f4-4b8f-b072-69cb740f47a9",
        "4b39aa39-5d56-4408-955d-141e5c4d181f",
        "9cd57e88-35e3-42dd-99a1-16a7f21949ee",
        "12f24503-c781-4678-8cc1-6ddf49af2ed2",
        "c1bc2518-1c61-4c5c-8d45-35ff256c66f4",
        "722d206c-a4e5-4350-9c44-0cb6092cf9c7",
        "bf6479ab-21a1-4e4a-ba47-1bc36d853efb",
        "7709e135-e5b5-4558-8946-1787b92d5260",
        "5a614ed9-a292-45c6-819a-720f3741661a",
        "8755246b-8ec6-4a63-aee6-ee1caab0721d",
        "6ff0011e-3a9c-4150-9688-4932b7c1ba78",
        "c117a2d9-a3aa-4932-bbff-c6e6b6da1bc0",
        "38277004-af1c-488b-b326-684d01b9757b",
        "d26cf5fb-219d-48fe-bc37-5fe83890913d",
        "c0783a0c-f76f-4dcb-aaae-4949194d87a3",
        "b895106e-2f76-4355-8a2d-f44dfb7a75bd",
        "0348a75d-4609-43c9-8944-f3efb8ca2a4b",
        "b14ba50c-5cbd-4c8e-b14e-9982e3ad2a33",
        "8dbac113-563b-45ee-a9c8-37c272ab0da3",
        "862b5b45-950b-4f62-9ab9-6c53fcbf17d6",
        "3e3bb8bb-09ac-48e1-a059-bb852f2a68b7",
        "533ab1a0-6b03-41d9-9dd2-fb416ebbdaa4",
        "529d6c44-7d35-4182-9a21-6a5a2077748b",
        "dd67e6f4-5a0e-402f-bb95-e332a5bccd94",
        "fd0352de-1315-4abb-9111-fa4fe1751013",
        "e51a282e-7d74-4146-9456-fa2f9932db6e",
        "ec108563-d0d8-4005-bb61-46439de8d667",
        "3b9b0e34-dea3-4f74-83df-1af53f70056e",
        "fc50a41e-1bb1-451e-860b-f04ce1508ba5",
        "89275ca0-6170-43e9-9d91-8c7fe9ec0464",
        "3a3e36e7-1302-4f0b-abb3-85c2c96cc89c",
        "3aaf1277-ab4b-4c34-9b6a-5246a32e4d02",
        "00b4cc85-6d22-4b94-8854-1fc0b2056d1e",
        "bcf489ef-dec8-4bb6-960d-e848335c851d",
        "25bfa985-1742-4ca2-9f63-63d7717345de",
        "66518129-37d6-4614-be18-631de52e2f8a",
        "d8169b84-6e64-41a3-a6dc-64efb351cecb",
        "6ad10241-f5ed-4d24-b533-7fe593209430",
        "850447f3-b22a-45ea-83ee-e612ef9b14e6",
        "dccad404-fe95-4f8a-a739-6c1c576093cf",
        "ef4debf1-70fc-4448-a001-8f0d461b786a",
        "dd8d7ab7-bc62-4ed7-a690-a8eb717117fe",
        "41d63136-b1e8-421d-be0f-037d73a8690d",
        "26ed1ca7-7190-43ff-ad91-f062bd4432aa",
        "e2db1c03-2205-43f7-888b-3a2708f8e8a4",
        "ae50c435-d2d4-4f9b-a358-b1c0bfccee17",
        "73826713-5619-4207-995b-229133775ec3",
        "cf7a498b-a96f-44eb-8b36-a829802664b6",
        "24c90145-ad7d-47ab-b4f4-cba6df24a662",
        "59ade687-aaaf-457c-b8c9-f9537a6ad4f9",
        "cbd05bc5-142e-4429-a8de-3b14418dd980",
        "3b8217d1-0e9b-4e85-acd4-658c581fa9f4",
        "e89dc911-0922-4aa4-8d54-83f39e1083b5",
        "f7065a52-45eb-4d30-acf2-b3470bf8a58e",
        "11e864ee-f1e0-4160-a6c3-20553dccf761",
        "b5ba63d7-60e2-4d71-9e44-0652d9610765",
        "70643357-2142-47be-98bf-660c96be806e",
        "daf0312d-5cc9-474a-9854-4dc8a7660b20",
        "4ba29be6-b125-4624-8957-c9233268c447",
        "4c6c802e-2898-4829-82aa-d5f62a17873b",
        "75cef09b-9592-4f38-a1fd-7911ac644195",
        "51762c95-9192-4810-81b2-110bf2c5915d",
        "b066b177-53f5-4bbe-8afc-0df7124d03ea",
        "e8551f36-317e-4718-8425-6827e0656f72",
        "3d83138c-9ea9-4381-af11-bb1ebdd8c321",
        "c9b6632a-a5b9-4a78-86bb-460559006290",
        "b9651bed-a163-4110-a998-8ebfebd0b4de",
        "51102838-ef06-4e1f-87bc-f726daa76d86",
        "bb6828c2-9d0b-4f95-a479-c8df06752fea",
        "96d40ca3-e41b-4a60-878c-e4f377ead0a9",
        "5b212c18-a5fc-42e9-b738-0eca4db5a79b",
        "60b0c015-7797-426e-8fec-7d663db35375",
        "bd49a135-5799-40f2-b245-4641905cf317",
        "6263d314-b3e8-4573-b7ab-48d5deeec3b6",
        "6d103232-2269-4275-a1e3-2eb9079fcd53",
        "913e1d3e-786c-4f3a-b27c-9b92b7e2300f",
        "897ea5d9-0e32-47ee-a3ba-6de93ccf213e",
        "f25288fc-7ed2-44f2-94a8-22892a8c2e30",
        "03f335a8-62b2-4199-a464-d541015d9b24",
        "a5960fe9-cbc3-4aa3-8878-bbd144b1803e",
        "f28cd50d-f73b-4954-84a5-af7efa81f4aa",
        "5872e56d-8698-44a7-afec-673c5d31cc23",
        "77c7dad8-99aa-4555-b2bf-2173f3e894a8",
        "db7d4c77-45ea-4e5f-8ece-f1fae9c3da1f",
        "21f11d05-8877-4314-bd96-5619d5f9055e",
        "4b698d27-04a0-4dfe-881d-f6baeac6efbd",
        "51ec29f1-bb27-4a36-b143-e6230762aa75",
        "28b42916-32f2-4735-864d-8c83d16b0faf",
        "75be53d0-9ecc-4920-98bc-ff4672f71576",
        "f42ead25-6085-4cde-9d02-80fdc4b1c560",
        "07679a57-21d9-4405-bccd-980c36305703",
        "852afa09-6a0f-4cd8-b4b6-23537d28e5db",
        "10501808-adf3-497c-9f89-40174d8ce843",
        "f3858449-dfe3-4754-bc64-afb7cdd3a806",
        "4c2f890e-6671-4aa3-8b85-a50a4500b2d7",
        "641911f6-a5d0-4065-82d2-fbae4d8faa17",
        "836a3258-0f12-4559-ad33-621fbc6e8e02",
        "45b07948-ebf8-4696-b9ae-0b0148586ba1",
        "1ad7d492-3b21-4a1d-bf30-2aa2f3c32023",
        "b402ea86-3aa7-4ce3-a78b-286f00036640",
        "60497511-8a19-48bb-aef5-638e88f240bc",
        "e2f2f131-4de0-4288-93b7-9e3cf5361cd1",
        "bc70adad-4e24-4d05-88a7-1a25d2796328",
        "7d3b6b7e-f82b-4444-94b1-f3ee95f77901",
        "2347f415-9338-4bb1-9081-975a681800ed",
        "a70af5c5-c92e-4b0d-8d12-0e17b2cda9f7",
        "e914d510-d80d-47cc-98e2-6e36ac5e6962",
        "f819cd03-09b3-4a21-abd7-64cf9df375a5",
        "c60db473-f4c1-4dc7-85f0-82ed89777cbb",
        "86205408-aa38-446a-b831-1de9187c6b18",
        "6a89a136-effb-4b9f-9548-8e31cd4701f0",
        "fc8178d1-c12b-441c-b22c-772d6c37e964",
        "233722f4-1b45-48e5-88a4-889feb0ed324",
        "7d653c8d-0535-42fa-943e-3435bbbe7744",
        "9cefbf00-ed92-4de2-aed6-fe00180282ce",
        "721f4f92-a253-46fc-8e7e-1f40e60cc4e2",
        "9bbff842-9116-4c92-bcfc-cdf0f354e723",
        "66157bf3-3ff7-4a8a-aefb-85a12ccc8bc9",
        "2526daca-f956-4e50-b5ac-b445f6f5b544",
        "d8fa6085-380b-4b55-91d6-d08317075918",
        "58fbb1d3-3831-4de9-bd74-af29589b9e1b",
        "bd05bd49-5d93-47c9-a9f8-0b8bfee92db3",
        "080218b1-7722-4a5c-a436-654bd1a71089",
        "9445eb38-5490-4c4f-9dc8-73f783571800",
        "5abee805-2c39-4a3a-84be-a3d087b10104",
        "7c8fcd2e-b9c8-41ec-bee9-b8a66c92779c",
        "51693fc1-0fba-4a2b-b8f7-6fc36d025cda",
        "669b1097-5a8a-4927-af04-f7bf85276ac5",
        "22af615e-473e-4a66-ae61-12216c428d13",
        "14eb4d44-980e-4933-a498-77142523fba1",
        "701b26a8-868e-4bfc-af0e-489e4cc5c075",
        "c77218f8-9e61-42db-b725-eb196fe9c227",
        "d643d1f5-cb81-458c-9899-9c4f5bb8e0f1",
        "8b732d40-4a85-46aa-a532-4633d35dc87e",
        "0441bb00-b804-433c-be20-ee1ceb6a9dbb",
        "8256f64c-2f1a-4fad-84da-c885e67d6ce3",
        "82fc8dd1-ccbd-41e6-bfed-fd87f1d06ced"
    ]
}

Deduplicated Items

Finally, Let’s retrieve the deduplicated items from the item set using our search endpoint. For brevity, the max number of records requested has been reduced to 5. As you can see, there are 386 items returned using the item-set-originals query.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v2/cases/43b070164ce8453ca30ed9e2dfcce67b/search?query=item-set-originals:HelloItemSet&metadataProfile=Default&numberOfRecordsRequested=5' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "request": {
        "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
        "query": "item-set-originals:HelloItemSet",
        "sortField": null,
        "sortOrder": null,
        "startIndex": 0,
        "numberOfRecordsRequested": 5,
        "deduplicate": null,
        "metadataProfile": "Default",
        "fieldList": null,
        "customMetadataList": null,
        "propertyList": null,
        "itemParameterizedFields": null,
        "showAvailableThumbnails": false,
        "useCache": false,
        "forceCacheDelete": false,
        "searchRetry": 0,
        "relationType": null,
        "entities": [],
        "s": 0,
        "p": 5,
        "customMetadataField": null,
        "property": null,
        "field": null
    },
    "startedOn": 1613594869418,
    "completedOn": 1613594869432,
    "elapsedTimeForSearch": 9,
    "elapsedTimeForSort": 0,
    "elapsedTimeForMarshal": 1,
    "elapsedTimeForDeduplicate": 0,
    "elapsedTotal": 14,
    "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": "Nuix Evidence File",
            "Name": "d29719c8-517e-48cb-9fd6-983dd2d6671b",
            "Path Name": "/",
            "guid": "75f02dfe-989d-4f93-aade-cd4334042254"
        },
        {
            "File Type": "Directory",
            "Name": "doc",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b",
            "guid": "97806413-9715-48ed-a08c-03fc0c79f8b9"
        },
        {
            "File Type": "Nuix Evidence File",
            "Name": "e1746668-8eca-48b2-a8bd-14f17c59c1e1",
            "Path Name": "/",
            "guid": "668c6144-071d-420e-9fe5-a11bd63e2326"
        },
        {
            "File Type": "Nuix Evidence File",
            "Name": "8c970c8e-8e9d-4dcb-bb42-07d2980a6b3f",
            "Path Name": "/",
            "guid": "087eb560-5e5b-4c7e-a745-028602ce0104"
        },
        {
            "File Type": "Directory",
            "Name": "api",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc",
            "guid": "dfb9d2b2-3a5b-4013-9c6d-1ed44910d49a"
        }
    ],
    "count": 386,
    "deduplicatedCount": 386
}

Getting Started: Part 10: OCR

Thu, 05 Aug 2021 00:00:00 +0000

In this example, we will ingest the Nuix logo below into our case and perform Optical Character Recognition (OCR) on it. Right click on the image in your browser to save the image to disk as nuix.png.

Verify OCR Capability

In order to perform an OCR, the OCR plugin from https://download.nuix.com/releases/addons needs to be installed. To verify that the OCR plugin is installed call the resources/ocr endpoint.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/resources/ocr' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "success": true
}

File Ingestion of Image

Next, let’s ingest our image with text.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/evidence/file' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
   "processorSettings": {
   	"storeBinary": true
   },
   "target": {
    "path": "/Images/nuix.png"
  }
}
'

{
    "functionKey": "f599c065-523e-4dd5-8ab1-82cad97afe8b",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/f599c065-523e-4dd5-8ab1-82cad97afe8b"
}

File Ingestion Status

The functionKey field returned from the ingestion endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/f599c065-523e-4dd5-8ab1-82cad97afe8b' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": true,
    "token": "a3b10cf2-1c75-4507-86dd-865eb56555b7",
    "functionKey": "f599c065-523e-4dd5-8ab1-82cad97afe8b",
    "progress": 7011,
    "total": 0,
    "percentComplete": null,
    "updatedOn": 1613506664487,
    "status": null,
    "statusId": null,
    "requestTime": 1613506653553,
    "startTime": 1613506653553,
    "finishTime": 1613506666353,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Evidence Ingestion Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "nuixadmin",
    "action": "AsyncBulkIngestionFunction",
    "options": {
        "reloadQuery": null,
        "processorSettings": {
            "processText": null,
            "processLooseFileContents": null,
            "processForensicImages": null,
            "analysisLanguage": null,
            "stopWords": null,
            "stemming": null,
            "enableExactQueries": null,
            "extractNamedEntities": null,
            "extractNamedEntitiesFromText": null,
            "extractNamedEntitiesFromProperties": null,
            "extractNamedEntitiesFromTextStripped": null,
            "extractShingles": null,
            "processTextSummaries": null,
            "calculateSSDeepFuzzyHash": null,
            "detectFaces": null,
            "extractFromSlackSpace": null,
            "carveFileSystemUnallocatedSpace": null,
            "carveUnidentifiedData": null,
            "carvingBlockSize": null,
            "recoverDeletedFiles": null,
            "extractEndOfFileSlackSpace": null,
            "smartProcessRegistry": null,
            "identifyPhysicalFiles": null,
            "createThumbnails": null,
            "skinToneAnalysis": null,
            "calculateAuditedSize": null,
            "storeBinary": true,
            "maxStoredBinarySize": null,
            "maxDigestSize": null,
            "digests": [],
            "addBccToEmailDigests": null,
            "addCommunicationDateToEmailDigests": null,
            "reuseEvidenceStores": null,
            "processFamilyFields": null,
            "hideEmbeddedImmaterialData": null,
            "reportProcessingStatus": null,
            "workerItemCallback": null,
            "workerItemCallbacks": null
        },
        "evidence": [
            {
                "guid": null,
                "name": null,
                "customMetadata": null,
                "encoding": null,
                "custodian": null,
                "timeZone": null,
                "description": null,
                "locale": null,
                "files": [
                    {
                        "path": "/Images/nuix.png"
                    }
                ],
                "exchangeMailboxes": null,
                "s3Buckets": null,
                "sqlServers": null,
                "enterpriseVaults": null,
                "sharepointSites": null,
                "mailStores": null,
                "loadFiles": null,
                "centeraClusters": null,
                "splitFiles": null,
                "dropboxes": null,
                "sshServers": null
            }
        ],
        "localWorkerCount": 1,
        "repositories": [],
        "parallelProcessingSettings": {
            "workerCount": null,
            "workerMemory": null,
            "workerTemp": null,
            "brokerMemory": null,
            "workerBrokerAddress": null,
            "useRemoteWorkers": false,
            "embedBroker": true
        },
        "rescanEvidenceRepositories": false,
        "loadProcessingJob": {
            "casePath": "/Cases/HelloWorld",
            "jobGuid": "55480a21-720c-4f3e-baa6-c7c5b53b28b0",
            "processingMode": "Load",
            "startDate": 1613506654064,
            "workerCount": 1,
            "finished": true,
            "paused": false,
            "masterAddress": "1.1.1.1",
            "bytesProcessed": 7011,
            "itemsProcessed": 1,
            "jobSizeTotalBytes": 0
        }
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-1",
    "errorMsg": null
}

Item Verification

Let’s verify that we have the item (nuix.png) in our case by doing a search. We will also retrieve the guid of the item for OCR.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v2/cases/43b070164ce8453ca30ed9e2dfcce67b/search?query=nuix.png&metadataProfile=Default&numberOfRecordsRequested=100' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "request": {
        "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
        "query": "nuix.png",
        "sortField": null,
        "sortOrder": null,
        "startIndex": 0,
        "numberOfRecordsRequested": 1,
        "deduplicate": null,
        "metadataProfile": "Default",
        "fieldList": null,
        "customMetadataList": null,
        "propertyList": null,
        "itemParameterizedFields": null,
        "showAvailableThumbnails": false,
        "useCache": false,
        "forceCacheDelete": false,
        "searchRetry": 0,
        "relationType": null,
        "entities": [],
        "s": 0,
        "p": 1,
        "customMetadataField": null,
        "field": null,
        "property": null
    },
    "startedOn": 1613507186542,
    "completedOn": 1613507186598,
    "elapsedTimeForSearch": 50,
    "elapsedTimeForSort": 0,
    "elapsedTimeForMarshal": 1,
    "elapsedTimeForDeduplicate": 0,
    "elapsedTotal": 56,
    "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": "Portable Network Graphic",
            "Name": "nuix.png",
            "Path Name": "/e1746668-8eca-48b2-a8bd-14f17c59c1e1",
            "guid": "519ca60c-a397-4d1b-a5aa-547287a8ad1a"
        }
    ],
    "count": 1,
    "deduplicatedCount": 1
}

OCR

Let’s OCR the item using the guid returned from our search query.

519ca60c-a397-4d1b-a5aa-547287a8ad1a

curl --location --request PUT 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/items/ocr' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
  "parallelProcessingSettings": {
    "embedBroker": true,
    "workerCount": 4,
    "workerMemory": 2048
  },
  "query": "guid:519ca60c-a397-4d1b-a5aa-547287a8ad1a"
}'

{
    "functionKey": "f534cd08-c374-4c7a-acf4-32ec613adbff",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/f534cd08-c374-4c7a-acf4-32ec613adbff"
}

OCR Status

The functionKey field returned from the OCR endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/f534cd08-c374-4c7a-acf4-32ec613adbff' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": {
        "total": 1,
        "failure": 0
    },
    "token": "a3b10cf2-1c75-4507-86dd-865eb56555b7",
    "functionKey": "f534cd08-c374-4c7a-acf4-32ec613adbff",
    "progress": 1,
    "total": 1,
    "percentComplete": 100.0000,
    "updatedOn": 1613507447309,
    "status": null,
    "statusId": null,
    "requestTime": 1613507437697,
    "startTime": 1613507437698,
    "finishTime": 1613507449524,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "OCR Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "username",
    "action": "AsyncOcrFunction",
    "options": {
        "ocrOptions": {
            "regeneratePdfs": null,
            "updatePdf": null,
            "updateText": null,
            "textModification": null,
            "quality": null,
            "rotation": null,
            "deskew": null,
            "clearOcrCache": null,
            "outputDirectory": null,
            "languages": [
                "ENGLISH"
            ],
            "timeout": null,
            "updateDuplicates": null,
            "ocrProfileName": null
        },
        "localWorkerCount": 1,
        "parallelProcessingSettings": {
            "workerCount": 4,
            "workerMemory": 2048,
            "workerTemp": null,
            "brokerMemory": null,
            "workerBrokerAddress": null,
            "useRemoteWorkers": false,
            "embedBroker": true
        },
        "query": "guid:519ca60c-a397-4d1b-a5aa-547287a8ad1a",
        "ocrProfile": null,
        "ocrImagingSettings": null,
        "exportProcessingJob": {
            "casePath": "/Cases/HelloWorld",
            "jobGuid": "145e16b9-7800-4240-b108-a2e8ecc58724",
            "processingMode": "Export",
            "startDate": 1613507437889,
            "workerCount": 9,
            "finished": true,
            "paused": false,
            "masterAddress": "1.1.1.1",
            "currentStage": "TEXT_REPLACEMENT",
            "currentStageDuration": "0 seconds",
            "currentStageExportedItemsCount": 1,
            "failedItemCount": 0,
            "totalItemCount": 1
        },
        "imagingProfile": null,
        "tags": null
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-1",
    "errorMsg": null
}

Item Text

Finally, let’s retrieve the item text of the image using the itemText endpoint.

curl --location --request GET 'http://localhost:8080/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/items/519ca60c-a397-4d1b-a5aa-547287a8ad1a/itemText' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "text": "nuix",
    "binaryAvailable": true,
    "htmlEscape": false,
    "totalTextLength": 4,
    "blank": false
}

The text field in the response is nuix and we have successfully performed an OCR on this image.

Getting Started: Part 11: Tagging

Thu, 05 Aug 2021 00:00:00 +0000

Tagging

Let’s tag some items in the case. For this example, we will tag all files with an HTML file extension. Additionally, we want to exclude duplicates so we are going to use the item set we created earlier in the tutorial.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v2/cases/43b070164ce8453ca30ed9e2dfcce67b/itemTags' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
  "query": "item-set-originals:HelloItemSet AND file-extension:html",
  "tagList": [
    "HTMLFiles"
  ]
}'

{
    "tagList": [
        "HTMLFiles"
    ],
    "successfulTags": [
        "HTMLFiles"
    ],
    "failedTags": []
}

Tag Verification

Let’s verify the items that we have tagged using a simple synchronous search. We will use the query tag:HTMLFiles. The search returned 302 results.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v2/cases/43b070164ce8453ca30ed9e2dfcce67b/search?query=tag:HTMLFiles&metadataProfile=Default&numberOfRecordsRequested=5' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "request": {
        "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
        "query": "tag:HTMLFiles",
        "sortField": null,
        "sortOrder": null,
        "startIndex": 0,
        "numberOfRecordsRequested": 5,
        "deduplicate": null,
        "metadataProfile": "Default",
        "fieldList": null,
        "customMetadataList": null,
        "propertyList": null,
        "itemParameterizedFields": null,
        "showAvailableThumbnails": false,
        "useCache": false,
        "forceCacheDelete": false,
        "searchRetry": 0,
        "relationType": null,
        "entities": [],
        "p": 5,
        "s": 0,
        "customMetadataField": null,
        "field": null,
        "property": null
    },
    "startedOn": 1612986781150,
    "completedOn": 1612986781172,
    "elapsedTimeForSearch": 16,
    "elapsedTimeForSort": 0,
    "elapsedTimeForMarshal": 2,
    "elapsedTimeForDeduplicate": 0,
    "elapsedTotal": 22,
    "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": "Hypertext Markup Language Document",
            "Name": "allclasses.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "4350a26e-0582-4cdd-8903-feb2454b66ad"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "allclasses-index.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "48fdd676-ecdf-4271-8fb0-a312570888a5"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "allpackages-index.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "b5d26466-0b5f-4b01-bc2e-7ebe6c6d3294"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "index.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "8bc28b97-6d5a-4755-8066-4fa2102705de"
        },
        {
            "File Type": "Hypertext Markup Language Document",
            "Name": "constant-values.html",
            "Path Name": "/d29719c8-517e-48cb-9fd6-983dd2d6671b/doc/api",
            "guid": "ee4cb26f-30b5-4a76-8789-dfbd7fdecf65"
        }
    ],
    "count": 302,
    "deduplicatedCount": 302
}

Counting Tags

Instead of using search, let’s verify how many items we have tagged using the count endpoint. The response verifies that we have tagged 302 HTML files.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/count' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "tag:HTMLFiles"
}'

{
    "count": 302,
    "query": "tag:HTMLFiles",
    "casePath": "/Cases/HelloWorld",
    "caseGuid": "43b070164ce8453ca30ed9e2dfcce67b"
}

Getting Started: Part 12: Production Sets

Thu, 05 Aug 2021 00:00:00 +0000

Production Sets

Now that we have culled some data. Let’s create a production set. Creating a production set is an asynchronous task. The response is an asynchronous function key that we can poll for status.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/productionSets' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
  "description": "My first production set",
  "name": "HelloProductionSet",
  "query": "tag:HTMLFiles"
}'

{
    "functionKey": "d1471527-dd28-46cf-a5cd-e2f4efc8d9ed",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/d1471527-dd28-46cf-a5cd-e2f4efc8d9ed"
}

Production Set Status

We have now created a production set with 302 elements. Take note of the production set ID that is returned in the result field of the asynchronous function response. You will need this for a legal export.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/d1471527-dd28-46cf-a5cd-e2f4efc8d9ed' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": "59d69780-963a-478c-9f4b-0d2bb4c84a3f",
    "token": "db63fbfc-a5fd-494e-974b-cc17f6b2a56a",
    "functionKey": "d1471527-dd28-46cf-a5cd-e2f4efc8d9ed",
    "progress": 302,
    "total": 302,
    "percentComplete": 100.0,
    "updatedOn": 1612987413154,
    "status": null,
    "statusId": null,
    "requestTime": 1612987408327,
    "startTime": 1612987408327,
    "finishTime": 1612987413257,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Production Set Creation Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "username",
    "action": "AsyncProductionSetCreationFunction",
    "options": {
        "productionSetName": "HelloProductionSet",
        "numberingPrefix": "nuix",
        "query": "tag:HTMLFiles",
        "applyHighlights": true,
        "includeFamilies": false,
        "generatePdfStores": null,
        "productionSetDescription": "My first production set",
        "markupSets": null,
        "parallelProcessingSettings": null,
        "pdfStoresQuery": "",
        "guid": "59d69780-963a-478c-9f4b-0d2bb4c84a3f",
        "startingDocumentNumber": "nuix000000001",
        "endingDocumentNumber": "nuix000000302",
        "applyRedactions": true,
        "nextDocumentNumber": "nuix000000303"
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restfuls-server-1",
    "errorMsg": null
}

Getting Started: Part 13: Case Subset

Thu, 05 Aug 2021 00:00:00 +0000

Case Subset

Let’s create a case subset of our tagged HTML files using the query tag:HTMLFiles.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/subset' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
	"query": "tag:HTMLfiles",
	"location": "inventory0",
	"evidenceStoreCount": 1,
	"includeFamilies": false,
	"copyTags": false,
	"copyComments": false,
	"copyCustodians": false,
	"copyItemSets": false,
	"copyClassifiers": false,
	"copyMarkupSets": false,
	"copyProductionSets": false,
	"copyClusters": false,
	"copyCustomMetadata": false,
	"caseMetadata": {
		"name": "HelloHTMLFiles",
		"description": "HTML files case subsetted",
		"investigator":"Inspector Gadget"
	}
}'

{
    "functionKey": "7cdcba36-7d9d-4d55-a9f7-b0e179fa5162",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/7cdcba36-7d9d-4d55-a9f7-b0e179fa5162"
}

Case Subset Status

The functionKey field returned from the case subset endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/7cdcba36-7d9d-4d55-a9f7-b0e179fa5162' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": "cc58650fb513494e944166cfb39494d5",
    "token": "7a40f78e-48f0-4a2c-b9aa-423251e2b4c1",
    "functionKey": "7cdcba36-7d9d-4d55-a9f7-b0e179fa5162",
    "progress": 314,
    "total": 1,
    "percentComplete": 31400.0000,
    "updatedOn": 1613163116856,
    "status": null,
    "statusId": null,
    "requestTime": 1613163085787,
    "startTime": 1613163090254,
    "finishTime": 1613163121958,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Case Subset Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "nuixadmin",
    "action": "AsyncCaseSubsetFunction",
    "options": {
        "query": "tag:HTMLfiles",
        "options": {
            "copyComments": false,
            "copyCustodians": false,
            "evidenceStoreCount": 1,
            "copyCustomMetadata": false,
            "copyItemSets": false,
            "copyProductionSets": false,
            "copyTags": false,
            "copyClusters": false,
            "copyMarkupSets": false,
            "includeFamilies": false,
            "copyClassifiers": false,
            "caseMetadata": {
                "investigator": "Inspector Gadget",
                "name": "HelloHTMLFiles",
                "description": "HTML files case subsetted",
                "binaryStoreLocation": null
            }
        },
        "location": "/Cases/HelloHTMLFiles"
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-2",
    "errorMsg": null
}

Inventory Verification

The result field in the polled response is the case ID of the newly created case. Let’s verify it exists in our inventory.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/inventory/digest' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

[
      {
        "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
        "name": "HelloWorld",
        "path": "/Cases/HelloWorld",
        "description": "My first simple Nuix case",
        "investigator": "Inspector Gadget",
        "creationDate": 1612906749154,
        "compound": false,
        "elastic": false,
        "binaryStoreLocation": "",
        "indexId": "",
        "productName": "Nuix",
        "version": "8.9.1",
        "isOpen": false,
        "childCases": [],
        "url": "http://localhost:8080",
        "serverId": "nuix-restful-server-1"
     }, 
     {
        "caseId": "cc58650fb513494e944166cfb39494d5",
        "name": "HelloHTMLFiles",
        "path": "/Cases/HelloHTMLFiles",
        "description": "HTML files case subsetted",
        "investigator": "Inspector Gadget",
        "creationDate": 1613163100246,
        "compound": false,
        "elastic": false,
        "binaryStoreLocation": "",
        "indexId": "",
        "productName": "Nuix",
        "version": "8.9.1",
        "isOpen": false,
        "childCases": [],
        "url": "http://localhost:8080",
        "serverId": "nuix-restful-server-1"
    }
]

The new case HelloHTMLFiles is in the inventory with case ID cc58650fb513494e944166cfb39494d5.

Elasticsearch Case Subset

We can also take our HelloWorld case, and create a case subset for an Elasticsearch case. Let’s try it out. Elasticsearch settings are provided in the caseMetadata field.

curl --location --request POST 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/subset' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
	"query": "tag:HTMLfiles",
	"location": "inventory0",
	"evidenceStoreCount": 1,
	"includeFamilies": false,
	"copyClassifiers": false,
	"copyMarkupSets": false,
	"copyProductionSets": false,
	"copyClusters": false,
	"copyCustomMetadata": false,
	"caseMetadata": {
		"name": "HelloElasticHTMLFiles",
		"description": "HTML files case subsetted into Elasticsearch",
		"investigator":"Inspector Gadget",
        "elasticSearchSettings" : {
            "cluster.name": "elasticsearch",
            "nuix.transport.hosts": ["127.0.0.1"],
            "nuix.http.hosts": ["127.0.0.1"],
            "index.number_of_shards": 1
        }
	}
}'

{
    "functionKey": "ec04c044-66f6-4f9e-af4f-583b51f22d55",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/ec04c044-66f6-4f9e-af4f-583b51f22d55"
}

Elasticsearch Case Subset Status

Again, the functionKey field returned from the case subset endpoint above can be polled for status.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/ec04c044-66f6-4f9e-af4f-583b51f22d55' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'
--header 'Cookie: JSESSIONID=64EC387C1A3CD403896EF14506B03BD9'

{
    "done": true,
    "cancelled": false,
    "result": "664649c33a064ba796b28f65caac77c2",
    "token": "7a40f78e-48f0-4a2c-b9aa-423251e2b4c1",
    "functionKey": "ec04c044-66f6-4f9e-af4f-583b51f22d55",
    "progress": 0,
    "total": 1,
    "percentComplete": 0.0000,
    "updatedOn": 1613164209724,
    "status": null,
    "statusId": null,
    "requestTime": 1613164206990,
    "startTime": 1613164209722,
    "finishTime": 1613164215014,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Case Subset Function",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "nuixadmin",
    "action": "AsyncCaseSubsetFunction",
    "options": {
        "query": "tag:HTMLfiles",
        "options": {
            "copyComments": false,
            "copyCustodians": false,
            "evidenceStoreCount": 1,
            "copyCustomMetadata": false,
            "copyItemSets": false,
            "copyProductionSets": false,
            "copyTags": false,
            "copyClusters": false,
            "copyMarkupSets": false,
            "includeFamilies": false,
            "copyClassifiers": false,
            "caseMetadata": {
                "investigator": "Inspector Gadget",
                "name": "HelloElasticHTMLFiles",
                "description": "HTML files case subsetted into Elasticsearch",
                "binaryStoreLocation": null,
                "elasticSearchSettings": {
                    "index.refresh_interval": "60s",
                    "nuix.transport.hosts": [
                        "127.0.0.1"
                    ],
                    "cluster.name": "elasticsearch",
                    "index.number_of_replicas": 0,
                    "nuix.http.hosts": [
                        "127.0.0.1"
                    ],
                    "nuix.index.auto_close": false,
                    "index.number_of_shards": 1,
                    "xpack.security.transport.ssl.enabled": false
                }
            }
        },
        "location": "/Cases/HelloElasticHTMLFiles"
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-2",
    "errorMsg": null
}

Inventory Verification

The result field in the polled response is the case ID of the newly created Elasticsearch case. Let’s verify it exists in our inventory.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/inventory/digest' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

[
     {
        "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
        "name": "HelloWorld",
        "path": "/Cases/HelloWorld",
        "description": "My first simple Nuix case",
        "investigator": "Inspector Gadget",
        "creationDate": 1612906749154,
        "compound": false,
        "elastic": false,
        "binaryStoreLocation": "",
        "indexId": "",
        "productName": "Nuix",
        "version": "8.9.1",
        "isOpen": false,
        "childCases": [],
        "url": "http://localhost:8080",
        "serverId": "nuix-restful-server-1"
     }, 
     {
        "caseId": "cc58650fb513494e944166cfb39494d5",
        "name": "HelloHTMLFiles",
        "path": "/Cases/HelloHTMLFiles",
        "description": "HTML files case subsetted",
        "investigator": "Inspector Gadget",
        "creationDate": 1613163100246,
        "compound": false,
        "elastic": false,
        "binaryStoreLocation": "",
        "indexId": "",
        "productName": "Nuix",
        "version": "8.9.1",
        "isOpen": false,
        "childCases": [],
        "url": "http://localhost:8080",
        "serverId": "nuix-restful-server-1"
    },
    {
        "caseId": "664649c33a064ba796b28f65caac77c2",
        "name": "HelloElasticHTMLFiles",
        "path": "/Cases/HelloElasticHTMLFiles",
        "description": "HTML files case subsetted into Elasticsearch",
        "investigator": "Inspector Gadget",
        "creationDate": 1613164125600,
        "compound": false,
        "elastic": true,
        "binaryStoreLocation": "/Cases/HelloElasticHTMLFiles/Stores/BinaryStore",
        "indexId": "nuix-664649c33a064ba796b28f65caac77c2",
        "productName": "Nuix",
        "version": "8.9.1",
        "isOpen": false,
        "childCases": [],
        "url": "http://localhost:8080",
        "serverId": "nuix-restful-server-1"
    }
]

The new case HelloElasticHTMLFiles is in the inventory with case ID 664649c33a064ba796b28f65caac77c2.

Getting Started: Part 14: Exports

Thu, 05 Aug 2021 00:00:00 +0000

Legal Export

Let’s go ahead and do a legal export of our production set. We will use the production set ID

59d69780-963a-478c-9f4b-0d2bb4c84a3f

returned from the previous create production set task.

For this example, we will create a Ringtail (now, Nuix Discover®), load file and export both natives and PDF files.

curl --location --request PUT 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/export' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
  "exportType": "LEGAL",
  "productionSets": [
      "59d69780-963a-478c-9f4b-0d2bb4c84a3f"
  ],
  "path": "/Exports/legalExport",
  "loadFileTypes": [
    "RINGTAIL"
  ],
  "productTypes": [
    "NATIVE",
    "PDF"
  ],
  "parallelProcessingSettings": {
  	"workerCount": 1
  }
}'

{
    "functionKey": "11f72ad8-3540-4751-89f1-8759af5ae9bb",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/11f72ad8-3540-4751-89f1-8759af5ae9bb"
}

Legal Export Status

We can now poll for the legal export status of our production set and review the export.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/11f72ad8-3540-4751-89f1-8759af5ae9bb' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": [
        true
    ],
    "token": "db63fbfc-a5fd-494e-974b-cc17f6b2a56a",
    "functionKey": "b2da1a23-037e-4218-800e-7a61e4911128",
    "progress": 0,
    "total": 1,
    "percentComplete": 0.0000,
    "updatedOn": 1612989562059,
    "status": null,
    "statusId": null,
    "requestTime": 1612989562058,
    "startTime": 1612989562058,
    "finishTime": 1612990079261,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Chained Functions",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "nuixadmin",
    "action": "AsyncFunctionChain",
    "options": {
        "functions": [
            "59d69780-963a-478c-9f4b-0d2bb4c84a3f"
        ],
        "59d69780-963a-478c-9f4b-0d2bb4c84a3f": {
            "productionSetName": "HelloProductionSet",
            "path": "/Exports/legalexport/20210210153922/HelloProductionSet",
            "localWorkerCount": 2,
            "parallelProcessingSettings": {
                "workerCount": 1,
                "workerMemory": null,
                "workerTemp": null,
                "brokerMemory": null,
                "workerBrokerAddress": null,
                "useRemoteWorkers": false,
                "embedBroker": true
            },
            "exportType": "LEGAL",
            "productTypes": [
                "NATIVE",
                "PDF"
            ],
            "exportProcessingJob": {
                "casePath": "/Cases/HelloWorld",
                "jobGuid": "d48ca147-3325-450a-be29-e1a465800685",
                "processingMode": "Export",
                "startDate": 1612989562423,
                "workerCount": 9,
                "finished": true,
                "paused": false,
                "masterAddress": "192.168.86.53",
                "currentStage": "LOAD_FILES",
                "currentStageDuration": "0 seconds",
                "currentStageExportedItemsCount": 302,
                "failedItemCount": 0,
                "totalItemCount": 302
            },
            "exportId": "20210210153922",
            "loadFileTypes": [
                "RINGTAIL"
            ],
            "productionSetId": "59d69780-963a-478c-9f4b-0d2bb4c84a3f"
        }
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "admin-console-nuix-ims1-server",
    "errorMsg": null
}

Item Export

We can also export items using a query. Let’s export the HTML files from this case. For this example, we will export both natives and PDF files.

curl --location --request PUT 'http://localhost:8080/nuix-restful-service/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/export' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
  "exportType": "ITEM",
  "path": "/Exports/itemExport",
   "productTypes": [
    "NATIVE",
    "PDF"
  ],
  "queries": [
    "tag:HTMLFiles"
  ],
  "parallelProcessingSettings": {
  	"workerCount": 1
  }
}'

{
    "functionKey": "e89de475-ea07-4a22-a6d9-633f4701b73e",
    "location": "http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/e89de475-ea07-4a22-a6d9-633f4701b73e"
}

Item Export Status

We can now poll the item export status and review the export.

curl --location --request GET 'http://localhost:8080/svc/v1/asyncFunctions/e89de475-ea07-4a22-a6d9-633f4701b73e' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'

{
    "done": true,
    "cancelled": false,
    "result": [
        true
    ],
    "token": "a3b10cf2-1c75-4507-86dd-865eb56555b7",
    "functionKey": "e89de475-ea07-4a22-a6d9-633f4701b73e",
    "progress": 0,
    "total": 1,
    "percentComplete": 0.0000,
    "updatedOn": 1613501410724,
    "status": null,
    "statusId": null,
    "requestTime": 1613501408202,
    "startTime": 1613501408202,
    "finishTime": 1613501437129,
    "caseId": "43b070164ce8453ca30ed9e2dfcce67b",
    "caseName": "HelloWorld",
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Chained Functions",
    "caseLocation": "/Cases/HelloWorld",
    "requestor": "username",
    "action": "AsyncFunctionChain",
    "options": {
        "functions": [
            "ef0d71a8-f815-4392-bff2-82d78f17d872"
        ],
        "ef0d71a8-f815-4392-bff2-82d78f17d872": {
            "path": "/Exports/itemExport/20210216135011",
            "localWorkerCount": 1,
            "parallelProcessingSettings": {
                "workerCount": 1,
                "workerMemory": null,
                "workerTemp": null,
                "brokerMemory": null,
                "workerBrokerAddress": null,
                "useRemoteWorkers": false,
                "embedBroker": true
            },
            "exportType": "ITEM",
            "query": "tag:HTMLFiles",
            "productTypes": [
                "NATIVE",
                "PDF"
            ],
            "exportProcessingJob": {
                "casePath": "/Cases/HelloWorld",
                "jobGuid": "e199e3b3-698d-4b73-aefb-f5d48a5705e0",
                "processingMode": "Export",
                "startDate": 1613501418417,
                "workerCount": 9,
                "finished": true,
                "paused": false,
                "masterAddress": "1.1.1.1",
                "currentStage": "CREATE_PRODUCTION_SET",
                "currentStageDuration": "0 seconds",
                "currentStageExportedItemsCount": 302,
                "failedItemCount": 0,
                "totalItemCount": 302
            },
            "exportId": "20210216135011",
            "loadFileTypes": []
        }
    },
    "participatingInCaseFunctionQueue": true,
    "processedBy": "nuix-restful-server-1",
    "errorMsg": null
}

Item Download

We can also download individual items in their native format. For this example, we will just select an HTML file at random.

curl --location --request GET 'http://localhost:8080/svc/v1/cases/43b070164ce8453ca30ed9e2dfcce67b/items/4350a26e-0582-4cdd-8903-feb2454b66ad/download' \
--header 'nuix-auth-token: 9729a460-eda7-48dc-ba70-d12b3aae3c8d'
--header 'Content-Type: application/json' \
--header 'Accept: application/octet-stream' \
--data-raw ''

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">

<head>
	<!-- Generated by javadoc (11.0.6) on Fri Jan 08 17:38:21 AEDT 2021 -->
	<title>All Classes (Nuix Core 9.0.0.171)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<meta name="dc.created" content="2021-01-08">
	<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
	<script type="text/javascript" src="script.js"></script>
	<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
	<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
	<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
	<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
	<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
	<script type="text/javascript" src="jquery/jquery-ui.js"></script>
</head>

<body>
	<h1 class="bar">All&nbsp;Classes</h1>
	<main role="main" class="indexContainer">
		<ul>
			<li><a href="nuix/AddedWorkers.html"
					title="interface in nuix"><span class="interfaceName">AddedWorkers</span></a></li>
			<li><a href="nuix/Address.html" title="interface in nuix"><span class="interfaceName">Address</span></a>
			</li>
			<li><a href="nuix/AfterExportCallback.html"
					title="interface in nuix"><span class="interfaceName">AfterExportCallback</span></a></li>
			<li><a href="nuix/AfterExportCallbackInfo.html"
					title="interface in nuix"><span class="interfaceName">AfterExportCallbackInfo</span></a></li>
			<li><a href="nuix/engine/AvailableLicence.html"
					title="interface in nuix.engine"><span class="interfaceName">AvailableLicence</span></a></li>
			<li><a href="nuix/annotation/AvailableWithAnyLicence.html"
					title="annotation in nuix.annotation">AvailableWithAnyLicence</a></li>
			<li><a href="nuix/annotation/AvailableWithFeature.html"
					title="annotation in nuix.annotation">AvailableWithFeature</a></li>
			<li><a href="nuix/annotation/AvailableWithNonAuditedLicence.html"
					title="annotation in nuix.annotation">AvailableWithNonAuditedLicence</a></li>
			<li><a href="nuix/locations/AwsLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">AwsLocation</span></a></li>
			<li><a href="nuix/BatchExporter.html"
					title="interface in nuix"><span class="interfaceName">BatchExporter</span></a></li>
			<li><a href="nuix/BatchLoadDetails.html"
					title="interface in nuix"><span class="interfaceName">BatchLoadDetails</span></a></li>
			<li><a href="nuix/BeforeExportCallback.html"
					title="interface in nuix"><span class="interfaceName">BeforeExportCallback</span></a></li>
			<li><a href="nuix/BeforeExportCallbackInfo.html"
					title="interface in nuix"><span class="interfaceName">BeforeExportCallbackInfo</span></a></li>
			<li><a href="nuix/BelongsToCompoundCaseException.html"
					title="class in nuix">BelongsToCompoundCaseException</a></li>
			<li><a href="nuix/Binary.html" title="interface in nuix"><span class="interfaceName">Binary</span></a></li>
			<li><a href="nuix/BinaryData.html"
					title="interface in nuix"><span class="interfaceName">BinaryData</span></a></li>
			<li><a href="nuix/BulkAnnotater.html"
					title="interface in nuix"><span class="interfaceName">BulkAnnotater</span></a></li>
			<li><a href="nuix/BulkSearcher.html"
					title="interface in nuix"><span class="interfaceName">BulkSearcher</span></a></li>
			<li><a href="nuix/BulkSearcherResult.html"
					title="interface in nuix"><span class="interfaceName">BulkSearcherResult</span></a></li>
			<li><a href="nuix/Case.html" title="interface in nuix"><span class="interfaceName">Case</span></a></li>
			<li><a href="nuix/management/CaseAdministrationJob.html"
					title="interface in nuix.management"><span class="interfaceName">CaseAdministrationJob</span></a>
			</li>
			<li><a href="nuix/management/CaseBackupDescriptor.html"
					title="interface in nuix.management"><span class="interfaceName">CaseBackupDescriptor</span></a>
			</li>
			<li><a href="nuix/management/CaseBackupJob.html"
					title="interface in nuix.management"><span class="interfaceName">CaseBackupJob</span></a></li>
			<li><a href="nuix/management/CaseBackupUtility.html"
					title="interface in nuix.management"><span class="interfaceName">CaseBackupUtility</span></a></li>
			<li><a href="nuix/CaseCustomMetadataMap.html"
					title="interface in nuix"><span class="interfaceName">CaseCustomMetadataMap</span></a></li>
			<li><a href="nuix/CaseFactory.html"
					title="interface in nuix"><span class="interfaceName">CaseFactory</span></a></li>
			<li><a href="nuix/management/CaseImportExportJob.html"
					title="interface in nuix.management"><span class="interfaceName">CaseImportExportJob</span></a></li>
			<li><a href="nuix/management/CaseImportExportUtility.html"
					title="interface in nuix.management"><span class="interfaceName">CaseImportExportUtility</span></a>
			</li>
			<li><a href="nuix/CaseNotesStore.html"
					title="interface in nuix"><span class="interfaceName">CaseNotesStore</span></a></li>
			<li><a href="nuix/CaseStatistics.html"
					title="interface in nuix"><span class="interfaceName">CaseStatistics</span></a></li>
			<li><a href="nuix/CaseUtility.html"
					title="interface in nuix"><span class="interfaceName">CaseUtility</span></a></li>
			<li><a href="nuix/engine/CertificateTrustCallback.html"
					title="interface in nuix.engine"><span class="interfaceName">CertificateTrustCallback</span></a>
			</li>
			<li><a href="nuix/engine/CertificateTrustCallbackInfo.html"
					title="interface in nuix.engine"><span class="interfaceName">CertificateTrustCallbackInfo</span></a>
			</li>
			<li><a href="nuix/Cluster.html" title="interface in nuix"><span class="interfaceName">Cluster</span></a>
			</li>
			<li><a href="nuix/ClusterItem.html"
					title="interface in nuix"><span class="interfaceName">ClusterItem</span></a></li>
			<li><a href="nuix/ClusterRun.html"
					title="interface in nuix"><span class="interfaceName">ClusterRun</span></a></li>
			<li><a href="nuix/Communication.html"
					title="interface in nuix"><span class="interfaceName">Communication</span></a></li>
			<li><a href="nuix/CompoundCase.html"
					title="interface in nuix"><span class="interfaceName">CompoundCase</span></a></li>
			<li><a href="nuix/ConfigurationProfile.html"
					title="interface in nuix"><span class="interfaceName">ConfigurationProfile</span></a></li>
			<li><a href="nuix/ConfigurationProfileStore.html"
					title="interface in nuix"><span class="interfaceName">ConfigurationProfileStore</span></a></li>
			<li><a href="nuix/profile/ContinuousPageNumberingStrategy.html"
					title="interface in nuix.profile"><span class="interfaceName">ContinuousPageNumberingStrategy</span></a>
			</li>
			<li><a href="nuix/profile/ContinuousPageNumberingStrategyBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ContinuousPageNumberingStrategyBuilder</span></a>
			</li>
			<li><a href="nuix/engine/CredentialsCallback.html"
					title="interface in nuix.engine"><span class="interfaceName">CredentialsCallback</span></a></li>
			<li><a href="nuix/engine/CredentialsCallbackInfo.html"
					title="interface in nuix.engine"><span class="interfaceName">CredentialsCallbackInfo</span></a></li>
			<li><a href="nuix/credentials/CredentialsStore.html"
					title="interface in nuix.credentials"><span class="interfaceName">CredentialsStore</span></a></li>
			<li><a href="nuix/Custodian.html" title="interface in nuix"><span class="interfaceName">Custodian</span></a>
			</li>
			<li><a href="nuix/CustomMetadataMap.html"
					title="interface in nuix"><span class="interfaceName">CustomMetadataMap</span></a></li>
			<li><a href="nuix/CustomMetadataTemplate.html"
					title="interface in nuix"><span class="interfaceName">CustomMetadataTemplate</span></a></li>
			<li><a href="nuix/CustomMetadataTemplateField.html"
					title="interface in nuix"><span class="interfaceName">CustomMetadataTemplateField</span></a></li>
			<li><a href="nuix/CustomMetadataTemplateStore.html"
					title="interface in nuix"><span class="interfaceName">CustomMetadataTemplateStore</span></a></li>
			<li><a href="nuix/CustomNamedEntity.html"
					title="interface in nuix"><span class="interfaceName">CustomNamedEntity</span></a></li>
			<li><a href="nuix/CustomNamedEntityStore.html"
					title="interface in nuix"><span class="interfaceName">CustomNamedEntityStore</span></a></li>
			<li><a href="nuix/profile/DatabaseParameters.html"
					title="interface in nuix.profile"><span class="interfaceName">DatabaseParameters</span></a></li>
			<li><a href="nuix/profile/DatabaseParametersBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">DatabaseParametersBuilder</span></a>
			</li>
			<li><a href="nuix/DateRange.html" title="interface in nuix"><span class="interfaceName">DateRange</span></a>
			</li>
			<li><a href="nuix/DetectedFace.html"
					title="interface in nuix"><span class="interfaceName">DetectedFace</span></a></li>
			<li><a href="nuix/DigestCollection.html"
					title="interface in nuix"><span class="interfaceName">DigestCollection</span></a></li>
			<li><a href="nuix/DigestListStore.html"
					title="interface in nuix"><span class="interfaceName">DigestListStore</span></a></li>
			<li><a href="nuix/profile/DocumentIdNumberingStrategy.html"
					title="interface in nuix.profile"><span class="interfaceName">DocumentIdNumberingStrategy</span></a>
			</li>
			<li><a href="nuix/profile/DocumentIdNumberingStrategyBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">DocumentIdNumberingStrategyBuilder</span></a>
			</li>
			<li><a href="nuix/DocumentNumber.html"
					title="interface in nuix"><span class="interfaceName">DocumentNumber</span></a></li>
			<li><a href="nuix/DuplicateCaseException.html" title="class in nuix">DuplicateCaseException</a></li>
			<li><a href="nuix/DuplicateCaseItemException.html" title="class in nuix">DuplicateCaseItemException</a></li>
			<li><a href="nuix/graph/Edge.html"
					title="interface in nuix.graph"><span class="interfaceName">Edge</span></a></li>
			<li><a href="nuix/engine/Engine.html"
					title="interface in nuix.engine"><span class="interfaceName">Engine</span></a></li>
			<li><a href="nuix/locations/EnterpriseBoxLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">EnterpriseBoxLocation</span></a>
			</li>
			<li><a href="nuix/locations/EnterpriseVaultLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">EnterpriseVaultLocation</span></a>
			</li>
			<li><a href="nuix/Entity.html" title="interface in nuix"><span class="interfaceName">Entity</span></a></li>
			<li><a href="nuix/EvidenceContainer.html"
					title="interface in nuix"><span class="interfaceName">EvidenceContainer</span></a></li>
			<li><a href="nuix/locations/ExchangeWSLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">ExchangeWSLocation</span></a></li>
			<li><a href="nuix/ExportDetails.html"
					title="interface in nuix"><span class="interfaceName">ExportDetails</span></a></li>
			<li><a href="nuix/ExportItemInfo.html"
					title="interface in nuix"><span class="interfaceName">ExportItemInfo</span></a></li>
			<li><a href="nuix/ExportItemOutputInfo.html"
					title="interface in nuix"><span class="interfaceName">ExportItemOutputInfo</span></a></li>
			<li><a href="nuix/ExportProcessingJob.html"
					title="interface in nuix"><span class="interfaceName">ExportProcessingJob</span></a></li>
			<li><a href="nuix/ExportProcessorCallback.html"
					title="interface in nuix"><span class="interfaceName">ExportProcessorCallback</span></a></li>
			<li><a href="nuix/FailedElementCallback.html"
					title="interface in nuix"><span class="interfaceName">FailedElementCallback</span></a></li>
			<li><a href="nuix/FailedElementInfo.html"
					title="interface in nuix"><span class="interfaceName">FailedElementInfo</span></a></li>
			<li><a href="nuix/profile/FileNamingStrategy.html"
					title="interface in nuix.profile"><span class="interfaceName">FileNamingStrategy</span></a></li>
			<li><a href="nuix/profile/FileNamingStrategyBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">FileNamingStrategyBuilder</span></a>
			</li>
			<li><a href="nuix/profile/FormattedDocumentIdNumberingStrategy.html"
					title="interface in nuix.profile"><span class="interfaceName">FormattedDocumentIdNumberingStrategy</span></a>
			</li>
			<li><a href="nuix/profile/FormattedDocumentIdNumberingStrategyBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">FormattedDocumentIdNumberingStrategyBuilder</span></a>
			</li>
			<li><a href="nuix/Formatter.html" title="interface in nuix"><span class="interfaceName">Formatter</span></a>
			</li>
			<li><a href="nuix/FuzzyHashListStore.html"
					title="interface in nuix"><span class="interfaceName">FuzzyHashListStore</span></a></li>
			<li><a href="nuix/engine/GlobalContainer.html"
					title="interface in nuix.engine"><span class="interfaceName">GlobalContainer</span></a></li>
			<li><a href="nuix/engine/GlobalContainerFactory.html"
					title="class in nuix.engine">GlobalContainerFactory</a></li>
			<li><a href="nuix/graph/Graph.html"
					title="interface in nuix.graph"><span class="interfaceName">Graph</span></a></li>
			<li><a href="nuix/graph/GraphBuilder.html"
					title="interface in nuix.graph"><span class="interfaceName">GraphBuilder</span></a></li>
			<li><a href="nuix/graph/GraphProvider.html"
					title="interface in nuix.graph"><span class="interfaceName">GraphProvider</span></a></li>
			<li><a href="nuix/graph/GraphProviderFactory.html"
					title="interface in nuix.graph"><span class="interfaceName">GraphProviderFactory</span></a></li>
			<li><a href="nuix/Highlight.html" title="interface in nuix"><span class="interfaceName">Highlight</span></a>
			</li>
			<li><a href="nuix/HistoryEvent.html"
					title="interface in nuix"><span class="interfaceName">HistoryEvent</span></a></li>
			<li><a href="nuix/Image.html" title="interface in nuix"><span class="interfaceName">Image</span></a></li>
			<li><a href="nuix/ImageInfo.html" title="interface in nuix"><span class="interfaceName">ImageInfo</span></a>
			</li>
			<li><a href="nuix/ImagePage.html" title="interface in nuix"><span class="interfaceName">ImagePage</span></a>
			</li>
			<li><a href="nuix/ImagingConfigurable.html"
					title="interface in nuix"><span class="interfaceName">ImagingConfigurable</span></a></li>
			<li><a href="nuix/profile/ImagingProfile.html"
					title="interface in nuix.profile"><span class="interfaceName">ImagingProfile</span></a></li>
			<li><a href="nuix/profile/ImagingProfileBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ImagingProfileBuilder</span></a></li>
			<li><a href="nuix/ImagingProfileConfigurable.html"
					title="interface in nuix"><span class="interfaceName">ImagingProfileConfigurable</span></a></li>
			<li><a href="nuix/profile/ImagingProfileRule.html"
					title="interface in nuix.profile"><span class="interfaceName">ImagingProfileRule</span></a></li>
			<li><a href="nuix/profile/ImagingProfileRuleBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ImagingProfileRuleBuilder</span></a>
			</li>
			<li><a href="nuix/profile/ImagingProfileStore.html"
					title="interface in nuix.profile"><span class="interfaceName">ImagingProfileStore</span></a></li>
			<li><a href="nuix/annotation/ImplementedByClientCode.html"
					title="annotation in nuix.annotation">ImplementedByClientCode</a></li>
			<li><a href="nuix/Item.html" title="interface in nuix"><span class="interfaceName">Item</span></a></li>
			<li><a href="nuix/profile/ItemCondition.html"
					title="interface in nuix.profile"><span class="interfaceName">ItemCondition</span></a></li>
			<li><a href="nuix/profile/ItemConditionBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ItemConditionBuilder</span></a></li>
			<li><a href="nuix/ItemCustomMetadataMap.html"
					title="interface in nuix"><span class="interfaceName">ItemCustomMetadataMap</span></a></li>
			<li><a href="nuix/ItemEventCallback.html"
					title="interface in nuix"><span class="interfaceName">ItemEventCallback</span></a></li>
			<li><a href="nuix/ItemEventInfo.html"
					title="interface in nuix"><span class="interfaceName">ItemEventInfo</span></a></li>
			<li><a href="nuix/ItemExistsException.html" title="class in nuix">ItemExistsException</a></li>
			<li><a href="nuix/ItemExpression.html"
					title="interface in nuix"><span class="interfaceName">ItemExpression</span></a></li>
			<li><a href="nuix/ItemInUseException.html" title="class in nuix">ItemInUseException</a></li>
			<li><a href="nuix/ItemKind.html" title="interface in nuix"><span class="interfaceName">ItemKind</span></a>
			</li>
			<li><a href="nuix/ItemMetadata.html"
					title="interface in nuix"><span class="interfaceName">ItemMetadata</span></a></li>
			<li><a href="nuix/ItemModifier.html"
					title="interface in nuix"><span class="interfaceName">ItemModifier</span></a></li>
			<li><a href="nuix/ItemModifierCallback.html"
					title="interface in nuix"><span class="interfaceName">ItemModifierCallback</span></a></li>
			<li><a href="nuix/ItemProcessedCallback.html"
					title="interface in nuix"><span class="interfaceName">ItemProcessedCallback</span></a></li>
			<li><a href="nuix/ItemSet.html" title="interface in nuix"><span class="interfaceName">ItemSet</span></a>
			</li>
			<li><a href="nuix/ItemSetBatch.html"
					title="interface in nuix"><span class="interfaceName">ItemSetBatch</span></a></li>
			<li><a href="nuix/ItemSorter.html"
					title="interface in nuix"><span class="interfaceName">ItemSorter</span></a></li>
			<li><a href="nuix/ItemSyncCallback.html"
					title="interface in nuix"><span class="interfaceName">ItemSyncCallback</span></a></li>
			<li><a href="nuix/ItemTreeNode.html"
					title="interface in nuix"><span class="interfaceName">ItemTreeNode</span></a></li>
			<li><a href="nuix/ItemType.html" title="interface in nuix"><span class="interfaceName">ItemType</span></a>
			</li>
			<li><a href="nuix/ItemTypeUtility.html"
					title="interface in nuix"><span class="interfaceName">ItemTypeUtility</span></a></li>
			<li><a href="nuix/ItemUtility.html"
					title="interface in nuix"><span class="interfaceName">ItemUtility</span></a></li>
			<li><a href="nuix/management/JobProgressCallback.html"
					title="interface in nuix.management"><span class="interfaceName">JobProgressCallback</span></a></li>
			<li><a href="nuix/management/JobProgressInfo.html"
					title="interface in nuix.management"><span class="interfaceName">JobProgressInfo</span></a></li>
			<li><a href="nuix/Licence.html" title="interface in nuix"><span class="interfaceName">Licence</span></a>
			</li>
			<li><a href="nuix/LicenceException.html" title="class in nuix">LicenceException</a></li>
			<li><a href="nuix/LicenceProperties.html"
					title="interface in nuix"><span class="interfaceName">LicenceProperties</span></a></li>
			<li><a href="nuix/engine/LicenceSource.html"
					title="interface in nuix.engine"><span class="interfaceName">LicenceSource</span></a></li>
			<li><a href="nuix/engine/LicenceSourceInformation.html"
					title="interface in nuix.engine"><span class="interfaceName">LicenceSourceInformation</span></a>
			</li>
			<li><a href="nuix/engine/Licensor.html"
					title="interface in nuix.engine"><span class="interfaceName">Licensor</span></a></li>
			<li><a href="nuix/LoadProcessingJob.html"
					title="interface in nuix"><span class="interfaceName">LoadProcessingJob</span></a></li>
			<li><a href="nuix/locations/Location.html"
					title="interface in nuix.locations"><span class="interfaceName">Location</span></a></li>
			<li><a href="nuix/locations/LocationFactory.html"
					title="interface in nuix.locations"><span class="interfaceName">LocationFactory</span></a></li>
			<li><a href="nuix/LocationValidationStatus.html"
					title="interface in nuix"><span class="interfaceName">LocationValidationStatus</span></a></li>
			<li><a href="nuix/LogicalImageExporter.html"
					title="interface in nuix"><span class="interfaceName">LogicalImageExporter</span></a></li>
			<li><a href="nuix/LogicalImageItem.html"
					title="interface in nuix"><span class="interfaceName">LogicalImageItem</span></a></li>
			<li><a href="nuix/locations/MailStoreLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">MailStoreLocation</span></a></li>
			<li><a href="nuix/Markup.html" title="interface in nuix"><span class="interfaceName">Markup</span></a></li>
			<li><a href="nuix/MarkupConfigurable.html"
					title="interface in nuix"><span class="interfaceName">MarkupConfigurable</span></a></li>
			<li><a href="nuix/MarkupSet.html" title="interface in nuix"><span class="interfaceName">MarkupSet</span></a>
			</li>
			<li><a href="nuix/MetadataExportProcessor.html"
					title="interface in nuix"><span class="interfaceName">MetadataExportProcessor</span></a></li>
			<li><a href="nuix/profile/MetadataExportProfile.html"
					title="interface in nuix.profile"><span class="interfaceName">MetadataExportProfile</span></a></li>
			<li><a href="nuix/profile/MetadataExportProfileBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">MetadataExportProfileBuilder</span></a>
			</li>
			<li><a href="nuix/profile/MetadataExportProfileRule.html"
					title="interface in nuix.profile"><span class="interfaceName">MetadataExportProfileRule</span></a>
			</li>
			<li><a href="nuix/profile/MetadataExportProfileRuleBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">MetadataExportProfileRuleBuilder</span></a>
			</li>
			<li><a href="nuix/profile/MetadataExportProfileStore.html"
					title="interface in nuix.profile"><span class="interfaceName">MetadataExportProfileStore</span></a>
			</li>
			<li><a href="nuix/MetadataImportExportDatabaseParameters.html"
					title="interface in nuix"><span class="interfaceName">MetadataImportExportDatabaseParameters</span></a>
			</li>
			<li><a href="nuix/MetadataImportExportDatabaseParametersBuilder.html"
					title="interface in nuix"><span class="interfaceName">MetadataImportExportDatabaseParametersBuilder</span></a>
			</li>
			<li><a href="nuix/MetadataImportProcessor.html"
					title="interface in nuix"><span class="interfaceName">MetadataImportProcessor</span></a></li>
			<li><a href="nuix/MetadataImportProfile.html"
					title="interface in nuix"><span class="interfaceName">MetadataImportProfile</span></a></li>
			<li><a href="nuix/MetadataImportProfileBuilder.html"
					title="interface in nuix"><span class="interfaceName">MetadataImportProfileBuilder</span></a></li>
			<li><a href="nuix/MetadataImportProfileStore.html"
					title="interface in nuix"><span class="interfaceName">MetadataImportProfileStore</span></a></li>
			<li><a href="nuix/MetadataItem.html"
					title="interface in nuix"><span class="interfaceName">MetadataItem</span></a></li>
			<li><a href="nuix/MetadataProfile.html"
					title="interface in nuix"><span class="interfaceName">MetadataProfile</span></a></li>
			<li><a href="nuix/MetadataProfileStore.html"
					title="interface in nuix"><span class="interfaceName">MetadataProfileStore</span></a></li>
			<li><a href="nuix/profile/MicrosoftExcelConversionOptions.html"
					title="interface in nuix.profile"><span class="interfaceName">MicrosoftExcelConversionOptions</span></a>
			</li>
			<li><a href="nuix/profile/MicrosoftExcelConversionOptionsBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">MicrosoftExcelConversionOptionsBuilder</span></a>
			</li>
			<li><a href="nuix/locations/MicrosoftGraphLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">MicrosoftGraphLocation</span></a>
			</li>
			<li><a href="nuix/profile/MicrosoftPowerPointConversionOptions.html"
					title="interface in nuix.profile"><span class="interfaceName">MicrosoftPowerPointConversionOptions</span></a>
			</li>
			<li><a href="nuix/profile/MicrosoftPowerPointConversionOptionsBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">MicrosoftPowerPointConversionOptionsBuilder</span></a>
			</li>
			<li><a href="nuix/profile/MicrosoftWordConversionOptions.html"
					title="interface in nuix.profile"><span class="interfaceName">MicrosoftWordConversionOptions</span></a>
			</li>
			<li><a href="nuix/profile/MicrosoftWordConversionOptionsBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">MicrosoftWordConversionOptionsBuilder</span></a>
			</li>
			<li><a href="nuix/MissingAccessTokenException.html" title="class in nuix">MissingAccessTokenException</a>
			</li>
			<li><a href="nuix/MultipleItemExporter.html"
					title="interface in nuix"><span class="interfaceName">MultipleItemExporter</span></a></li>
			<li><a href="nuix/MutablePrintedImage.html"
					title="interface in nuix"><span class="interfaceName">MutablePrintedImage</span></a></li>
			<li><a href="nuix/MutablePrintedPage.html"
					title="interface in nuix"><span class="interfaceName">MutablePrintedPage</span></a></li>
			<li><a href="nuix/profile/NamedEntity.html"
					title="interface in nuix.profile"><span class="interfaceName">NamedEntity</span></a></li>
			<li><a href="nuix/profile/NamedEntityProfile.html"
					title="interface in nuix.profile"><span class="interfaceName">NamedEntityProfile</span></a></li>
			<li><a href="nuix/profile/NamedEntityProfileStore.html"
					title="interface in nuix.profile"><span class="interfaceName">NamedEntityProfileStore</span></a>
			</li>
			<li><a href="nuix/NativeExportInfo.html"
					title="interface in nuix"><span class="interfaceName">NativeExportInfo</span></a></li>
			<li><a href="nuix/NetworkExporter.html"
					title="interface in nuix"><span class="interfaceName">NetworkExporter</span></a></li>
			<li><a href="nuix/NoItemException.html" title="class in nuix">NoItemException</a></li>
			<li><a href="nuix/profile/NumberingComponentDescriptor.html"
					title="interface in nuix.profile"><span class="interfaceName">NumberingComponentDescriptor</span></a>
			</li>
			<li><a href="nuix/profile/NumberingComponentDescriptorBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">NumberingComponentDescriptorBuilder</span></a>
			</li>
			<li><a href="nuix/NumberingConfigurable.html"
					title="interface in nuix"><span class="interfaceName">NumberingConfigurable</span></a></li>
			<li><a href="nuix/profile/NumberingStrategy.html"
					title="interface in nuix.profile"><span class="interfaceName">NumberingStrategy</span></a></li>
			<li><a href="nuix/OcrProcessor.html"
					title="interface in nuix"><span class="interfaceName">OcrProcessor</span></a></li>
			<li><a href="nuix/profile/OcrProfile.html"
					title="interface in nuix.profile"><span class="interfaceName">OcrProfile</span></a></li>
			<li><a href="nuix/profile/OcrProfileBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">OcrProfileBuilder</span></a></li>
			<li><a href="nuix/OcrProfileConfigurable.html"
					title="interface in nuix"><span class="interfaceName">OcrProfileConfigurable</span></a></li>
			<li><a href="nuix/profile/OcrProfileRule.html"
					title="interface in nuix.profile"><span class="interfaceName">OcrProfileRule</span></a></li>
			<li><a href="nuix/profile/OcrProfileRuleBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">OcrProfileRuleBuilder</span></a></li>
			<li><a href="nuix/profile/OcrProfileStore.html"
					title="interface in nuix.profile"><span class="interfaceName">OcrProfileStore</span></a></li>
			<li><a href="nuix/profile/OcrTemplate.html"
					title="interface in nuix.profile"><span class="interfaceName">OcrTemplate</span></a></li>
			<li><a href="nuix/profile/OcrTemplateBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">OcrTemplateBuilder</span></a></li>
			<li><a href="nuix/OperationFailedException.html" title="class in nuix">OperationFailedException</a></li>
			<li><a href="nuix/locations/OracleServerLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">OracleServerLocation</span></a></li>
			<li><a href="nuix/ParallelProcessingConfigurable.html"
					title="interface in nuix"><span class="interfaceName">ParallelProcessingConfigurable</span></a></li>
			<li><a href="nuix/annotation/ParametersLicenceChecked.html"
					title="annotation in nuix.annotation">ParametersLicenceChecked</a></li>
			<li><a href="nuix/PrintedImage.html"
					title="interface in nuix"><span class="interfaceName">PrintedImage</span></a></li>
			<li><a href="nuix/PrintedImageInfo.html"
					title="interface in nuix"><span class="interfaceName">PrintedImageInfo</span></a></li>
			<li><a href="nuix/PrintedPage.html"
					title="interface in nuix"><span class="interfaceName">PrintedPage</span></a></li>
			<li><a href="nuix/ProcessedItem.html"
					title="interface in nuix"><span class="interfaceName">ProcessedItem</span></a></li>
			<li><a href="nuix/ProcessingJob.html"
					title="interface in nuix"><span class="interfaceName">ProcessingJob</span></a></li>
			<li><a href="nuix/profile/ProcessingProfile.html"
					title="interface in nuix.profile"><span class="interfaceName">ProcessingProfile</span></a></li>
			<li><a href="nuix/profile/ProcessingProfileBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ProcessingProfileBuilder</span></a>
			</li>
			<li><a href="nuix/profile/ProcessingProfileStore.html"
					title="interface in nuix.profile"><span class="interfaceName">ProcessingProfileStore</span></a></li>
			<li><a href="nuix/ProcessingProgressInfo.html"
					title="interface in nuix"><span class="interfaceName">ProcessingProgressInfo</span></a></li>
			<li><a href="nuix/Processor.html" title="interface in nuix"><span class="interfaceName">Processor</span></a>
			</li>
			<li><a href="nuix/ProcessorCleaningUpCallback.html"
					title="interface in nuix"><span class="interfaceName">ProcessorCleaningUpCallback</span></a></li>
			<li><a href="nuix/profile/ProductionProfile.html"
					title="interface in nuix.profile"><span class="interfaceName">ProductionProfile</span></a></li>
			<li><a href="nuix/profile/ProductionProfileBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ProductionProfileBuilder</span></a>
			</li>
			<li><a href="nuix/ProductionProfileConfigurable.html"
					title="interface in nuix"><span class="interfaceName">ProductionProfileConfigurable</span></a></li>
			<li><a href="nuix/profile/ProductionProfileLoadFileSettings.html"
					title="interface in nuix.profile"><span class="interfaceName">ProductionProfileLoadFileSettings</span></a>
			</li>
			<li><a href="nuix/profile/ProductionProfileLoadFileSettingsBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ProductionProfileLoadFileSettingsBuilder</span></a>
			</li>
			<li><a href="nuix/profile/ProductionProfileRule.html"
					title="interface in nuix.profile"><span class="interfaceName">ProductionProfileRule</span></a></li>
			<li><a href="nuix/profile/ProductionProfileRuleBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ProductionProfileRuleBuilder</span></a>
			</li>
			<li><a href="nuix/profile/ProductionProfileStore.html"
					title="interface in nuix.profile"><span class="interfaceName">ProductionProfileStore</span></a></li>
			<li><a href="nuix/ProductionSet.html"
					title="interface in nuix"><span class="interfaceName">ProductionSet</span></a></li>
			<li><a href="nuix/ProductionSetItem.html"
					title="interface in nuix"><span class="interfaceName">ProductionSetItem</span></a></li>
			<li><a href="nuix/profile/Profile.html"
					title="interface in nuix.profile"><span class="interfaceName">Profile</span></a></li>
			<li><a href="nuix/profile/ProfileBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ProfileBuilder</span></a></li>
			<li><a href="nuix/profile/ProfileRule.html"
					title="interface in nuix.profile"><span class="interfaceName">ProfileRule</span></a></li>
			<li><a href="nuix/profile/ProfileRuleBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">ProfileRuleBuilder</span></a></li>
			<li><a href="nuix/profile/ProfileStore.html"
					title="interface in nuix.profile"><span class="interfaceName">ProfileStore</span></a></li>
			<li><a href="nuix/ProgressUpdatedCallback.html"
					title="interface in nuix"><span class="interfaceName">ProgressUpdatedCallback</span></a></li>
			<li><a href="nuix/graph/Property.html"
					title="interface in nuix.graph"><span class="interfaceName">Property</span></a></li>
			<li><a href="nuix/ReaderReadLogic.html"
					title="interface in nuix"><span class="interfaceName">ReaderReadLogic</span></a></li>
			<li><a href="nuix/report/ReportGenerator.html"
					title="interface in nuix.report"><span class="interfaceName">ReportGenerator</span></a></li>
			<li><a href="nuix/ReviewJob.html" title="interface in nuix"><span class="interfaceName">ReviewJob</span></a>
			</li>
			<li><a href="nuix/ReviewJobItem.html"
					title="interface in nuix"><span class="interfaceName">ReviewJobItem</span></a></li>
			<li><a href="nuix/profile/RuleBasedProfile.html"
					title="interface in nuix.profile"><span class="interfaceName">RuleBasedProfile</span></a></li>
			<li><a href="nuix/profile/RuleBasedProfileBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">RuleBasedProfileBuilder</span></a>
			</li>
			<li><a href="nuix/ScannedItem.html"
					title="interface in nuix"><span class="interfaceName">ScannedItem</span></a></li>
			<li><a href="nuix/SearchableItem.html"
					title="interface in nuix"><span class="interfaceName">SearchableItem</span></a></li>
			<li><a href="nuix/SearchCallback.html"
					title="interface in nuix"><span class="interfaceName">SearchCallback</span></a></li>
			<li><a href="nuix/SearchMacro.html"
					title="interface in nuix"><span class="interfaceName">SearchMacro</span></a></li>
			<li><a href="nuix/SearchMacroStore.html"
					title="interface in nuix"><span class="interfaceName">SearchMacroStore</span></a></li>
			<li><a href="nuix/Server.html" title="interface in nuix"><span class="interfaceName">Server</span></a></li>
			<li><a href="nuix/ServerGroup.html"
					title="interface in nuix"><span class="interfaceName">ServerGroup</span></a></li>
			<li><a href="nuix/ServerGroups.html"
					title="interface in nuix"><span class="interfaceName">ServerGroups</span></a></li>
			<li><a href="nuix/ServerRegistry.html"
					title="interface in nuix"><span class="interfaceName">ServerRegistry</span></a></li>
			<li><a href="nuix/ServerUser.html"
					title="interface in nuix"><span class="interfaceName">ServerUser</span></a></li>
			<li><a href="nuix/ServerUsers.html"
					title="interface in nuix"><span class="interfaceName">ServerUsers</span></a></li>
			<li><a href="nuix/engine/SharedLicence.html"
					title="interface in nuix.engine"><span class="interfaceName">SharedLicence</span></a></li>
			<li><a href="nuix/locations/SharePointLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">SharePointLocation</span></a></li>
			<li><a href="nuix/ShingleListStore.html"
					title="interface in nuix"><span class="interfaceName">ShingleListStore</span></a></li>
			<li><a href="nuix/SimpleCase.html"
					title="interface in nuix"><span class="interfaceName">SimpleCase</span></a></li>
			<li><a href="nuix/SingleItemExporter.html"
					title="interface in nuix"><span class="interfaceName">SingleItemExporter</span></a></li>
			<li><a href="nuix/SingleItemImporter.html"
					title="interface in nuix"><span class="interfaceName">SingleItemImporter</span></a></li>
			<li><a href="nuix/profile/SlipSheetTemplate.html"
					title="interface in nuix.profile"><span class="interfaceName">SlipSheetTemplate</span></a></li>
			<li><a href="nuix/profile/SlipSheetTemplateBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">SlipSheetTemplateBuilder</span></a>
			</li>
			<li><a href="nuix/SourceItem.html"
					title="interface in nuix"><span class="interfaceName">SourceItem</span></a></li>
			<li><a href="nuix/SourceItemFactory.html"
					title="interface in nuix"><span class="interfaceName">SourceItemFactory</span></a></li>
			<li><a href="nuix/SourceItemNotFoundException.html" title="class in nuix">SourceItemNotFoundException</a>
			</li>
			<li><a href="nuix/locations/SqlServerLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">SqlServerLocation</span></a></li>
			<li><a href="nuix/locations/SshLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">SshLocation</span></a></li>
			<li><a href="nuix/profile/Stamper.html"
					title="interface in nuix.profile"><span class="interfaceName">Stamper</span></a></li>
			<li><a href="nuix/profile/StamperBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">StamperBuilder</span></a></li>
			<li><a href="nuix/profile/StamperConfiguration.html"
					title="interface in nuix.profile"><span class="interfaceName">StamperConfiguration</span></a></li>
			<li><a href="nuix/profile/StamperConfigurationsBuilder.html"
					title="interface in nuix.profile"><span class="interfaceName">StamperConfigurationsBuilder</span></a>
			</li>
			<li><a href="nuix/StampingConfigurable.html"
					title="interface in nuix"><span class="interfaceName">StampingConfigurable</span></a></li>
			<li><a href="nuix/Text.html" title="interface in nuix"><span class="interfaceName">Text</span></a></li>
			<li><a href="nuix/ThirdPartyDependency.html"
					title="interface in nuix"><span class="interfaceName">ThirdPartyDependency</span></a></li>
			<li><a href="nuix/ThirdPartyDependencyStatus.html"
					title="interface in nuix"><span class="interfaceName">ThirdPartyDependencyStatus</span></a></li>
			<li><a href="nuix/TokenInfo.html" title="interface in nuix"><span class="interfaceName">TokenInfo</span></a>
			</li>
			<li><a href="nuix/Topic.html" title="interface in nuix"><span class="interfaceName">Topic</span></a></li>
			<li><a href="nuix/graph/Traversal.html"
					title="interface in nuix.graph"><span class="interfaceName">Traversal</span></a></li>
			<li><a href="nuix/TreePosition.html"
					title="interface in nuix"><span class="interfaceName">TreePosition</span></a></li>
			<li><a href="nuix/locations/TwitterHistoricalLocation.html"
					title="interface in nuix.locations"><span class="interfaceName">TwitterHistoricalLocation</span></a>
			</li>
			<li><a href="nuix/User.html" title="interface in nuix"><span class="interfaceName">User</span></a></li>
			<li><a href="nuix/UserDataStore.html"
					title="interface in nuix"><span class="interfaceName">UserDataStore</span></a></li>
			<li><a href="nuix/Utilities.html" title="interface in nuix"><span class="interfaceName">Utilities</span></a>
			</li>
			<li><a href="nuix/graph/Vertex.html"
					title="interface in nuix.graph"><span class="interfaceName">Vertex</span></a></li>
			<li><a href="nuix/Window.html" title="interface in nuix"><span class="interfaceName">Window</span></a></li>
			<li><a href="nuix/WordList.html" title="interface in nuix"><span class="interfaceName">WordList</span></a>
			</li>
			<li><a href="nuix/WordListStore.html"
					title="interface in nuix"><span class="interfaceName">WordListStore</span></a></li>
			<li><a href="nuix/WorkerAgent.html"
					title="interface in nuix"><span class="interfaceName">WorkerAgent</span></a></li>
			<li><a href="nuix/WorkerAgentStatus.html"
					title="interface in nuix"><span class="interfaceName">WorkerAgentStatus</span></a></li>
			<li><a href="nuix/WorkerBroker.html"
					title="interface in nuix"><span class="interfaceName">WorkerBroker</span></a></li>
			<li><a href="nuix/WorkerItem.html"
					title="interface in nuix"><span class="interfaceName">WorkerItem</span></a></li>
		</ul>
	</main>
</body>

</html>

Getting Started: Part 15: Clustering

Thu, 05 Aug 2021 00:00:00 +0000

Clustering

Nuix REST supports clustered installations to enable distributed workloads across multiple nodes within a cluster. When configured as a cluster, requests submitted to Nuix REST are managed and distributed across the cluster with no further action from the user.

Note

Only Elasticsearch Cases are supported by cluster mode.

For more information about configuring your Nuix REST instances for clustering please see the clustering guide