{ "item": [ { "id": "bfa5ea94-f37a-4ae8-9822-6dbb2d2ff3fa", "name": "Access", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5d63376e-5260-459d-85d4-b25ad8a66f2d", "name": "Log in and acquire a licence", "request": { "name": "Log in and acquire a licence", "description": { "content": "Use this operation to log in and get an authentication token or licence. The authentication token gives you access to the REST API.", "type": "text/plain" }, "url": { "path": [ "authenticatedUsers", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "username", "value": "", "description": "(Required) The user requesting access to the service." }, { "disabled": false, "key": "password", "value": "", "description": "(Required) The password credentials for the requesting user." }, { "disabled": false, "key": "workers", "value": "", "description": "The number of workers being used. This field is optional and if not provided then the user will get a single worker.\n" }, { "disabled": false, "key": "licenceShortName", "value": "", "description": "The short name of the requested license. (UK Spelling). `licenseShortName` (US Spelling) is also accepted. If the user fails to provide the licence short name, then the licence that is first in the list provided by the licence server will be used. Both the UK and US spelling of the word are accepted.\n" } ] } }, "response": [ { "id": "f8eaecc2-5fc9-44c4-ade2-ff677e53967d", "name": "A successful login returns a response that contains the authentication token (authToken) to be submitted in the header of all subsequent requests. Additionally, the response contains the username, the short name of the license requested, and the number of workers granted by the Nuix engine.\n", "originalRequest": { "url": { "path": [ "authenticatedUsers", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The user requesting access to the service.", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) The password credentials for the requesting user.", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "The number of workers being used. This field is optional and if not provided then the user will get a single worker.\n", "type": "text/plain" }, "key": "workers", "value": "" }, { "disabled": false, "description": { "content": "The short name of the requested license. (UK Spelling). `licenseShortName` (US Spelling) is also accepted. If the user fails to provide the licence short name, then the licence that is first in the list provided by the licence server will be used. Both the UK and US spelling of the word are accepted.\n", "type": "text/plain" }, "key": "licenceShortName", "value": "" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"username\": \"user1\",\n \"authToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"licenseShortName\": \"enterprise-workstation\",\n \"clusterSystemLicenseShortName\": null,\n \"workerCount\": 1,\n \"workersGranted\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de8b37b8-3541-4b41-85a5-f21c532d2716", "name": "Invalid username and/or password.\n", "originalRequest": { "url": { "path": [ "authenticatedUsers", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The user requesting access to the service.", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) The password credentials for the requesting user.", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "The number of workers being used. This field is optional and if not provided then the user will get a single worker.\n", "type": "text/plain" }, "key": "workers", "value": "" }, { "disabled": false, "description": { "content": "The short name of the requested license. (UK Spelling). `licenseShortName` (US Spelling) is also accepted. If the user fails to provide the licence short name, then the licence that is first in the list provided by the licence server will be used. Both the UK and US spelling of the word are accepted.\n", "type": "text/plain" }, "key": "licenceShortName", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"userMessage\": \"Incorrect username and/or password.\",\n \"developerMessage\": \"The user attempted to login with a user name and password that did not match.\",\n \"errorCode\": \"UNAUTHORISED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08b3466f-7662-4e35-ba11-a55fa6d7e8ca", "name": "Returned by the server when REST is unable to obtain the number of workers requested or the specified license type.\n", "originalRequest": { "url": { "path": [ "authenticatedUsers", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The user requesting access to the service.", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) The password credentials for the requesting user.", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "The number of workers being used. This field is optional and if not provided then the user will get a single worker.\n", "type": "text/plain" }, "key": "workers", "value": "" }, { "disabled": false, "description": { "content": "The short name of the requested license. (UK Spelling). `licenseShortName` (US Spelling) is also accepted. If the user fails to provide the licence short name, then the licence that is first in the list provided by the licence server will be used. Both the UK and US spelling of the word are accepted.\n", "type": "text/plain" }, "key": "licenceShortName", "value": "" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"userMessage\": \"Unable to obtain license from Nuix server.\",\n \"developerMessage\": \"Tried to acquire 8 worker(s) but only 6 are available.\",\n \"errorCode\": \"LICENSE_EXCEPTION\",\n \"additionalInfo\": {\n \"availableWorkers\": 6,\n \"requestedWorkers\": 8,\n \"rootExceptionClass\": \"com.nuix.us.ws.exception.AvailableWorkersException\",\n \"rootExceptionMessage\": \"Tried to acquire 8 worker(s) but only 6 are available.\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc39a7a8-2d09-4b42-918a-45563c98c1e9", "name": "Log out", "request": { "name": "Log out", "description": { "content": "Logs out the session associated with the provided authentication token.", "type": "text/plain" }, "url": { "path": [ "authenticatedUsers", ":username" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "forceSynchronous", "value": "false", "description": "Forces a synchronous logout. This defaults to false, which means that the user is asynchronously logged out but their token is not made invalid immediately. The session remains active if they are running any functions or have functions queued. Even when set to true, the aforementioned holds true. In that case, the server will attempt to log the user out immediately and the HTTP request will wait till that happens. The server will try three times, with a 5 second sleep in between. If the user cannot be logged out due to queued or running functions then the call returns and the user will eventually be logged out due to being idle.\n" }, { "disabled": false, "key": "ignoreCompleted", "value": "true", "description": "Ignores functions that have already completed. This defaults to true. However, if set to false then the functions that recently completed but have not been cleared yet will be counted in the list of 'running or queued functions' and so, the user's session will not end immediately.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "username", "description": "(Required) Username associated with the licence" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "a444dbf1-cff2-400c-a5b4-ae48f5631116", "name": "default response", "originalRequest": { "url": { "path": [ "authenticatedUsers", ":username" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "forceSynchronous", "value": "false" }, { "key": "ignoreCompleted", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "username", "description": "(Required) Username associated with the licence" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4cab797d-9ad3-4a5d-aa12-d0a9964a74ab", "name": "Analysis", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c335ebfe-bf54-4077-9016-4705d7734cfc", "name": "Returns the cluster runs for a case", "request": { "name": "Returns the cluster runs for a case", "description": { "content": "Use this operation to view the cluster runs associated with a case. A cluster run is a group of documents that have been associated based on their near-duplicate similarity. Using cluster runs to group similar or related documents enables your team to perform a more efficient analysis on an item set. For example, you can have the same reviewer examine documents that are the most similar or related.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "clusterRuns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "071d3d2f-d19d-46ed-ba17-e1937514f94c", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "clusterRuns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"clusterName\": \"MyClusterRun\",\n \"clusters\": [\n \"ignored\",\n \"unclustered\",\n 1,\n 2,\n 3\n ],\n \"resemblanceThreshold\": 0.85,\n \"useChainedNearDuplicatesEnabled\": true,\n \"useEmailThreadsEnabled\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb1ded1d-eba2-4753-b1ce-b18abbfb5384", "name": "Returns the set of communication domains in a case", "request": { "name": "Returns the set of communication domains in a case", "description": { "content": "Use this operation to view the communication domains associated with a case. Allowable values for addressType are internet_mail, phone, and instant_message. This is useful for analysis and analytics. The domains are returned as a set of strings.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "domains" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "addressType", "value": "", "description": "(Required) The type of contact address" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7362296c-6da3-460a-8e67-8d59ded16244", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "domains" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "addressType", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"gmail.com\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe508ab5-dff5-43fa-9f59-8b921f65b852", "name": "Gets all MarkupSets for the given case", "request": { "name": "Gets all MarkupSets for the given case", "description": { "content": "Use this operation to get a list of all MarkupSets in the current case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5ef51dc5-20db-493b-86e8-de6e2ab0d2a7", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"redactionReason\": \"The reason for the redaction.\",\n \"name\": \"MyMarkupSet\",\n \"description\": \"This is a markup set.\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17a23dbb-3446-455b-8e0d-90ed42bff0d0", "name": "Create a markup set.", "request": { "name": "Create a markup set.", "description": { "content": "Use this operation to create a new markup set.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"redactionReason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fc0c9078-e9b5-44c8-a499-ae20f967d6a1", "name": "Created", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"guid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"redactionReason\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfd1fafd-b3db-4f7b-8402-23822176fbec", "name": "Bad Request", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1aa6238-3745-4d6f-99d3-80cd5175ad6c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "629ed2ed-069a-4404-b152-fcc2d8352b28", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8c5dc80-f0df-4866-a641-9f73083e8525", "name": "Not Acceptable", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Acceptable", "code": 406, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8132b400-a1ac-4ca3-abde-9443873ba811", "name": "Conflict", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f629a18-8e25-43e6-910a-832f853f8a0f", "name": "Payload Too Large", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1dc53ce-3a01-4cbe-a5d0-d565e42a131f", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61813861-5a5e-4342-83a7-a40ad619fbee", "name": "Bad Gateway", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cc2ec85-4e0d-4175-9b56-9e67413da935", "name": "Gets all MarkupSets for the given case", "request": { "name": "Gets all MarkupSets for the given case", "description": { "content": "Use this operation to get a list of all MarkupSets in the current case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "markupSet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "893f44da-5758-4fb3-aaac-0ac2a957f305", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"redactionReason\": \"The reason for the redaction.\",\n \"name\": \"MyMarkupSet\",\n \"description\": \"This is a markup set.\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee89cb96-539b-455c-ab74-4c823b3e473a", "name": "Returns item kinds and types for a case", "request": { "name": "Returns item kinds and types for a case", "description": { "content": "Use this operation to view the item kinds and types associated\nwith a case. You can also request counts along with a filtering query. Item\ntypes are modeled on MIME types. For example, an item kind could be a document\nand the item type could be a PDF.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemTypes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includeCounts", "value": "false", "description": "Include count totals for the types" }, { "disabled": false, "key": "query", "value": "", "description": "Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d38afc59-fb04-4b0b-9327-fd2e4af272fd", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemTypes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeCounts", "value": "false" }, { "key": "query", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"itemKind\": \"document\",\n \"itemTypes\": [\n {\n \"name\": \"application/pdf\",\n \"localisedName\": \"Portable Document Format\",\n \"kind\": \"document\",\n \"preferredExtension\": \"pdf\",\n \"count\": 11\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c328601d-4924-4e8d-9d37-5bd2c56902b0", "name": "Returns details for a review job", "request": { "name": "Returns details for a review job", "description": { "content": "Use this operation to see the list of review jobs for a case. All jobs are returned including fast review jobs. In these jobs, reviewers are assigned directly to a job, enabling a systematic review.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or GUID." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "78cd2db0-ac32-463c-b5c1-aa9373c03d0b", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"MyFastReviewJob\",\n \"guid\": \"9a6ae288-aa23-44e5-ba6b-f88f588ebbc3\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaee3e83-f530-46ac-932a-f6bf1c2bfecc", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6be65d1c-1922-4c07-9be2-50eb79bc136a", "name": "Deletes a review job", "request": { "name": "Deletes a review job", "description": { "content": "Use this operation to delete a review job for a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "cb341617-b3bd-49a9-911b-1b6a80aa1e58", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "072f2671-206d-460b-8a84-d7d55329ca79", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2dfaa85a-b23a-417b-93ac-2de05f71258d", "name": "Returns review jobs for a case", "request": { "name": "Returns review jobs for a case", "description": { "content": "Use this operation to see the list of review jobs for a case. All review jobs are returned including fast review jobs. In fast review jobs, reviewers are assigned to a job, enabling a systematic review.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "reviewJobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3bff9fca-23d8-4b43-ab8c-683f787dea8b", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"MyFastReviewJob\",\n \"guid\": \"9a6ae288-aa23-44e5-ba6b-f88f588ebbc3\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e2f2c2f-d85c-4028-885b-b4d90fedaa68", "name": "Creates a review job for a case", "request": { "name": "Creates a review job for a case", "description": { "content": "Use this operation to create a review job for a case. Create a review job to enable a systematic review of a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "reviewJobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"options\": {\n \"tags\": [\n \"\",\n \"\"\n ],\n \"highlights\": [\n \"\",\n \"\"\n ],\n \"order\": \"orderAdded\",\n \"useNearDuplicates\": true,\n \"useEmailThreads\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d90494d-1de5-4a0b-a973-e2e7afc5023c", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"MyReviewJob\",\n \"options\": {\n \"tags\": [\n \"For Review\"\n ],\n \"useNearDuplicates\": false,\n \"useEmailThreads\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"MyFastReviewJob\",\n \"guid\": \"9a6ae288-aa23-44e5-ba6b-f88f588ebbc3\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77025e95-fd5d-4d16-a6fa-18029283a5b8", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"MyReviewJob\",\n \"options\": {\n \"tags\": [\n \"For Review\"\n ],\n \"useNearDuplicates\": false,\n \"useEmailThreads\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "560d7161-09dd-4997-a2bc-d46d2ad179fa", "name": "Returns the review job items", "request": { "name": "Returns the review job items", "description": { "content": "Use this operation to get the list of items for a review job. The items in a review job are grouped and must be reviewed as an entire family of documents. You can add different tags to each member of the family, but in order to advance to the next batch, the entire family must be tagged.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "77f84c92-2a1a-4816-9f2d-d202b8cf9705", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"completionDateTime\": null,\n \"item\": {\n \"File Type\": \"text/plain\",\n \"caseName\": \"MyCase\",\n \"date\": 1588880372000,\n \"digests\": {\n \"md5\": \"a9a55486967ac71c24b60fa5c922d716\"\n },\n \"fileType\": \"text/plain\",\n \"guid\": \"5ce80ae4-5b6f-484f-9563-1fa22c89ae05\",\n \"isBinaryAvailable\": true,\n \"isTopLevel\": true,\n \"text\": \"some text\",\n \"fileSize\": 13\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f1eb311-34c2-4ee8-be16-cccd364f77e3", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5707f64b-5ec7-4e06-bc0e-6542e16fda77", "name": "Adds items to a review job", "request": { "name": "Adds items to a review job", "description": { "content": "Use this operation to add items to an existing review job for a case. Items added to a review job are grouped and must be reviewed as an entire family of documents. You can add different tags to each member of the family, but to advance to the next batch, the entire family must be tagged.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or GUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"options\": {\n \"user\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "75bd7bfe-53cc-4486-bc97-764b30b35f2c", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"guid:9dd7ebaa-0671-4f73-add7-d38d920105eb\",\n \"options\": {\n \"user\": \"assignedUser1\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"MyFastReviewJob\",\n \"guid\": \"9a6ae288-aa23-44e5-ba6b-f88f588ebbc3\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ed07fd7-90f7-4d3f-894f-21dcba084112", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"guid:9dd7ebaa-0671-4f73-add7-d38d920105eb\",\n \"options\": {\n \"user\": \"assignedUser1\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89389586-5265-44bc-91a3-a7959a891cb7", "name": "Returns batches associated with a case", "request": { "name": "Returns batches associated with a case", "description": { "content": "Use this operation to view a list of batches associated with a case. Batches are created when an investigator ingests data using the Nuix Engine.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identifier" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b0e07e7b-afb9-42f3-802d-1695f7aa26d7", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"batchId\": \"aa6aec71-d867-4ed3-8aca-b304335b8d71\",\n \"dataProcessingSettings\": {\n \"Classify images with deep learning\": \"false\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45log.Process embedded\": \"false\",\n \"Mime type settings.filesystem#47x#45ntfs#45logfile.Process images\": \"true\",\n \"Mime type settings.application#47x#45plist.Process images\": \"true\",\n \"Extract named entities from text\": \"false\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45logx.Text processing mode\": \"strip_text\",\n \"Mime type settings.application#47vnd#46tcpdump#46pcap.Store binary\": \"true\",\n \"Mime type settings.application#47vnd#46symantec#45vault#45stream#45data.Process named entities\": \"true\",\n \"Mime type settings.application#47vnd#46sqlite#45database.Process named entities\": \"true\",\n \"Store binary\": \"false\",\n \"Mime type settings.application#47vnd#46ms#45iis#45log.Process images\": \"true\",\n \"Mime type settings.application#47vnd#46symantec#45vault#45stream#45data.Process images\": \"true\",\n \"Calculate processing size\": \"false\",\n \"Mime type settings.application#47x#45pcapng.Text processing mode\": \"strip_text\",\n \"Mime type settings.application#47x#45pcapng.Store binary\": \"true\",\n \"Mime type settings.application#47x#45plist.Process named entities\": \"true\",\n \"Mime type settings.filesystem#47x#45ntfs#45usnjrnl.Store binary\": \"true\",\n \"Mime type settings.application#47exe.Process images\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dxf.Process embedded\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45logx.Store binary\": \"true\",\n \"Mime type settings.application#47vnd#46sqlite#45database.Process images\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45registry.Process embedded\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dxf.Process named entities\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dwfx.Process images\": \"true\",\n \"Mime type settings.application#47vnd#46symantec#45vault#45stream#45data.Process embedded\": \"true\",\n \"Index chars fields\": \"false\",\n \"Mime type settings.filesystem#47x#45ntfs#45mft.Process named entities\": \"true\",\n \"Mime type settings.application#47x#45plist.Text processing mode\": \"process_text\",\n \"Mime type settings.image#47vnd#46autocad#45dwf.Process images\": \"true\",\n \"Mime type settings.application#47vnd#46sqlite#45database.Store binary\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dxf.Text processing mode\": \"strip_text\",\n \"Mime type settings.text#47x#45common#45log.Store binary\": \"true\",\n \"Mime type settings.text#47tab#45separated#45values.Process images\": \"true\",\n \"Mime type settings.application#47exe.Text processing mode\": \"skip_text\",\n \"Mime type settings.text#47x#45common#45log.Process images\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dxf.Process images\": \"true\",\n \"Mime type settings.application#47vnd#46symantec#45vault#45stream#45data.Store binary\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45cab#45compressed.Process images\": \"true\",\n \"Mime type settings.text#47x#45common#45log.Process named entities\": \"true\",\n \"Populate graph database\": \"false\",\n \"Mime type settings.filesystem#47x#45ntfs#45mft.Store binary\": \"true\",\n \"Mime type settings.text#47csv.Text processing mode\": \"process_text\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45logx.Process embedded\": \"false\",\n \"Mime type settings.application#47vnd#46symantec#45vault#45stream#45data.Text processing mode\": \"process_text\",\n \"Perform ocr\": \"false\",\n \"Mime type settings.application#47vnd#46ms#45iis#45log.Text processing mode\": \"strip_text\",\n \"Mime type settings.application#47exe.Process embedded\": \"true\",\n \"Mime type settings.filesystem#47unallocated#45space#45chunk.Process embedded\": \"true\",\n \"Calculate photo DNA robust hash\": \"false\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45log.Text processing mode\": \"strip_text\",\n \"Mime type settings.image#47vnd#46autocad#45dwg.Store binary\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45shp.Process images\": \"true\",\n \"Process forensic images\": \"true\",\n \"Mime type settings.filesystem#47x#45ntfs#45usnjrnl.Process named entities\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dwg.Process named entities\": \"true\",\n \"Custom thumbnail selected\": \"false\",\n \"Face detection\": \"false\",\n \"Mime type settings.application#47vnd#46tcpdump#46pcap.Text processing mode\": \"strip_text\",\n \"Mime type settings.image#47vnd#46autocad#45dwf.Text processing mode\": \"strip_text\",\n \"Mime type settings.application#47vnd#46tcpdump#46pcap.Process named entities\": \"true\",\n \"Process loose file contents\": \"true\",\n \"Use named entity profile\": \"false\",\n \"Mime type settings.application#47vnd#46ms#45cab#45compressed.Store binary\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45log.Process named entities\": \"true\",\n \"Ocr profile name\": \"Default\",\n \"Mime type settings.text#47x#45common#45log.Process embedded\": \"false\",\n \"Create thumbnails\": \"false\",\n \"Mime type settings.image#47vnd#46autocad#45dwf.Process named entities\": \"true\",\n \"Imaging profile name\": \"Processing Default\",\n \"Mime type settings.image#47vnd#46autocad#45dwf.Store binary\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dwfx.Process embedded\": \"true\",\n \"Mime type settings.application#47x#45plist.Store binary\": \"true\",\n \"Digests\": \"MD5\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45log.Store binary\": \"true\",\n \"Mime type settings.filesystem#47x#45ntfs#45usnjrnl.Process embedded\": \"false\",\n \"Mime type settings.text#47csv.Process embedded\": \"false\",\n \"Mime type settings.image#47vnd#46autocad#45dwfx.Text processing mode\": \"strip_text\",\n \"Calculate SS deep fuzzy hash\": \"false\",\n \"Mime type settings.text#47x#45common#45log.Text processing mode\": \"strip_text\",\n \"Extract named entities from properties\": \"false\",\n \"Mime type settings.filesystem#47x#45ntfs#45logfile.Process named entities\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45shp.Process embedded\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dwg.Process embedded\": \"true\",\n \"Mime type settings.text#47tab#45separated#45values.Text processing mode\": \"process_text\",\n \"Mime type settings.application#47vnd#46ms#45registry.Process images\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45registry.Text processing mode\": \"process_text\",\n \"Mime type settings.filesystem#47unallocated#45space#45chunk.Text processing mode\": \"process_text\",\n \"Mime type settings.filesystem#47x#45ntfs#45logfile.Store binary\": \"true\",\n \"Mime type settings.application#47x#45pcapng.Process images\": \"true\",\n \"Calculate audited size\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45cab#45compressed.Process named entities\": \"true\",\n \"Mime type settings.application#47x#45pcapng.Process embedded\": \"false\",\n \"Mime type settings.filesystem#47x#45ntfs#45logfile.Process embedded\": \"false\",\n \"Mime type settings.filesystem#47x#45ntfs#45mft.Text processing mode\": \"strip_text\",\n \"Mime type settings.filesystem#47x#45ntfs#45usnjrnl.Process images\": \"true\",\n \"Workstation thumbnail selected\": \"false\",\n \"Mime type settings.image#47vnd#46autocad#45dwfx.Process named entities\": \"true\",\n \"Mime type settings.text#47csv.Process named entities\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45log.Process images\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45shp.Store binary\": \"true\",\n \"Process text\": \"true\",\n \"Mime type settings.filesystem#47x#45ntfs#45usnjrnl.Text processing mode\": \"strip_text\",\n \"Mime type settings.filesystem#47unallocated#45space#45chunk.Process images\": \"true\",\n \"Processing settings software version\": \"8.2.0.123\",\n \"Hide embedded immaterial data\": \"false\",\n \"Mime type settings.text#47tab#45separated#45values.Store binary\": \"true\",\n \"Extract named entities from text stripped\": \"false\",\n \"Mime type settings.image#47vnd#46autocad#45shp.Process named entities\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45cab#45compressed.Process embedded\": \"false\",\n \"Mime type settings.image#47vnd#46autocad#45dwg.Process images\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dwfx.Store binary\": \"true\",\n \"Mime type settings.filesystem#47x#45ntfs#45mft.Process images\": \"true\",\n \"Mime type settings.application#47vnd#46sqlite#45database.Text processing mode\": \"strip_text\",\n \"Mime type settings.application#47vnd#46ms#45registry.Process named entities\": \"true\",\n \"Mime type settings.application#47x#45plist.Process embedded\": \"false\",\n \"Web thumbnail selected\": \"false\",\n \"Mime type settings.filesystem#47x#45ntfs#45logfile.Text processing mode\": \"strip_text\",\n \"Custom processing aspects\": \"\",\n \"Mime type settings.application#47vnd#46sqlite#45database.Process embedded\": \"false\",\n \"Mime type settings.filesystem#47unallocated#45space#45chunk.Store binary\": \"true\",\n \"Mime type settings.text#47tab#45separated#45values.Process embedded\": \"false\",\n \"Mime type settings.image#47vnd#46autocad#45dxf.Store binary\": \"true\",\n \"Mime type settings.application#47exe.Store binary\": \"true\",\n \"Mime type settings.application#47vnd#46tcpdump#46pcap.Process embedded\": \"false\",\n \"Mime type settings.application#47vnd#46tcpdump#46pcap.Process images\": \"true\",\n \"Export metadata\": \"false\",\n \"Mime type settings.application#47vnd#46ms#45iis#45log.Process embedded\": \"false\",\n \"Mime type settings.application#47exe.Process named entities\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45cab#45compressed.Text processing mode\": \"process_text\",\n \"Skin tone analysis\": \"false\",\n \"Mime type settings.image#47vnd#46autocad#45dwg.Text processing mode\": \"strip_text\",\n \"Mime type settings.text#47csv.Store binary\": \"true\",\n \"Mime type settings.application#47x#45pcapng.Process named entities\": \"true\",\n \"Process text summaries\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45shp.Text processing mode\": \"strip_text\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45logx.Process named entities\": \"true\",\n \"Max digest size\": \"250 MB\",\n \"Extract shingles\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45registry.Store binary\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45iis#45log.Store binary\": \"true\",\n \"Max binary size\": \"250 MB\",\n \"Mime type settings.text#47tab#45separated#45values.Process named entities\": \"true\",\n \"Mime type settings.text#47csv.Process images\": \"true\",\n \"Mime type settings.application#47vnd#46ms#45iis#45log.Process named entities\": \"true\",\n \"Mime type settings.image#47vnd#46autocad#45dwf.Process embedded\": \"true\",\n \"Mime type settings.filesystem#47unallocated#45space#45chunk.Process named entities\": \"true\",\n \"Mime type settings.filesystem#47x#45ntfs#45mft.Process embedded\": \"false\",\n \"Reuse evidence stores\": \"false\",\n \"Create printed image\": \"false\",\n \"Mime type settings.application#47vnd#46ms#45windows#45event#45logx.Process images\": \"true\",\n \"Process family fields\": \"false\"\n },\n \"caseEvidenceSettings\": {\n \"Use stop words\": \"false,\",\n \"Use stemming\": \"false,\",\n \"Analysis language\": \"ENGLISH\"\n },\n \"additionalSettings\": {\n \"system.processorCount\": \"1\",\n \"system.isLowSpec\": \"true\",\n \"system.swapSpace\": \"0 bytes\",\n \"system.memory\": \"8.19 GB\",\n \"master.memory\": \"1.86 GB\",\n \"system.jvmMaxMemory\": \"8.19 GB\"\n },\n \"dataSettings\": {\n \"Use apsose for word text extraction\": \"false\",\n \"Recover deleted files\": \"true\",\n \"Add bcc to email digest\": \"false\",\n \"Identify physical files\": \"true\",\n \"Software version\": \"8.2.0.123\",\n \"Add communication date to email digest\": \"false\",\n \"Carve unidentified data\": \"false\",\n \"Extract end of file slack space\": \"false\",\n \"Expose binary data for directories\": \"false\",\n \"Direct access to mailboxes\": \"false\",\n \"Render dpi\": \"100\",\n \"Disabled mime types\": \"application/vnd.ms-registry,application/vnd.symantec-vault-stream-data\",\n \"Extract from slack space\": \"false\",\n \"Disabled carving mime types\": \"\",\n \"Carve file system unallocated space\": \"false\",\n \"Smart process registry\": \"false\"\n },\n \"loadedOn\": \"1576610430230,\",\n \"operatingSystem\": \"linux\",\n \"operatingSystemArchitecture\": \"amd64\",\n \"parallelProcessingSettings\": {\n \"Worker memory\": 1431,\n \"Broker memory\": 4096,\n \"User defined temp directory\": true,\n \"Embed broker\": true,\n \"Worker temp directory\": \"/tmp\",\n \"Run local workers\": true,\n \"Batch size\": null,\n \"Worker count\": 2,\n \"Worker broker address\": null\n },\n \"processArchitecture\": \"amd64\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "997802a9-5ae8-449a-bd52-6c359f3e74c8", "name": "Returns history events for a case", "request": { "name": "Returns history events for a case", "description": { "content": "Use this operation to get a list of history events associated\nwith a case. The events are returned in ascending order by date. Each history\nevent represents an individual action performed by a user. This following\nare the types of history events:\n\n* **openSession:** This event occurs at the start of a session with a case (for example, when the\ncase is opened).\n* **closeSession:** This event occurs at the end of a session with a case (for example, when the case is closed).\n* **loadData:** This event occurs when data is loaded into the case.\n* **search:** This event occurs when a search is performed.\n* **annotation:** This event occurs when items are annotated or tagged.\n* **export:** This event occurs when data or metadata is exported out of the case.\n* **import**: This event occurs when data or metadata is imported into the case. With import,\nthe data is directly imported without processing.\n* **delete:** This event occurs when data in the case is deleted.\n* **script:** This event occurs when a script is executed.\n* **printPreview:** This event occurs when a print preview action is executed.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "", "description": "Filters the type of history event returned. If not specified, all events are returned." }, { "disabled": false, "key": "user", "value": "", "description": "The user to return the events for. If the user does not exist, no records will be returned." }, { "disabled": false, "key": "startDateAfter", "value": "", "description": "The start date to filter after (only more recent events will be returned.) Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server." }, { "disabled": false, "key": "endDateBefore", "value": "", "description": "The start date to filter before (only earlier events will be returned.) Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server." }, { "disabled": false, "key": "order", "value": "start_date_ascending", "description": "The order to return the results in." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1f57829d-1080-46ff-b7d6-706e076ba1c9", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "user", "value": "" }, { "key": "startDateAfter", "value": "" }, { "key": "endDateBefore", "value": "" }, { "key": "order", "value": "start_date_ascending" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"cancelled\": false,\n \"details\": {\n \"searchString\": \"*\"\n },\n \"startDate\": 1588363137585,\n \"endDate\": 1588363137591,\n \"failed\": false,\n \"succeeded\": true,\n \"unknown\": false,\n \"type\": \"search\",\n \"username\": \"youruser\"\n },\n {\n \"cancelled\": false,\n \"details\": {\n \"version\": \"8.6.0.33\"\n },\n \"startDate\": 1588363137585,\n \"endDate\": 1588363137591,\n \"failed\": false,\n \"succeeded\": true,\n \"type\": \"openSession\",\n \"username\": \"youruser\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "992cc922-23ba-49fd-b145-55b6700d3075", "name": "Returns the set of custodians for a case", "request": { "name": "Returns the set of custodians for a case", "description": { "content": "Use this operation to view the custodians associated with a case. This is useful to see who is responsible for files in specific cases. The custodian names are returned as a set of strings.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "custodians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4eac72da-ef6f-4002-bc2b-c108c0c51530", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "custodians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"Homer Simpson\",\n \"Bart Simpson\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "023488e9-7550-4881-91cb-a4a3e6075455", "name": "Creates a custodian without assigning any items to them.", "request": { "name": "Creates a custodian without assigning any items to them.", "description": { "content": "Use this endpoint to create a custodian without assigning any items to them.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "custodians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f51c9e1-2b86-4e2a-9fc5-973a82a39a5a", "name": "Created", "originalRequest": { "url": { "path": [ "cases", ":caseId", "custodians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"MyCustodian\",\n \"description\": \"my custodian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4dd71df9-dcd9-45a2-894a-225260b74995", "name": "Finds a custodian by name.", "request": { "name": "Finds a custodian by name.", "description": { "content": "Use this endpoint to find a custodian by name.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "custodians", ":custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "custodian", "description": "(Required) The custodian name" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "297b586a-6914-40aa-8b16-082c077c6525", "name": "OK", "originalRequest": { "url": { "path": [ "cases", ":caseId", "custodians", ":custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "custodian", "description": "(Required) The custodian name" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"Homer Simpson\",\n \"description\": \"dad\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d9d494a-6724-4eb3-8e0d-ccc94c95f52f", "name": "Update a custodian.", "request": { "name": "Update a custodian.", "description": { "content": "Use this endpoint to update details about a custodian.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "custodians", ":custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "custodian", "description": "(Required) The custodian name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "43f0286f-97e7-42f3-8087-3b6a6121ab12", "name": "No Content", "originalRequest": { "url": { "path": [ "cases", ":caseId", "custodians", ":custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "custodian", "description": "(Required) The custodian name" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b813fce7-61c2-4ac6-b64f-409b7e4276c7", "name": "Deletes a custodian.", "request": { "name": "Deletes a custodian.", "description": { "content": "Deletes a custodian if it was not currently in use.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "custodians", ":custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "custodian", "description": "(Required) The name of the custodian" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "363da245-95dc-4555-9c0d-352a56b32677", "name": "OK", "originalRequest": { "url": { "path": [ "cases", ":caseId", "custodians", ":custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "custodian", "description": "(Required) The name of the custodian" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa9d36d3-b138-4856-9566-726151736cd1", "name": "Assign custodian to items", "request": { "name": "Assign custodian to items", "description": { "content": "Use this operation to assign custodian to items. Any custodians previously assigned to the items will automatically be unassigned.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "custodians", ":custodian", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "custodian", "description": "(Required) Custodian for the item" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"itemGuids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fca22114-977d-4696-80e3-54658d190503", "name": "OK", "originalRequest": { "url": { "path": [ "cases", ":caseId", "custodians", ":custodian", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "custodian", "description": "(Required) Custodian for the item" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"itemGuids\": [\n \"2352389c-64f9-410b-aeee-93a279022d9e\",\n \"eee4163d-574c-403e-8e6c-0a6c865904fd\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"itemGuids\": [\n \"string\",\n \"string\"\n ],\n \"successfulItemGuids\": [\n \"string\",\n \"string\"\n ],\n \"failedItemGuids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43da43a9-d9e7-49da-a958-bf089283da27", "name": "Assign custodian from the items", "request": { "name": "Assign custodian from the items", "description": { "content": "Use this operation to assign custodian from items.

This endpoint returns success response.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item identification token" }, { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"itemCustodian\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d0a7e84d-e8d7-4eae-aabd-b97b868ddd62", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item identification token" }, { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"itemCustodian\": \"this is an item custodian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"itemGuid\": \"9dd7ebaa-0671-4f73-add7-d38d920105eb\",\n \"itemCustodian\": \"this is an item custodian\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11ba8d52-7610-417e-b953-ff8ba54b85f9", "name": "Remove Assigned custodian from the items", "request": { "name": "Remove Assigned custodian from the items", "description": { "content": "Use this operation to remove the assigned custodian from items.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item identification token" }, { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "e8ded79c-61f5-4837-a348-27066758b368", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item identification token" }, { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2de0f945-e779-4aa4-92ad-c03696d52601", "name": "Get item custodian", "request": { "name": "Get item custodian", "description": { "content": "Use this operation to get the assigned custodian from items.

This endpoint returns custodian and item guid response.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0407f2f3-652e-4ea3-aa0a-c148fbe7e9e1", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "custodian" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"itemGuid\": \"9dd7ebaa-0671-4f73-add7-d38d920105eb\",\n \"itemCustodian\": \"this is an item custodian\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6502ea03-40c5-4ec1-81bf-52a6f918b962", "name": "Returns the set of entity types for a case", "request": { "name": "Returns the set of entity types for a case", "description": { "content": "Use this operation to retrieve the types of named entities associated with a case. Named entities are classified during data ingestion and include email addresses, credit card numbers, URLs, and more. The entity types are returned as a set of strings.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "entityTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e91b12ca-64b8-4f8e-9114-d9786f7f1447", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "entityTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"entityTypes\": [\n {\n \"name\": \"company\",\n \"localisedName\": \"Company\"\n },\n {\n \"name\": \"country\",\n \"localisedName\": \"United States\"\n },\n {\n \"name\": \"credit-card-num\",\n \"localisedName\": \"Credit Card\"\n },\n {\n \"name\": \"email\",\n \"localisedName\": \"Email\"\n },\n {\n \"name\": \"ip-address\",\n \"localisedName\": \"IP Address\"\n },\n {\n \"name\": \"money\",\n \"localisedName\": \"Money\"\n },\n {\n \"name\": \"person\",\n \"localisedName\": \"Person\"\n },\n {\n \"name\": \"personal-id-num\",\n \"localisedName\": \"Personal ID Number\"\n },\n {\n \"name\": \"phone-number\",\n \"localisedName\": \"Phone Number\"\n },\n {\n \"name\": \"url\",\n \"localisedName\": \"URL\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3302542-3a05-4981-835f-24020628d77a", "name": "Returns the tags in this review job", "request": { "name": "Returns the tags in this review job", "description": { "content": "Use this operation to view the list of tags associated with this review job. In order to advance to the next batch, all review job items must be tagged.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d8734d0d-25f6-4cfb-813f-d0818735f6bf", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"For Review\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c7b143-96d1-48e2-9449-c6b35edb7d3a", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bf5074e-a11a-4145-bd88-75d009a446a2", "name": "Returns the active reviewers in this review job", "request": { "name": "Returns the active reviewers in this review job", "description": { "content": "Use this operation to view the set of active users who have reviewed items under review job.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "reviewers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "26995926-b2a7-4c11-91d0-7b037fdd3500", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "reviewers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"longName\": \"assignedUser1\",\n \"shortName\": \"assignedUser1\"\n },\n {\n \"longName\": \"assignedUser2\",\n \"shortName\": \"assignedUser2\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f84ce75a-f7fe-4acf-8742-447f6022168f", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "reviewJobs", ":reviewJobNameOrGuid", "reviewers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "reviewJobNameOrGuid", "description": "(Required) Review job name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c916d97-77e1-49d3-b023-dd61c76bbca0", "name": "Returns the set of original file extensions for a case", "request": { "name": "Returns the set of original file extensions for a case", "description": { "content": "Use this operation to view all original file extensions in a case. You can also view whether a file has been renamed. The extensions are returned as a set of strings. To view the current file types associated with a case, use the itemTypes endpoint.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "originalExtensions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f1777331-ab83-4bd0-9975-1877bf93e3f7", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "originalExtensions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"txt\",\n \"dat\",\n \"docx\",\n \"gz\",\n \"html\",\n \"pdf\",\n \"png\",\n \"tiff\",\n \"xml\",\n \"yml\",\n \"zip\",\n \"tar\",\n \"log\",\n \"xlsx\",\n \"jpg\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "810aaf01-4229-47fe-b29e-abba747df3e9", "name": "Returns all languages found in the case", "request": { "name": "Returns all languages found in the case", "description": { "content": "Use this operation to see a list of all languages used in a case. This information is useful when analysing content and when working with analytics.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "languages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includeItemCounts", "value": "", "description": "Include counts for the languages" }, { "disabled": false, "key": "countScopingQuery", "value": "", "description": "Scope the counts to a provided query when includeItemCounts=true" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1e47036b-0aea-4174-8e2b-2e6e883d247e", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "languages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeItemCounts", "value": "" }, { "key": "countScopingQuery", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"code\": \"deu\",\n \"languageName\": \"German\",\n \"itemCount\": 3\n },\n {\n \"code\": \"eng\",\n \"languageName\": \"English\",\n \"itemCount\": 162\n },\n {\n \"code\": \"hrv\",\n \"languageName\": \"Croatian\",\n \"itemCount\": 12\n },\n {\n \"code\": \"ron\",\n \"languageName\": \"Romanian\",\n \"itemCount\": 9\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbfa312f-c36b-4e84-8618-cdebc9a27d11", "name": "Returns the investigation time zone for a case", "request": { "name": "Returns the investigation time zone for a case", "description": { "content": "Use this operation to find the time zone in which the case is being investigated. You can find a list of valid timezones at: http://www.joda.org/joda-time/timezones.html", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "investigatorTimeZone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "596dafec-8e6e-430d-a379-06f6d336554b", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "investigatorTimeZone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"timezone\": \"America/New_York\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fc399b9-0453-4c02-af81-e17cd14cb5a3", "name": "Sets the investigation time zone for a case", "request": { "name": "Sets the investigation time zone for a case", "description": { "content": "Use this operation to set the investigation time zone for a case. You can find a list of valid timezones at: http://www.joda.org/joda-time/timezones.html", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "investigatorTimeZone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"timezone\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9b029370-6689-4419-8098-7cff7e7b8bf7", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "investigatorTimeZone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"timezone\": \"Pacific/Honolulu\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4dbe6eb0-917e-4fdd-b6e0-3d329c084c70", "name": "Updates a markup set", "request": { "name": "Updates a markup set", "description": { "content": "Use this operation to update an existing markup set's description and redaction reason. Markup sets are applied to PDF's and used to revise sensitive content.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name of the markup set or guid." } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"redactionReason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "20fbf015-da96-40fd-a467-1e2740c299d0", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name of the markup set or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"redactionReason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"MyMarkupSet\",\n \"description\": \"This is an updated markup set.\",\n \"redactionReason\": \"The reason for this redaction has been updated.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05eac2f1-3e5c-4d80-a38d-17f6e9eef44f", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name of the markup set or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"redactionReason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c55106e4-07fe-4712-a760-0b271ef14303", "name": "Creates a markup set", "request": { "name": "Creates a markup set", "description": { "content": "Use this operation to create a redaction markup set. Markup sets are applied to PDF's and used to revise sensitive content.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name or GUID of the markup set" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"redactionReason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "894f3201-391a-4d29-8d89-7688d686eee8", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name or GUID of the markup set" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"MyMarkupSet\",\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fe9bbb0-ea9a-4a4c-b227-f72088a78b92", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name or GUID of the markup set" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"This is a markup set.\",\n \"redactionReason\": \"The reason for the redaction.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de968db2-2963-426a-bfa1-04ac24ecedca", "name": "Deletes a markup set", "request": { "name": "Deletes a markup set", "description": { "content": "Use this operation to delete a redaction markup set.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name or GUID of the markup set" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7e17ded0-0a17-4bdd-9279-6c3b838d8003", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name or GUID of the markup set" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true,\n \"name\": \"MyMarkupSet\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c94b8a03-276e-47ce-8892-1212efe606b7", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "markupSet", ":markupSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "markupSetNameOrGuid", "description": "(Required) The name or GUID of the markup set" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bcbdf50-12fb-461a-87a4-b06827b79ff1", "name": "Indicates word usage and frequency in a case", "request": { "name": "Indicates word usage and frequency in a case", "description": { "content": "Use this operation to view a list of words and their frequency in the text. The word count is derived from the case text and properties.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "wordCounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"\",\n \"\"\n ],\n \"deduplication\": \"none\",\n \"field\": \"all\",\n \"sort\": \"off\",\n \"minOccurs\": \"\",\n \"maxOccurs\": \"\",\n \"minWordLength\": \"\",\n \"maxWordLength\": \"\",\n \"filter\": \"all\",\n \"maxResults\": 200\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fee5f549-40a8-4015-99d8-54a5e7dbcb56", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "wordCounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"springfield\"\n ],\n \"deduplication\": \"md5\",\n \"field\": \"properties\",\n \"sort\": \"on\",\n \"maxResults\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"springfield\": [\n {\n \"word\": \"file\",\n \"count\": 7\n },\n {\n \"word\": \"r\",\n \"count\": 2\n },\n {\n \"word\": \"owner\",\n \"count\": 1\n },\n {\n \"word\": \"set\",\n \"count\": 1\n },\n {\n \"word\": \"rw\",\n \"count\": 1\n },\n {\n \"word\": \"created\",\n \"count\": 1\n },\n {\n \"word\": \"staff\",\n \"count\": 1\n },\n {\n \"word\": \"accessed\",\n \"count\": 1\n },\n {\n \"word\": \"txt\",\n \"count\": 1\n },\n {\n \"word\": \"character\",\n \"count\": 1\n },\n {\n \"word\": \"permissions\",\n \"count\": 1\n },\n {\n \"word\": \"name\",\n \"count\": 1\n },\n {\n \"word\": \"modified\",\n \"count\": 1\n },\n {\n \"word\": \"springfield\",\n \"count\": 1\n },\n {\n \"word\": \"ascii\",\n \"count\": 1\n },\n {\n \"word\": \"posix\",\n \"count\": 1\n },\n {\n \"word\": \"us\",\n \"count\": 1\n },\n {\n \"word\": \"changed\",\n \"count\": 1\n },\n {\n \"word\": \"group\",\n \"count\": 1\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34d78fec-944d-4d23-8836-06cda701994b", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "wordCounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"springfield\"\n ],\n \"deduplication\": \"md5\",\n \"field\": \"properties\",\n \"sort\": \"on\",\n \"maxResults\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d14173dd-521e-4e25-bb5a-5e49cdb8bce7", "name": "Returns total audit sizes for items matching a query", "request": { "name": "Returns total audit sizes for items matching a query", "description": { "content": "Provides total audit size for items matching each query in a list of queries.\n**NOTE:** This method will only work for cases loaded with \"Calculate audited size\" option set\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "auditSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"\",\n \"\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "349b8d2d-5ab5-43ba-9e18-df028c2b7167", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "auditSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"*\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"query\": \"*\",\n \"size\": 1198749\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb8bd5a0-f940-475e-80d4-0d0c8447016a", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "auditSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"*\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "228f78af-7b32-4583-8b5d-61a3d26df5d6", "name": "Returns total file sizes for items matching a query", "request": { "name": "Returns total file sizes for items matching a query", "description": { "content": "Provides total file size for items matching each query in a list of queries.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "fileSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"\",\n \"\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7344b988-1338-43cc-abc7-cad2e2a589de", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "fileSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"*\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"query\": \"*\",\n \"size\": 1233932\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b1cb4ea-5612-4a0c-aefd-428073b759dd", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "fileSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"*\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "477f825c-a717-4e79-ba96-617c14cf5e9f", "name": "Compute total sizes for items matching a query", "request": { "name": "Compute total sizes for items matching a query", "description": { "content": "Asynchronously provides total audit or file size for items matching each query in a list of queries.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"\",\n \"\"\n ],\n \"deduplication\": \"none\",\n \"sizeType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "50328739-eeee-4288-ba71-9704151a8a1f", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"*\"\n ],\n \"deduplication\": \"none\",\n \"sizeType\": \"FILE_SIZE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4b00581-f7a4-4d4b-ba24-1511b418f8f5", "name": "missing argument exception", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"*\"\n ],\n \"deduplication\": \"none\",\n \"sizeType\": \"FILE_SIZE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"REQUIRED_ARGUMENT_MISSING\",\n \"developerMessage\": \"The request is missing 1 or more required arguments. See the 'missingArguments' field in 'additionalInfo' for the list of arguments that are missing.\",\n \"userMessage\": null,\n \"additionalinfo\": {\n \"missingArguments\": [\n \"sizeType\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "667886f5-b507-41ad-a4be-1eca7f5321e0", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSizes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"*\"\n ],\n \"deduplication\": \"none\",\n \"sizeType\": \"FILE_SIZE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "624b9c7c-bc20-4e7b-87ce-63b967f239c4", "name": "Asynchronously indicates word usage and frequency in a case", "request": { "name": "Asynchronously indicates word usage and frequency in a case", "description": { "content": "Use this operation to (asynchronously) view a list of words and\ntheir frequency in the text. The word count is derived from the case text\nand properties.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "asyncFunctions", "wordCounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"\",\n \"\"\n ],\n \"deduplication\": \"none\",\n \"field\": \"all\",\n \"sort\": \"off\",\n \"minOccurs\": \"\",\n \"maxOccurs\": \"\",\n \"minWordLength\": \"\",\n \"maxWordLength\": \"\",\n \"filter\": \"all\",\n \"maxResults\": 200\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9794650a-5e6a-458c-bc3f-dd51b98c99b2", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "asyncFunctions", "wordCounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"springfield\"\n ],\n \"deduplication\": \"md5\",\n \"field\": \"properties\",\n \"sort\": \"on\",\n \"maxResults\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"50960b90-1723-4af7-bed6-207fd37b7a5e\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/50960b90-1723-4af7-bed6-207fd37b7a5e\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d8476bf-eca7-41bc-9404-d87f0c4d4f97", "name": "Returns statistics for families of top-level items matching a query", "request": { "name": "Returns statistics for families of top-level items matching a query", "description": { "content": "Provides statistics for families of top-level items matching a query. The returned results from each query must be all top-level items\nor an exception will be thrown.\n\nThis method will only work for cases loaded with both \"Calculate audited size\" and \"Process family fields\" options set\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "familyStatistics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"\",\n \"\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0617ddbf-5e0d-4052-a663-6b8ef8447f10", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "familyStatistics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"kind:document\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"query\": \"kind:document\",\n \"auditSize\": 822840,\n \"itemCount\": 1,\n \"auditItemCount\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c97cba-b58f-40dc-b9d9-e665889dd31c", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "familyStatistics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"kind:document\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2a04d3a-ebec-4cf4-8352-eba12b0f9d99", "name": "Asynchronously returns statistics for families of top-level items matching a query", "request": { "name": "Asynchronously returns statistics for families of top-level items matching a query", "description": { "content": "Provides statistics (asynchronously) for families of top-level items matching a query. The returned results from each query must be all\ntop-level items or an exception will be thrown.\n\nThis method will only work for cases loaded with both \"Calculate audited size\" and \"Process family fields\" options set\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "asyncFunctions", "familyStatistics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"\",\n \"\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aa0666f1-c221-46b9-9f1e-1054f9f15d77", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "asyncFunctions", "familyStatistics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"kind:document\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"2e458caf-181b-4885-a6ac-c64f6fb24a1e\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/2e458caf-181b-4885-a6ac-c64f6fb24a1e\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87504e1b-ff60-441e-8719-2daed8cede11", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "asyncFunctions", "familyStatistics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"queryList\": [\n \"kind:document\"\n ],\n \"deduplication\": \"none\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48b83a39-f08f-4977-8f64-ba6e6adf2abe", "name": "Returns the total number of items in a case", "request": { "name": "Returns the total number of items in a case", "description": { "content": "Use this operation to view the total number of items in a case. This is useful for informational purposes, such as seeing whether a case contains items. Using this endpoint you can also count the number of items in a query. For example, if the query is kind:document, this endpoint will return the number of documents in the case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "query", "value": "", "description": "Query items that should be included. If a query is not supplied it defaults to an empty string, which returns everything." }, { "disabled": false, "key": "deduplication", "value": "none", "description": "How the deduplication is applied. 'none' returns all items matching the query including duplicates. 'md5' and 'per custodian' returns deduplicated items based on the deduplication method used." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7f695450-760f-4fbe-b384-b6d7256152fd", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "" }, { "key": "deduplication", "value": "none" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"count\": 25106,\n \"query\": \"\",\n \"casePath\": \"/cases/mycase\",\n \"caseGuid\": \"219f69f5eee14cf6b8c8c15d7cc2dd1e\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cf8b59f-3942-4962-8cd6-be3748cba670", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "" }, { "key": "deduplication", "value": "none" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fdc5c55-7887-4ded-a612-9b83c4087f5d", "name": "Returns the number of items associated with a case query", "request": { "name": "Returns the number of items associated with a case query", "description": { "content": "Use this operation to see the number of items that match a query in a case. For example, if you want to see the number of images in a case, you can perform a count query with a kind:image query.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "deduplication", "value": "none", "description": "How the deduplication is applied. 'none' returns all items matching the query including duplicates. 'md5' and 'per custodian' returns deduplicated items based on the deduplication method used." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "896ce3da-78ea-4950-86a3-e60a1121bed4", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "deduplication", "value": "none" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"count\": 25106,\n \"query\": \"\",\n \"casePath\": \"/cases/mycase\",\n \"caseGuid\": \"219f69f5eee14cf6b8c8c15d7cc2dd1e\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b722c49-fbaa-4506-aca0-b9fe27239b80", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "deduplication", "value": "none" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dec3feae-1af2-4c70-8d0a-af93216f00b8", "name": "Returns item text", "request": { "name": "Returns item text", "description": { "content": "Use this operation to retrieve item text from an item in a case. A Boolean field **(htmlEscape)** is available to escape characters for HTML. By default, text is not escaped.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "itemText" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "htmlEscape", "value": "false", "description": "Replaces newline and tab characters with their HTML variants" }, { "disabled": false, "key": "limitInMb", "value": "", "description": "Overrides the default item text limit set by the system. The value is in Megabytes." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ce189939-2117-4d1d-a4bc-0540711d6b93", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "itemText" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "htmlEscape", "value": "false" }, { "key": "limitInMb", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"text\": \"\\n\\nLorem ipsum dolor sit amet, consectetur adipiscing elit.\\n\",\n \"binaryAvailable\": true,\n \"htmlEscape\": false,\n \"totalTextLength\": 62,\n \"blank\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "762954ce-56e9-4fcf-83a2-3ae1fa944dd3", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "itemText" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "htmlEscape", "value": "false" }, { "key": "limitInMb", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7aae9a5-5878-4a91-9cd3-2fa0c95e1a7e", "name": "Returns search hits for an item", "request": { "name": "Returns search hits for an item", "description": { "content": "Use this operation to retrieve the search hits for an item given a query. Search hits are returned for item properties and text content only.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "searchHits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "property", "value": "", "description": "List of properties associated with this item" }, { "disabled": false, "key": "property", "value": "", "description": "List of properties associated with this item" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "90f79c4e-b698-41b4-9c59-2fb3292dae44", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "searchHits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "property", "value": "" }, { "key": "property", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"terms\": [\n \"searchTerm\"\n ],\n \"text\": {\n \"term\": \"searchTerm\",\n \"count\": 2\n },\n \"properties\": {\n \"Name\": [\n {\n \"term\": \"searchTerm\",\n \"count\": 1\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad9855dd-776a-4c2d-8a0b-57d6c59f563a", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "searchHits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "property", "value": "" }, { "key": "property", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee7509a6-bffc-4555-8324-93882f9ef78d", "name": "Returns information for a specific item in a case", "request": { "name": "Returns information for a specific item in a case", "description": { "content": "Use this operation to view fields, properties, and the metadata profile for a specific item in a case. You can retrieve fields or properties in addition to what is defined in the item''s metadata profile.\nFor example, if you query an item by its globally unique identifier (GUID) and use the default metadata profile, you will see the following information:\n\n * file type\n * name\n * path name\n * GUID\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "field", "value": "", "description": "Fields:\n * `all` - Returns all fields for the item.\n * `auditedSize` - Returns the item''s audited size.\n * `children` - Returns a list of the item''s children.\n * `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.\n * `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.\n * `comment` - Returns item comments.\n * `communication` - If the item is a communication, this returns item communication information.\n * `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.\n * `custodian` - Returns the custodian assigned to an item.\n * `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.\n * `date` - Returns the item date.\n * `descendants` - Gets the list of items which are descendants of this item.\n * `digests` - Returns a map of the computed digests for an item.\n * `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.\n * `duplicates` - Returns duplicates of this item.\n * `evidenceMetadata` - Returns custom evidence metadata for the item.\n * `exclusion` - Returns the reason for an item''s exclusion.\n * `family` - Returns a list of items in the same family.\n * `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.\n * `fileType` - Returns the name of the file type.\n * `guid` - Returns the item''s globally unique identifier (GUID).\n * `history` - Returns the item''s history in ascending order by date.\n * `id` - Returns the item''s ID.\n * `isAudited` - Tests whether the item is considered audited and returns true or false.\n * `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it. This returns\n true if the item had binary data at processing time that was not stored. This\n differs from isStored() as this method returns true if the item had binary\n data at processing time that was not stored.\n * `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned\n if stored binary exists. In this case, the source data isn''t required for\n binary export.\n * `isChatMessage` - Tests whether the item is a chat message.\n * `isChatConversation` - Tests whether the item is a chat conversation.\n * `isDeleted` - Tests whether the item was marked as deleted and returns true or false.\n * `isEmailThreadMember` - Tests whether the item is part of an email thread.\n * `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.\n * `isExcluded` - Tests whether the item was marked as excluded.\n * `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).\n * `isIncuded` - Tests whether the item is included and returns true or false.\n * `isLooseFile` - Tests whether the item is a loose file and returns true or false.\n * `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.\n * `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field\n is useful when you only need to know if a printed image exists for this item.\n This is faster and uses fewer resources than requesting the printedImageInfo\n field.\n * `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.\n * `isTextStored` - Tests hether the item has text stored against it in the database. In the event\n where you only want to know if the item had text but didn''t need the text\n this field is considerably faster and more conservative of resources than\n isTextAvailable.\n * `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.\n * `isTopLevel` - Tests whether this is a top-level item and returns true or false.\n * `itemCategory` - Returns the item category.\n * `kind` - Returns the item kind.\n * `language` - Returns the language identified by the item.\n * `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])\n if the name is blank.\n * `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.\n * `name` - Returns the item name.\n * `originalExtension` - Returns the original extension listed on the source file.\n * `parent` - Returns the parent of this item.\n * `path` - Returns an item list which represents the path from the root evidence container to the item.\n * `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.\n * `pathNames` - Returns a list of item names on the path from the root evidence container to the item.\n * `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.\n * `printedImageInfo` - Returns information about the printed image.\n * `properties` - Returns item properties.\n * `root` - Returns the root item. If this item is the root, the item itself is returned.\n * `rootUri` - Returns the item''s root URI as a string.\n * `tags` - Returns the item tags.\n * `text` - Returns the text of the item as a string.\n * `textHtml` - Returns the text of the item escaped for HTML.\n * `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.\n * `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.\n * `threadItems` - Returns items that are in the same discussion thread as this item.\n * `topLevelItem` - Returns the associated top-level item.\n * `topLevelItemDate` - Returns the associated top-level item date.\n * `type` - Returns the type name.\n * `typeLocalisedName` - Returns the type name, localised appropriately for display to users.\n * `uri` - Returns the item''s uniform resource identifier (URI) as a string.\n" }, { "disabled": false, "key": "field", "value": "", "description": "Fields:\n * `all` - Returns all fields for the item.\n * `auditedSize` - Returns the item''s audited size.\n * `children` - Returns a list of the item''s children.\n * `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.\n * `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.\n * `comment` - Returns item comments.\n * `communication` - If the item is a communication, this returns item communication information.\n * `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.\n * `custodian` - Returns the custodian assigned to an item.\n * `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.\n * `date` - Returns the item date.\n * `descendants` - Gets the list of items which are descendants of this item.\n * `digests` - Returns a map of the computed digests for an item.\n * `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.\n * `duplicates` - Returns duplicates of this item.\n * `evidenceMetadata` - Returns custom evidence metadata for the item.\n * `exclusion` - Returns the reason for an item''s exclusion.\n * `family` - Returns a list of items in the same family.\n * `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.\n * `fileType` - Returns the name of the file type.\n * `guid` - Returns the item''s globally unique identifier (GUID).\n * `history` - Returns the item''s history in ascending order by date.\n * `id` - Returns the item''s ID.\n * `isAudited` - Tests whether the item is considered audited and returns true or false.\n * `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it. This returns\n true if the item had binary data at processing time that was not stored. This\n differs from isStored() as this method returns true if the item had binary\n data at processing time that was not stored.\n * `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned\n if stored binary exists. In this case, the source data isn''t required for\n binary export.\n * `isChatMessage` - Tests whether the item is a chat message.\n * `isChatConversation` - Tests whether the item is a chat conversation.\n * `isDeleted` - Tests whether the item was marked as deleted and returns true or false.\n * `isEmailThreadMember` - Tests whether the item is part of an email thread.\n * `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.\n * `isExcluded` - Tests whether the item was marked as excluded.\n * `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).\n * `isIncuded` - Tests whether the item is included and returns true or false.\n * `isLooseFile` - Tests whether the item is a loose file and returns true or false.\n * `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.\n * `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field\n is useful when you only need to know if a printed image exists for this item.\n This is faster and uses fewer resources than requesting the printedImageInfo\n field.\n * `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.\n * `isTextStored` - Tests hether the item has text stored against it in the database. In the event\n where you only want to know if the item had text but didn''t need the text\n this field is considerably faster and more conservative of resources than\n isTextAvailable.\n * `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.\n * `isTopLevel` - Tests whether this is a top-level item and returns true or false.\n * `itemCategory` - Returns the item category.\n * `kind` - Returns the item kind.\n * `language` - Returns the language identified by the item.\n * `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])\n if the name is blank.\n * `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.\n * `name` - Returns the item name.\n * `originalExtension` - Returns the original extension listed on the source file.\n * `parent` - Returns the parent of this item.\n * `path` - Returns an item list which represents the path from the root evidence container to the item.\n * `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.\n * `pathNames` - Returns a list of item names on the path from the root evidence container to the item.\n * `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.\n * `printedImageInfo` - Returns information about the printed image.\n * `properties` - Returns item properties.\n * `root` - Returns the root item. If this item is the root, the item itself is returned.\n * `rootUri` - Returns the item''s root URI as a string.\n * `tags` - Returns the item tags.\n * `text` - Returns the text of the item as a string.\n * `textHtml` - Returns the text of the item escaped for HTML.\n * `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.\n * `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.\n * `threadItems` - Returns items that are in the same discussion thread as this item.\n * `topLevelItem` - Returns the associated top-level item.\n * `topLevelItemDate` - Returns the associated top-level item date.\n * `type` - Returns the type name.\n * `typeLocalisedName` - Returns the type name, localised appropriately for display to users.\n * `uri` - Returns the item''s uniform resource identifier (URI) as a string.\n" }, { "disabled": false, "key": "property", "value": "", "description": "List of properties associated with this item" }, { "disabled": false, "key": "property", "value": "", "description": "List of properties associated with this item" }, { "disabled": false, "key": "metadataProfile", "value": "", "description": "Metadata profile name. Needed to get custom metadata." }, { "disabled": false, "key": "customMetadataField", "value": "", "description": "Specifies the custom metadata fields to return." }, { "disabled": false, "key": "customMetadataField", "value": "", "description": "Specifies the custom metadata fields to return." }, { "disabled": false, "key": "parameterizedField", "value": "", "description": "Specifies parameterized fields in a key/value pair separated by a colon.\n * `entities` - corresponds to item.getEntities. (e.g., \"entities:company\")\n * `serializedItem` - returns a serialized copy of the item. (e.g., \"seralizedItem:topLevelItem\")\n * `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., \"textTruncated:10000\")\n * `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., \"thumbnail:200x200\")\n * `nearDupeThreshold` - (e.g., \"nearDupeThreshold:0.9\")\n * `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., \"emailThreadCluster:cluster-1\")\n" }, { "disabled": false, "key": "parameterizedField", "value": "", "description": "Specifies parameterized fields in a key/value pair separated by a colon.\n * `entities` - corresponds to item.getEntities. (e.g., \"entities:company\")\n * `serializedItem` - returns a serialized copy of the item. (e.g., \"seralizedItem:topLevelItem\")\n * `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., \"textTruncated:10000\")\n * `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., \"thumbnail:200x200\")\n * `nearDupeThreshold` - (e.g., \"nearDupeThreshold:0.9\")\n * `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., \"emailThreadCluster:cluster-1\")\n" }, { "disabled": false, "key": "entities", "value": "", "description": "List of entity names to include in response (e.g. company, email)" }, { "disabled": false, "key": "entities", "value": "", "description": "List of entity names to include in response (e.g. company, email)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f2c46791-f6a1-4842-ada4-7cd104c0aa8f", "name": "The response is a map that represents a Nuix item that is described using the following schema: Map ", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "field", "value": "" }, { "key": "field", "value": "" }, { "key": "property", "value": "" }, { "key": "property", "value": "" }, { "key": "metadataProfile", "value": "Default" }, { "key": "customMetadataField", "value": "" }, { "key": "customMetadataField", "value": "" }, { "key": "parameterizedField", "value": "" }, { "key": "parameterizedField", "value": "" }, { "key": "entities", "value": "" }, { "key": "entities", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"File Type\": \"Microsoft 2007 Word Document\",\n \"Name\": \"MyWordDoc.docx\",\n \"Path Name\": \"/Evidence 1/Documents\",\n \"guid\": \"5cc38060-640c-4fbb-91d0-b319812a5f0b\",\n \"localizedMetadataKeys\": [\n \"Name\",\n \"File Type\",\n \"Path Name\"\n ],\n \"metadataItemDetails\": [\n {\n \"name\": \"Name\",\n \"localisedName\": \"Name\",\n \"type\": \"String\"\n },\n {\n \"name\": \"File Type\",\n \"localisedName\": \"File Type\",\n \"type\": \"String\"\n },\n {\n \"name\": \"Path Name\",\n \"localisedName\": \"Path Name\",\n \"type\": \"String\"\n }\n ],\n \"metadataKeys\": [\n \"Name\",\n \"File Type\",\n \"Path Name\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9a34baa-3d52-4cf8-ad6f-fc870d547a3a", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "field", "value": "" }, { "key": "field", "value": "" }, { "key": "property", "value": "" }, { "key": "property", "value": "" }, { "key": "metadataProfile", "value": "Default" }, { "key": "customMetadataField", "value": "" }, { "key": "customMetadataField", "value": "" }, { "key": "parameterizedField", "value": "" }, { "key": "parameterizedField", "value": "" }, { "key": "entities", "value": "" }, { "key": "entities", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddec40ab-2f73-4ef0-82d4-4a1c5bed95cf", "name": "Returns the top-level items for a case", "request": { "name": "Returns the top-level items for a case", "description": { "content": "Use this operation to view all items specified as top-level in a case. The item fields to be returned are identified by the optional itemFields parameter. If no itemFields parameter is supplied, then all item fields are returned for this operation. Top-level items provide context for information. For example, for an email attachment, the top-level item is an email.\nThe response List[Map] returns the same map as the cases/{caseId}/items/{itemGuid} endpoint.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "topLevelItems" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "", "description": "Fields:\n * `all` - Returns all fields for the item.\n * `auditedSize` - Returns the item''s audited size.\n * `children` - Returns a list of the item''s children.\n * `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.\n * `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.\n * `comment` - Returns item comments.\n * `communication` - If the item is a communication, this returns item communication information.\n * `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.\n * `custodian` - Returns the custodian assigned to an item.\n * `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.\n * `date` - Returns the item date.\n * `descendants` - Gets the list of items which are descendants of this item.\n * `digests` - Returns a map of the computed digests for an item.\n * `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.\n * `duplicates` - Returns duplicates of this item.\n * `evidenceMetadata` - Returns custom evidence metadata for the item.\n * `exclusion` - Returns the reason for an item''s exclusion.\n * `family` - Returns a list of items in the same family.\n * `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.\n * `fileType` - Returns the name of the file type.\n * `guid` - Returns the item''s globally unique identifier (GUID).\n * `history` - Returns the item''s history in ascending order by date.\n * `id` - Returns the item''s ID.\n * `isAudited` - Tests whether the item is considered audited and returns true or false.\n * `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it. This returns\n true if the item had binary data at processing time that was not stored. This\n differs from isStored() as this method returns true if the item had binary\n data at processing time that was not stored.\n * `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned\n if stored binary exists. In this case, the source data isn''t required for\n binary export.\n * `isChatMessage` - Tests whether the item is a chat message.\n * `isChatConversation` - Tests whether the item is a chat conversation.\n * `isDeleted` - Tests whether the item was marked as deleted and returns true or false.\n * `isEmailThreadMember` - Tests whether the item is part of an email thread.\n * `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.\n * `isExcluded` - Tests whether the item was marked as excluded.\n * `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).\n * `isIncuded` - Tests whether the item is included and returns true or false.\n * `isLooseFile` - Tests whether the item is a loose file and returns true or false.\n * `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.\n * `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field\n is useful when you only need to know if a printed image exists for this item.\n This is faster and uses fewer resources than requesting the printedImageInfo\n field.\n * `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.\n * `isTextStored` - Tests hether the item has text stored against it in the database. In the event\n where you only want to know if the item had text but didn''t need the text\n this field is considerably faster and more conservative of resources than\n isTextAvailable.\n * `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.\n * `isTopLevel` - Tests whether this is a top-level item and returns true or false.\n * `itemCategory` - Returns the item category.\n * `kind` - Returns the item kind.\n * `language` - Returns the language identified by the item.\n * `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])\n if the name is blank.\n * `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.\n * `name` - Returns the item name.\n * `originalExtension` - Returns the original extension listed on the source file.\n * `parent` - Returns the parent of this item.\n * `path` - Returns an item list which represents the path from the root evidence container to the item.\n * `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.\n * `pathNames` - Returns a list of item names on the path from the root evidence container to the item.\n * `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.\n * `printedImageInfo` - Returns information about the printed image.\n * `properties` - Returns item properties.\n * `root` - Returns the root item. If this item is the root, the item itself is returned.\n * `rootUri` - Returns the item''s root URI as a string.\n * `tags` - Returns the item tags.\n * `text` - Returns the text of the item as a string.\n * `textHtml` - Returns the text of the item escaped for HTML.\n * `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.\n * `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.\n * `threadItems` - Returns items that are in the same discussion thread as this item.\n * `topLevelItem` - Returns the associated top-level item.\n * `topLevelItemDate` - Returns the associated top-level item date.\n * `type` - Returns the type name.\n * `typeLocalisedName` - Returns the type name, localised appropriately for display to users.\n * `uri` - Returns the item''s uniform resource identifier (URI) as a string.\n" }, { "disabled": false, "key": "fields", "value": "", "description": "Fields:\n * `all` - Returns all fields for the item.\n * `auditedSize` - Returns the item''s audited size.\n * `children` - Returns a list of the item''s children.\n * `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.\n * `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.\n * `comment` - Returns item comments.\n * `communication` - If the item is a communication, this returns item communication information.\n * `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.\n * `custodian` - Returns the custodian assigned to an item.\n * `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.\n * `date` - Returns the item date.\n * `descendants` - Gets the list of items which are descendants of this item.\n * `digests` - Returns a map of the computed digests for an item.\n * `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.\n * `duplicates` - Returns duplicates of this item.\n * `evidenceMetadata` - Returns custom evidence metadata for the item.\n * `exclusion` - Returns the reason for an item''s exclusion.\n * `family` - Returns a list of items in the same family.\n * `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.\n * `fileType` - Returns the name of the file type.\n * `guid` - Returns the item''s globally unique identifier (GUID).\n * `history` - Returns the item''s history in ascending order by date.\n * `id` - Returns the item''s ID.\n * `isAudited` - Tests whether the item is considered audited and returns true or false.\n * `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it. This returns\n true if the item had binary data at processing time that was not stored. This\n differs from isStored() as this method returns true if the item had binary\n data at processing time that was not stored.\n * `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned\n if stored binary exists. In this case, the source data isn''t required for\n binary export.\n * `isChatMessage` - Tests whether the item is a chat message.\n * `isChatConversation` - Tests whether the item is a chat conversation.\n * `isDeleted` - Tests whether the item was marked as deleted and returns true or false.\n * `isEmailThreadMember` - Tests whether the item is part of an email thread.\n * `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.\n * `isExcluded` - Tests whether the item was marked as excluded.\n * `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).\n * `isIncuded` - Tests whether the item is included and returns true or false.\n * `isLooseFile` - Tests whether the item is a loose file and returns true or false.\n * `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.\n * `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field\n is useful when you only need to know if a printed image exists for this item.\n This is faster and uses fewer resources than requesting the printedImageInfo\n field.\n * `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.\n * `isTextStored` - Tests hether the item has text stored against it in the database. In the event\n where you only want to know if the item had text but didn''t need the text\n this field is considerably faster and more conservative of resources than\n isTextAvailable.\n * `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.\n * `isTopLevel` - Tests whether this is a top-level item and returns true or false.\n * `itemCategory` - Returns the item category.\n * `kind` - Returns the item kind.\n * `language` - Returns the language identified by the item.\n * `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])\n if the name is blank.\n * `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.\n * `name` - Returns the item name.\n * `originalExtension` - Returns the original extension listed on the source file.\n * `parent` - Returns the parent of this item.\n * `path` - Returns an item list which represents the path from the root evidence container to the item.\n * `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.\n * `pathNames` - Returns a list of item names on the path from the root evidence container to the item.\n * `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.\n * `printedImageInfo` - Returns information about the printed image.\n * `properties` - Returns item properties.\n * `root` - Returns the root item. If this item is the root, the item itself is returned.\n * `rootUri` - Returns the item''s root URI as a string.\n * `tags` - Returns the item tags.\n * `text` - Returns the text of the item as a string.\n * `textHtml` - Returns the text of the item escaped for HTML.\n * `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.\n * `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.\n * `threadItems` - Returns items that are in the same discussion thread as this item.\n * `topLevelItem` - Returns the associated top-level item.\n * `topLevelItemDate` - Returns the associated top-level item date.\n * `type` - Returns the type name.\n * `typeLocalisedName` - Returns the type name, localised appropriately for display to users.\n * `uri` - Returns the item''s uniform resource identifier (URI) as a string.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4310727e-1ad2-4d9a-ac22-0da4e04dcd12", "name": "The response is a map that represents a Nuix item that is described using the following schema: Map ", "originalRequest": { "url": { "path": [ "cases", ":caseId", "topLevelItems" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "" }, { "key": "fields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"Name\": \"MyWordDoc.docx\",\n \"File Type\": \"Microsoft 2007 Word Document\",\n \"Path Name\": \"/Evidence 1/Documents\",\n \"guid\": \"5cc38060-640c-4fbb-91d0-b319812a5f0b\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5012af3f-03c3-4423-a8e8-c44c37a2b1ce", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "topLevelItems" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "" }, { "key": "fields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c8cdc79-9e17-45c3-887a-ed33cdaa4d57", "name": "Returns comments for an item", "request": { "name": "Returns comments for an item", "description": { "content": "Use this operation to view comments associated with an item. Multiple comments are delimeted by the newline (\\n) character.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "783837e4-8366-4d76-81e0-06b50e6be530", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"itemGuid\": \"9dd7ebaa-0671-4f73-add7-d38d920105eb\",\n \"itemComment\": \"this is an item comment\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d6a7648-406f-4f6e-8424-8fa28b066b01", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8be409b2-2f53-4aeb-aadc-5da032ac57b2", "name": "Applies a comment to an item", "request": { "name": "Applies a comment to an item", "description": { "content": "Use this operation to apply a comment to an item. This will modify any existing comment. The boolean field **(append)** is available to let you replace or append the comment. By default, existing comments are replaced. Appended comments are done so with the newline (\\n) character.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "comment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "append", "value": "false", "description": "Append to existing comment" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"itemComment\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9ba70fa6-f5c6-4a50-98be-76be3b012b3c", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "comment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "append", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"itemComment\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"itemGuid\": \"9dd7ebaa-0671-4f73-add7-d38d920105eb\",\n \"itemComment\": \"this is an item comment\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d94ab139-24fd-4a11-8ec6-74d56d054108", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "comment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "append", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"itemComment\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b8f60fb-1280-453a-918c-e832f9e236c8", "name": "Calculates the number of shingles associated with a case's items", "request": { "name": "Calculates the number of shingles associated with a case's items", "description": { "content": "Use this operation to see how many shingles are associated with\nthe items in a case. This operation starts an asynchronous task to count the\nshingles.\n\nShingling enables you to find near-duplicate items by extracting the textual essence from each document and applying that pattern to a data set\nto find similar documents. Each shingle, or pattern, generally consists of a phrase of 5 or 6 words. For example, you could use shingling\nto find the Word document that a PDF was created from. The binary makeup of the documents is different, but the content is the same.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemShingles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"maxItems\": 1000,\n \"maxShingleResponse\": 100\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "01655703-eeaf-4b8b-9e2b-20233bfa050f", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemShingles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"query\": \"kind:document\",\n \"deduplication\": \"md5\",\n \"maxItems\": 5,\n \"maxShingleResponse\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"1277e4ce-a1dd-421a-b4e0-41c40404908a\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/1277e4ce-a1dd-421a-b4e0-41c40404908a\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "99eb4b19-920a-432a-993b-469055f586cf", "name": "Culling", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f917a04f-5c6b-4859-a22b-fcdbab7cae8d", "name": "Tags query items in bulk", "request": { "name": "Tags query items in bulk", "description": { "content": "Use this operation to tag all items returned by a query.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2316537d-c552-4c4f-9847-047a268359a4", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"kind:document\",\n \"tagList\": [\n \"mytag1\",\n \"mytag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"tagList\": [\n \"mytag1\",\n \"mytag2\"\n ],\n \"successfulTags\": [\n \"mytag1\",\n \"mytag2\"\n ],\n \"failedTags\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28175764-aee5-4c62-a594-352cdf17c488", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"kind:document\",\n \"tagList\": [\n \"mytag1\",\n \"mytag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "466ac1bd-7296-4808-a858-9766bdafc050", "name": "Removes tags from query items in bulk", "request": { "name": "Removes tags from query items in bulk", "description": { "content": "Use this operation to remove tags from all the items returned by a query.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "DELETE", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "289fc9bf-0705-44cc-b130-6045ad90609f", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"query\": \"kind:document\",\n \"tagList\": [\n \"mytag1\",\n \"mytag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"tagList\": [\n \"mytag1\",\n \"mytag2\"\n ],\n \"successfulTags\": [\n \"mytag1\",\n \"mytag2\"\n ],\n \"failedTags\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a5e2a0e-5b55-486e-be35-f3c3aaf9f444", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"query\": \"kind:document\",\n \"tagList\": [\n \"mytag1\",\n \"mytag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15e3f8c7-e2fa-47cc-9812-55cbe1100597", "name": "Create or remove tags from query items in bulk.", "request": { "name": "Create or remove tags from query items in bulk.", "description": { "content": "Use this operation to create or remove tags in bulk from all the items returned by a query.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\",\n \"operationType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2a52ab99-18ce-4ed3-a72a-9920370fc482", "name": "OK", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\",\n \"operationType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"tagList\": [\n \"string\",\n \"string\"\n ],\n \"successfulTags\": [\n \"string\",\n \"string\"\n ],\n \"failedTags\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7c27ae8-455b-48b8-9170-4bcfa1d2d767", "name": "Returns the set of tags for a case", "request": { "name": "Returns the set of tags for a case", "description": { "content": "Use this operation to view the set of tags associated with a case. This is useful when you want to find a group of items that you've tagged or when you want to include the tags as metadata when exporting items. The tag names are returned as a set of strings.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "196a9130-799d-4bb3-8471-4cf395f5e3a6", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"For Review\",\n \"myCaseTag1\",\n \"myCaseTag2\",\n \"myTag1\",\n \"myTag2\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e6cbf3c-c572-4265-a0d0-732aa21207f4", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee3f0eb4-94ff-47ed-afbb-4908cac476fd", "name": "Creates new tags for a case", "request": { "name": "Creates new tags for a case", "description": { "content": "Use this operation to create new tags for a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6ee7e4d-bdc2-45f5-abad-4290a1a85666", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"myCaseTag1\",\n \"myCaseTag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"tagList\": [\n \"myCaseTag1\",\n \"myCaseTag2\"\n ],\n \"createdTags\": [\n \"myCaseTag1\",\n \"myCaseTag2\"\n ],\n \"failedTags\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2fa0921-b7ad-4c20-9859-02087007364a", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"myCaseTag1\",\n \"myCaseTag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f6ad4fa-bae1-46ae-824a-0281f08286e1", "name": "Deletes tags for a case", "request": { "name": "Deletes tags for a case", "description": { "content": "Use this operation to delete tags for a case. If tags are still applied to an item, the delete operation will fail.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "DELETE", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "79d59f80-b63d-489b-97bd-e2d3eec11f35", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "[\n \"myTag1\",\n \"myTag2\"\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"tagList\": [\n \"mytag1\"\n ],\n \"deletedTags\": [\n \"mytag1\"\n ],\n \"failedTags\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62c8d86e-775c-4e51-b76d-333892d80226", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "[\n \"myTag1\",\n \"myTag2\"\n]", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5846aae3-026b-4b60-986a-10369bfd90aa", "name": "Create or delete tags for a case in bulk.", "request": { "name": "Create or delete tags for a case in bulk.", "description": { "content": "Use this operation to create, rename, or delete case tags in bulk. If tags are still applied to an item, the delete operation will fail.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagList\": [\n \"\",\n \"\"\n ],\n \"renameMap\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"operationType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "39daaec7-60fb-4600-ae24-9d7c2523c888", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"operationType\": \"ADD\",\n \"tagList\": [\n \"MyFirstCaseTag\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"tagList\": [\n \"MyFirstCaseTag\"\n ],\n \"successfulTags\": [\n \"MyFirstCaseTag\"\n ],\n \"failedTags\": []\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "735dc844-ae2e-481a-881c-422e155b17d4", "name": "Excludes items in bulk", "request": { "name": "Excludes items in bulk", "description": { "content": "Use this operation to flag items as excluded using the exclusion query. Items are tagged with the exclusion reason you provide in the request body as part of the BulkExclusionRequest.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "excludedItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\",\n \"query\": \"\",\n \"deduplication\": \"\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\",\n \"excludeDescendants\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ddbce942-eb4f-4ff6-8b32-792876ef26d4", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "excludedItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\",\n \"query\": \"\",\n \"deduplication\": \"\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\",\n \"excludeDescendants\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4691b3b9-4f6b-4dca-bc92-096ba9e21dd6", "name": "Includes items in bulk", "request": { "name": "Includes items in bulk", "description": { "content": "Use this operation to remove the exclusion flag from all the items returned by a query.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "includedItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"deduplication\": \"\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aea7b8a9-064c-4773-bdb3-1e061c142e13", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "includedItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"deduplication\": \"\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26811bb9-92d7-44a4-a0f6-081123271bc2", "name": "Creates a cluster run based on the query provided", "request": { "name": "Creates a cluster run based on the query provided", "description": { "content": "Use this operation to create a cluster run in a case.\n\nA cluster run is a group of documents that have been associated based on their\nnear-duplicate similarity. Using cluster runs to group similar or related\ndocuments enables your team to perform a more efficient analysis on an item\nset. For example, you can have the same reviewer examine documents that are\nthe most similar or related.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "clusterRuns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"query\": \"\",\n \"resemblanceThreshold\": \"\",\n \"useChainedNearDuplicates\": \"\",\n \"useEmailThreads\": \"\",\n \"saveIfEmpty\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "edaf9b45-336a-4217-9439-79c7fb262664", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "clusterRuns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"MyClusterRun\",\n \"query\": \"\",\n \"resemblanceThreshold\": 0.85,\n \"useChainedNearDuplicates\": true,\n \"useEmailThreads\": false,\n \"saveIfEmpty\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "650b2e3c-8f80-4780-b62f-db25286e6d17", "name": "Lists items in this cluster run", "request": { "name": "Lists items in this cluster run", "description": { "content": "Use this operation to list items in the cluster run. Optional parameters for which cluster, and whether or not the item is a pivot item. Note you may only specify one of the following: clusterNumber, isUnclustered, or isIgnored if any. This is a shortcut operation for querying with the cluster: field.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "clusterRuns", ":clusterRunNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startIndex", "value": "", "description": "Start index, defaults to 0" }, { "disabled": false, "key": "numberOfRecordsRequested", "value": "", "description": "Number of records to return, defaults to 100." }, { "disabled": false, "key": "clusterNumber", "value": "", "description": "Cluster number." }, { "disabled": false, "key": "isPivot", "value": "", "description": "Match pivot items, defaults to all" }, { "disabled": false, "key": "isUnclustered", "value": "", "description": "Matches items that did not cluster, despite being eligible to exist in a cluster." }, { "disabled": false, "key": "isIgnored", "value": "", "description": "Matches items that were ignored because they were ineligible to exist in a cluster." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "clusterRunNameOrGuid", "description": "(Required) Cluster run name or guid" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "49bfd28d-5cda-4c18-9120-97623b3f65b1", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "clusterRuns", ":clusterRunNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startIndex", "value": "" }, { "key": "numberOfRecordsRequested", "value": "100" }, { "key": "clusterNumber", "value": "" }, { "key": "isPivot", "value": "" }, { "key": "isUnclustered", "value": "" }, { "key": "isIgnored", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "clusterRunNameOrGuid", "description": "(Required) Cluster run name or guid" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"request\": {\n \"caseId\": \"219f69f5eee14cf6b8c8c15d7cc2dd1e\",\n \"query\": \"cluster:\\\"cluster-run-1;5\\\"\",\n \"sortField\": null,\n \"sortOrder\": null,\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": 1,\n \"deduplicate\": null,\n \"metadataProfile\": null,\n \"fieldList\": [],\n \"customMetadataList\": [],\n \"propertyList\": [],\n \"itemParameterizedFields\": [],\n \"showAvailableThumbnails\": false,\n \"useCache\": false,\n \"forceCacheDelete\": false,\n \"searchRetry\": 0,\n \"relationType\": null,\n \"entities\": [],\n \"p\": 1,\n \"s\": 0,\n \"customMetadataField\": [],\n \"field\": [],\n \"property\": []\n },\n \"startedOn\": 1588859051337,\n \"completedOn\": 1588859051383,\n \"elapsedTimeForSearch\": 41,\n \"elapsedTimeForSort\": 0,\n \"elapsedTimeForMarshal\": 5,\n \"elapsedTimeForDeduplicate\": 0,\n \"elapsedTotal\": 46,\n \"metadataItems\": [],\n \"localizedMetadataItems\": [],\n \"metadataItemDetails\": [],\n \"resultList\": [\n {\n \"customMetadata\": {},\n \"entities\": {},\n \"guid\": \"1e623d0a-6c6f-45b2-9931-fb4a49ca4c3d\",\n \"properties\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d1bf959-9b0e-4936-8ee2-3ae11427e9b8", "name": "Bad Request. Note you may only specify one of the following: clusterNumber, isUnclustered, or isIgnored.", "originalRequest": { "url": { "path": [ "cases", ":caseId", "clusterRuns", ":clusterRunNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startIndex", "value": "" }, { "key": "numberOfRecordsRequested", "value": "100" }, { "key": "clusterNumber", "value": "" }, { "key": "isPivot", "value": "" }, { "key": "isUnclustered", "value": "" }, { "key": "isIgnored", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "clusterRunNameOrGuid", "description": "(Required) Cluster run name or guid" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"INVALID_REQUEST_FORMAT\",\n \"developerMessage\": \"You may only specify one of the following: clusterNumber, isUnclustered, or isIgnored if any.\",\n \"userMessage\": null,\n \"additionalInfo\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a53f64f-c67c-417b-8de4-05ce51f5c970", "name": "Delete a cluster run", "request": { "name": "Delete a cluster run", "description": { "content": "Use this operation to delete a cluster run.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "clusterRuns", ":clusterRunNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "clusterRunNameOrGuid", "description": "(Required) Cluster run name or guid." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b0c1676f-e75b-4246-bd57-29919d1b6228", "name": "default response.", "originalRequest": { "url": { "path": [ "cases", ":caseId", "clusterRuns", ":clusterRunNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "clusterRunNameOrGuid", "description": "(Required) Cluster run name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "74259131-4170-4213-87c9-6854b9c884f3", "name": "Case or cluster run resource not found.", "originalRequest": { "url": { "path": [ "cases", ":caseId", "clusterRuns", ":clusterRunNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "clusterRunNameOrGuid", "description": "(Required) Cluster run name or guid." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ce8d897-479f-46dc-9eb3-5a2e210e910d", "name": "Generate a count report and optionally tag items.", "request": { "name": "Generate a count report and optionally tag items.", "description": { "content": "Use this operation to create a count report and optionally tag individual items.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "bulkSearchers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) caseId" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagRequests\": [\n {\n \"query\": \"\",\n \"tag\": \"\"\n },\n {\n \"query\": \"\",\n \"tag\": \"\"\n }\n ],\n \"includeFamilies\": false,\n \"deduplicateFamilies\": false,\n \"omitExcludedItems\": true,\n \"omitImmaterialFamilyItems\": true,\n \"tagUniqueItems\": false,\n \"matchingItemsAction\": \"addTags\",\n \"createUnusedTags\": false,\n \"removeEmptyTags\": false,\n \"showTagColumns\": true,\n \"allowDuplicateTags\": true,\n \"allowDuplicateQueries\": true,\n \"countResponsiveItems\": false,\n \"tagResponsiveItemsEnabled\": false,\n \"tagResponsiveItemsTag\": null,\n \"missingTagsAction\": \"fillWithQuery\",\n \"expandTags\": true,\n \"tagExpansion\": {\n \"directMatchPrefix\": \"\",\n \"directMatchSuffix\": \"\",\n \"topLevelMatchPrefix\": \"\",\n \"topLevelMatchSuffix\": \"\",\n \"familyMatchPrefix\": \"\",\n \"familyMatchSuffix\": \"\",\n \"deduplicatedTopLevelMatchPrefix\": \"\",\n \"deduplicatedTopLevelMatchSuffix\": \"\",\n \"deduplicatedFamilyMatchPrefix\": \"\",\n \"deduplicatedFamilyMatchSuffix\": \"\",\n \"uniqueMatchPrefix\": \"\",\n \"uniqueMatchSuffix\": \"\"\n },\n \"scopingQuery\": \"\",\n \"searchFields\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e93ad5e8-15d2-4630-abd9-2b50221ec813", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "bulkSearchers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) caseId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tagRequests\": [\n {\n \"query\": \"\",\n \"tag\": \"\"\n },\n {\n \"query\": \"\",\n \"tag\": \"\"\n }\n ],\n \"includeFamilies\": false,\n \"deduplicateFamilies\": false,\n \"omitExcludedItems\": true,\n \"omitImmaterialFamilyItems\": true,\n \"tagUniqueItems\": false,\n \"matchingItemsAction\": \"addTags\",\n \"createUnusedTags\": false,\n \"removeEmptyTags\": false,\n \"showTagColumns\": true,\n \"allowDuplicateTags\": true,\n \"allowDuplicateQueries\": true,\n \"countResponsiveItems\": false,\n \"tagResponsiveItemsEnabled\": false,\n \"tagResponsiveItemsTag\": null,\n \"missingTagsAction\": \"fillWithQuery\",\n \"expandTags\": true,\n \"tagExpansion\": {\n \"directMatchPrefix\": \"\",\n \"directMatchSuffix\": \"\",\n \"topLevelMatchPrefix\": \"\",\n \"topLevelMatchSuffix\": \"\",\n \"familyMatchPrefix\": \"\",\n \"familyMatchSuffix\": \"\",\n \"deduplicatedTopLevelMatchPrefix\": \"\",\n \"deduplicatedTopLevelMatchSuffix\": \"\",\n \"deduplicatedFamilyMatchPrefix\": \"\",\n \"deduplicatedFamilyMatchSuffix\": \"\",\n \"uniqueMatchPrefix\": \"\",\n \"uniqueMatchSuffix\": \"\"\n },\n \"scopingQuery\": \"\",\n \"searchFields\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c67409e1-6ce8-4be9-8659-f1ad85b630d5", "name": "Bad Request. A list of tag requests are required to use bulk search.", "originalRequest": { "url": { "path": [ "cases", ":caseId", "bulkSearchers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) caseId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tagRequests\": [\n {\n \"query\": \"\",\n \"tag\": \"\"\n },\n {\n \"query\": \"\",\n \"tag\": \"\"\n }\n ],\n \"includeFamilies\": false,\n \"deduplicateFamilies\": false,\n \"omitExcludedItems\": true,\n \"omitImmaterialFamilyItems\": true,\n \"tagUniqueItems\": false,\n \"matchingItemsAction\": \"addTags\",\n \"createUnusedTags\": false,\n \"removeEmptyTags\": false,\n \"showTagColumns\": true,\n \"allowDuplicateTags\": true,\n \"allowDuplicateQueries\": true,\n \"countResponsiveItems\": false,\n \"tagResponsiveItemsEnabled\": false,\n \"tagResponsiveItemsTag\": null,\n \"missingTagsAction\": \"fillWithQuery\",\n \"expandTags\": true,\n \"tagExpansion\": {\n \"directMatchPrefix\": \"\",\n \"directMatchSuffix\": \"\",\n \"topLevelMatchPrefix\": \"\",\n \"topLevelMatchSuffix\": \"\",\n \"familyMatchPrefix\": \"\",\n \"familyMatchSuffix\": \"\",\n \"deduplicatedTopLevelMatchPrefix\": \"\",\n \"deduplicatedTopLevelMatchSuffix\": \"\",\n \"deduplicatedFamilyMatchPrefix\": \"\",\n \"deduplicatedFamilyMatchSuffix\": \"\",\n \"uniqueMatchPrefix\": \"\",\n \"uniqueMatchSuffix\": \"\"\n },\n \"scopingQuery\": \"\",\n \"searchFields\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"INVALID_REQUEST_FORMAT\",\n \"developerMessage\": \"A list of tag requests are required to use bulk search.\",\n \"userMessage\": null,\n \"additionalInfo\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc6754cb-514b-42d1-ba12-9da1610aaefb", "name": "Returns exclusions for a case", "request": { "name": "Returns exclusions for a case", "description": { "content": "Use this operation to view the set of exclusions associated with a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "exclusions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d10c0714-e528-4a68-a863-6be3078b64bb", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "exclusions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "358c79dc-3596-4854-8f17-c7a7ec7296e3", "name": "Returns custom metadata for an item", "request": { "name": "Returns custom metadata for an item", "description": { "content": "Use this operation to retrieve custom metadata from an item in a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "customMetadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fieldNameFilter", "value": "", "description": "Field name filter. Filters metadata fields that are returned. Fields that do not match the regular expression are removed by the filter." }, { "disabled": false, "key": "typeFilter", "value": "", "description": "Type filter. Filters metadata fields that are returned. Fields that do not match the type are removed by the filter." }, { "disabled": false, "key": "modeFilter", "value": "", "description": "Mode filter. Filters metadata fields that are returned. Fields that do not match the mode are removed by the filter." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c9cc5773-a3b5-48cd-9532-a5daa6350b4a", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "customMetadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldNameFilter", "value": "" }, { "key": "typeFilter", "value": "" }, { "key": "modeFilter", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"fieldName\": \"string\",\n \"value\": {},\n \"type\": \"string\",\n \"mode\": \"string\",\n \"template\": \"string\",\n \"fieldTemplate\": {\n \"fieldName\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"string\",\n \"mode\": \"string\",\n \"defaultValue\": {},\n \"isNullAllowed\": false\n }\n },\n {\n \"fieldName\": \"string\",\n \"value\": {},\n \"type\": \"string\",\n \"mode\": \"string\",\n \"template\": \"string\",\n \"fieldTemplate\": {\n \"fieldName\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"string\",\n \"mode\": \"string\",\n \"defaultValue\": {},\n \"isNullAllowed\": false\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4343cc3c-c527-44da-9ca8-f8c78c4a44a3", "name": "Applies custom metadata to an item", "request": { "name": "Applies custom metadata to an item", "description": { "content": "Use this operation to apply custom metadata to an item.

Most custom metadata is put with a mode of \"user\", indicating that it is user-level. Mode \"api\" should only be used where you are setting system-level specific metadata, which is not visible in the GUI by default. If using \"api\" mode we strongly recommend you include a unique prefix to your fieldname to avoid possible collisions with user-level custom metadata, e.g. \"com.your-company.rule-set.fieldName\".

This subclass additionally supports binary custom metadata fields. To store binary custom metadata:

    type must be \"binary\".
    mode must be \"api\" (only API mode is currently supported).
    params must contain a key \"mimeType\" with value being the MIME type of the binary data being stored.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "customMetadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "applyToFamily", "value": "false", "description": "Apply metadata to family items" }, { "disabled": false, "key": "applyToDuplicates", "value": "false", "description": "Apply metadata to duplicates" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"fieldName\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"mode\": \"\",\n \"params\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a1820b3b-5091-4cee-8b84-5daf48d129b9", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "customMetadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "applyToFamily", "value": "false" }, { "key": "applyToDuplicates", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fieldName\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"mode\": \"\",\n \"params\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a80f1cfe-d10c-41ff-a125-5a3b7b721041", "name": "Removes custom metadata on an item", "request": { "name": "Removes custom metadata on an item", "description": { "content": "Use this operation to remove custom metadata from an item.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "customMetadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "applyToFamily", "value": "false", "description": "Remove metadata from family items" }, { "disabled": false, "key": "applyToDuplicates", "value": "false", "description": "Remove metadata from duplicates" }, { "disabled": false, "key": "fieldName", "value": "", "description": "(Required) Field name" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "ced40f9e-5d85-436c-977e-fb950ae215b9", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "customMetadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "applyToFamily", "value": "false" }, { "key": "applyToDuplicates", "value": "false" }, { "key": "fieldName", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f251f466-41db-4e3c-87cd-3354976a72ae", "name": "Applies custom metadata to items in bulk", "request": { "name": "Applies custom metadata to items in bulk", "description": { "content": "Use this operation to apply custom metadata to items in.

Most custom metadata is put with a mode of \"user\", indicating that it is user-level. Mode \"api\" should only be used where you are setting system-level specific metadata, which is not visible in the GUI by default. If using \"api\" mode we strongly recommend you include a unique prefix to your fieldname to avoid possible collisions with user-level custom metadata, e.g. \"com.your-company.rule-set.fieldName\".

This subclass additionally supports binary custom metadata fields. To store binary custom metadata:

    type must be \"binary\".
    mode must be \"api\" (only API mode is currently supported).
    params must contain a key \"mimeType\" with value being the MIME type of the binary data being stored.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemCustomMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"fieldName\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"mode\": \"\",\n \"params\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8f218974-aa48-4e4c-bdd2-11b26db12cb2", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemCustomMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fieldName\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"mode\": \"\",\n \"params\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"failedItems\": [\n \"string\",\n \"string\"\n ],\n \"successfulItems\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57411576-3876-4fbc-8c66-dd3704be834e", "name": "Removes custom metadata on items in bulk", "request": { "name": "Removes custom metadata on items in bulk", "description": { "content": "Use this operation to remove custom metadata from items in bulk.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemCustomMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null, "body": { "mode": "raw", "raw": "{\n \"fieldName\": \"\",\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "26137b93-b426-468d-8066-83d809074088", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemCustomMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"fieldName\": \"\",\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b5264f1-0087-4cdc-b66b-27d2c5ed3a64", "name": "Adds or removes custom metadata on items in bulk.", "request": { "name": "Adds or removes custom metadata on items in bulk.", "description": { "content": "Use this operation to add or remove custom metadata from items in bulk.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemCustomMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"addBulkCustomMetadata\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"mode\": \"\",\n \"params\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"query\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"mode\": \"\",\n \"params\": {\n \"key_0\": \"\"\n },\n \"query\": \"\"\n }\n ],\n \"deleteBulkCustomMetadata\": [\n {\n \"fieldName\": \"\",\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0fb9ae92-2baa-435b-bdf5-ae04db59ec17", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemCustomMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addBulkCustomMetadata\": [\n {\n \"query\": \"guid:dd62afab-83d9-4b18-b94b-264755085216\",\n \"mode\": \"user\",\n \"fieldName\": \"MyCustomMetadata\",\n \"value\": \"MyValue\",\n \"type\": \"text\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"query\": \"guid:dd62afab-83d9-4b18-b94b-264755085216\",\n \"operation\": \"ADD\",\n \"fieldName\": \"MyCustomMetadata\",\n \"results\": {\n \"successfulItems\": [\n \"dd62afab-83d9-4b18-b94b-264755085216\"\n ],\n \"failedItems\": []\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ce2daee-2be3-481b-9c71-1bf2f611a70a", "name": "Rename a case tag.", "request": { "name": "Rename a case tag.", "description": { "content": "Use this operation to rename an existing case tag.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "tags", ":tagName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "tagName", "description": "(Required) The current tag name" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "132e92fe-2087-4262-a0d8-5f41b2c2435f", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "tags", ":tagName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "tagName", "description": "(Required) The current tag name" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"tag\": \"newTagName\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25e624a6-8ee2-41a6-a9cd-8451fa3c3882", "name": "Returns the list of tags for an item", "request": { "name": "Returns the list of tags for an item", "description": { "content": "Use this operation to get the list of tags that have been assigned to the given item", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "28672597-0998-454d-9df8-72eaed33bbde", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"tagList\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a07e19ec-27dc-4d0a-9be6-c1fe7c913839", "name": "Tags an item in a case", "request": { "name": "Tags an item in a case", "description": { "content": "Use this operation to tag an item in a case. Tags are a type of user-defined data that you can use to classify an item or group of items. If the tag doesn't already exist, this operation creates it.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "tags", ":tagName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "applyToFamily", "value": "false", "description": "Tag family items" }, { "disabled": false, "key": "applyToDuplicates", "value": "false", "description": "Tag duplicates" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" }, { "disabled": false, "type": "any", "value": "", "key": "tagName", "description": "(Required) Tag name" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null }, "response": [ { "id": "ee586ab3-4bb2-4954-9caf-8a58e5aee445", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "tags", ":tagName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "applyToFamily", "value": "false" }, { "key": "applyToDuplicates", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" }, { "disabled": false, "type": "any", "value": "", "key": "tagName", "description": "(Required) Tag name" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da59b519-fb78-468f-affc-c96f7d73e017", "name": "Removes a tag from an item", "request": { "name": "Removes a tag from an item", "description": { "content": "Use this operation to remove a tag from an item in a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "tags", ":tagName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "applyToFamily", "value": "false", "description": "Removes tags from family items. Defaults to false." }, { "disabled": false, "key": "applyToDuplicates", "value": "false", "description": "Removes tags from the item's duplicates. Defaults to false." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" }, { "disabled": false, "type": "any", "value": "", "key": "tagName", "description": "(Required) Tag name" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f218ec7a-0a05-429d-9235-50d856913dce", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "tags", ":tagName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "applyToFamily", "value": "false" }, { "key": "applyToDuplicates", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" }, { "disabled": false, "type": "any", "value": "", "key": "tagName", "description": "(Required) Tag name" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd7a16f0-db6c-4e3d-a3ec-2bd47735cd0f", "name": "Returns details for an item set", "request": { "name": "Returns details for an item set", "description": { "content": "Use this operation to view details for an item set in a case.

This endpoint returns an AsyncFunctionResponse.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "30320a90-86a8-4aa9-8aca-7930ddb52de7", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"guid\": \"0d2e7cc9-8e6d-4f44-9054-3c0d8642acbc\",\n \"name\": \"MyItemSet\",\n \"description\": \"The item set description.\",\n \"batches\": [\n {\n \"batchName\": \"22/06/28 14:30:25 EDT\",\n \"createdOn\": 1656441025778\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "271a10be-6a94-490a-8bd2-99e878041fa7", "name": "Renames an item set", "request": { "name": "Renames an item set", "description": { "content": "Use this operation to rename an item set associated with a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"newName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f9dd847f-dccf-4909-a843-400a13b84ae9", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"newName\": \"MyNewItemSetName\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "691d6e28-44f8-4e9c-ae27-224f573a2ad3", "name": "Deletes an item set from a case", "request": { "name": "Deletes an item set from a case", "description": { "content": "Use this operation to delete a specific item set associated with a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7b858466-ba78-42d2-9e80-76046b79bbf8", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"12451c5f-eaf9-4089-9a90-3df32944e5fc\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/12451c5f-eaf9-4089-9a90-3df32944e5fc\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abe46a69-b068-4a38-8e58-a48c6391b505", "name": "Returns item sets associated with a case", "request": { "name": "Returns item sets associated with a case", "description": { "content": "Use this operation to view the names and descriptions for each item set in a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "905aa0d5-47f1-49f3-879b-1fe9496e6546", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"guid\": \"d2e331a8-9228-45b4-ae73-6313574fab8e\",\n \"name\": \"MyItemSet\",\n \"description\": \"A description of the item set\",\n \"batches\": [\n {\n \"batchName\": \"22/06/28 10:41:01 EDT\",\n \"createdOn\": 1656427261910\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c293e232-83f2-4140-9783-25cf4131f620", "name": "Creates an item set within a case", "request": { "name": "Creates an item set within a case", "description": { "content": "Use this operation to create an item set in a case. Creating an item set enables you to deduplicate content by removing duplicate copies.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"query\": \"\",\n \"batchName\": \"\",\n \"deduplication\": \"none\",\n \"description\": \"\",\n \"deduplicateBy\": \"individual\",\n \"custodianRanking\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "793eba23-b433-45b3-b255-db8bdfb3cd78", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"MyItemSet\",\n \"description\": \"My item set description\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"functionKey\": \"1aea3a2c-889c-4670-8779-7334089025cb\",\n \"location\": \"http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/1aea3a2c-889c-4670-8779-7334089025cb\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eabeb77e-7cda-4368-acf2-aecf3fe631a8", "name": "Returns the duplicate items in this set", "request": { "name": "Returns the duplicate items in this set", "description": { "content": "Gets the items that are deemed duplicates in the context of this set after deduplication. Returns a list of GUIDs of each duplicate item.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "duplicates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "batch", "value": "", "description": "Item set batch name, defaults to all batches" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a316fcf6-d2ce-4f44-bde0-6f2d21d96df0", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "duplicates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "batch", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"duplicates\": [\n \"d3d63fe9-14f1-4cd8-a66a-64f9f6479c27\",\n \"95aaf52a-1051-43f5-801a-9dc49414fe99\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed66883c-d3a9-4776-a202-1fe94303326d", "name": "Returns duplicates for an item in an item set", "request": { "name": "Returns duplicates for an item in an item set", "description": { "content": "Finds items classified as duplicates of an item within an item set. If the item is original, all of its duplicates within the item set will be returned. If the item is classified as a duplicate within the item set the original and all other duplicates within the item set will be returned. If the item set was deduplicated by family, duplicates will be restricted to items within duplicate families. Sets of type SCRIPTED are not supported by this method. Returns a list of GUIDs of each duplicate item.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", ":itemGuid", "duplicates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item guid to find duplicates of" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f9708673-38eb-4396-ae97-40ee721e49b0", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", ":itemGuid", "duplicates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item guid to find duplicates of" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"duplicates\": [\n \"0e4be68b-96a3-43e0-96fc-f6098b04c6b4\",\n \"f43a0419-2d88-4914-87ff-7d6aec511868\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "302193b1-6537-48e7-9ae3-aa0ae2031ec1", "name": "Returns the original items in this set", "request": { "name": "Returns the original items in this set", "description": { "content": "Gets the items that are deemed originals in the context of this set after deduplication.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "originals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "batch", "value": "", "description": "Item set batch name, defaults to all batches" }, { "disabled": false, "key": "startIndex", "value": "", "description": "The index of the first record that should be returned. Defaults to 0." }, { "disabled": false, "key": "numberOfRecordsRequested", "value": "", "description": "The number of records that should be returned. Defaults to 100 records." }, { "disabled": false, "key": "metadataProfile", "value": "", "description": "Defines the metadata profile to be appied to the results. Needed to get custom metadata. Defaults to no metadata profile." }, { "disabled": false, "key": "fieldList", "value": "", "description": "List of fields to be returned for each item in the results." }, { "disabled": false, "key": "fieldList", "value": "", "description": "List of fields to be returned for each item in the results." }, { "disabled": false, "key": "customMetadataList", "value": "", "description": "List of custom metadata to be returned for each item in the results. Maintained for backward compatibility." }, { "disabled": false, "key": "customMetadataList", "value": "", "description": "List of custom metadata to be returned for each item in the results. Maintained for backward compatibility." }, { "disabled": false, "key": "propertyList", "value": "", "description": "List of properties to be returned for each item in the results." }, { "disabled": false, "key": "propertyList", "value": "", "description": "List of properties to be returned for each item in the results." }, { "disabled": false, "key": "itemParameterizedFields", "value": "", "description": "Specifies parameterized fields in a key/value pair separated by a colon. * `entities` - corresponds to item.getEntities. (e.g., \"entities:company\") * `serializedItem` - returns a serialized copy of the item. (e.g., \"seralizedItem:topLevelItem\") * `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., \"textTruncated:10000\") * `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., \"thumbnail:200x200\") * `nearDupeThreshold` - (e.g., \"nearDupeThreshold:0.9\") * `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., \"emailThreadCluster:cluster-1\")" }, { "disabled": false, "key": "itemParameterizedFields", "value": "", "description": "Specifies parameterized fields in a key/value pair separated by a colon. * `entities` - corresponds to item.getEntities. (e.g., \"entities:company\") * `serializedItem` - returns a serialized copy of the item. (e.g., \"seralizedItem:topLevelItem\") * `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., \"textTruncated:10000\") * `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., \"thumbnail:200x200\") * `nearDupeThreshold` - (e.g., \"nearDupeThreshold:0.9\") * `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., \"emailThreadCluster:cluster-1\")" }, { "disabled": false, "key": "sortField", "value": "", "description": "Any field in the metadata profile which you want to sort by.\n\nUse the following supported fields in the sortFields:\nposition,kind,duplicates\n" }, { "disabled": false, "key": "sortOrder", "value": "", "description": "Sets the sort order for the results. Possible values are [asc,desc]" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "31016cd2-babd-42fd-82e8-bc56990ae67f", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "originals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "batch", "value": "" }, { "key": "startIndex", "value": "" }, { "key": "numberOfRecordsRequested", "value": "" }, { "key": "metadataProfile", "value": "" }, { "key": "fieldList", "value": "" }, { "key": "fieldList", "value": "" }, { "key": "customMetadataList", "value": "" }, { "key": "customMetadataList", "value": "" }, { "key": "propertyList", "value": "" }, { "key": "propertyList", "value": "" }, { "key": "itemParameterizedFields", "value": "" }, { "key": "itemParameterizedFields", "value": "" }, { "key": "sortField", "value": "" }, { "key": "sortOrder", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"request\": {\n \"caseId\": \"string\",\n \"query\": \"string\",\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": 100,\n \"deduplication\": \"none\",\n \"metadataProfile\": \"string\",\n \"fieldList\": [\n \"string\",\n \"string\"\n ],\n \"customMetadataList\": [\n \"string\",\n \"string\"\n ],\n \"propertyList\": [\n \"string\",\n \"string\"\n ],\n \"itemParameterizedFields\": [\n \"string\",\n \"string\"\n ],\n \"sortField\": \"string\",\n \"sortOrder\": \"asc\",\n \"s\": 366,\n \"p\": 9805\n },\n \"metadataItems\": [\n \"string\",\n \"string\"\n ],\n \"localizedMetadataItems\": [\n \"string\",\n \"string\"\n ],\n \"metadataItemDetails\": [\n {\n \"name\": \"string\",\n \"localisedName\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"localisedName\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"resultList\": [\n {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {},\n \"key_3\": {}\n },\n {\n \"key_0\": {}\n }\n ],\n \"count\": 7077,\n \"deduplicatedCount\": 2349\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b5941d5-6673-4842-a877-3947556e9408", "name": "Returns items in an item set", "request": { "name": "Returns items in an item set", "description": { "content": "Use this operation to view the items associated with an item set in a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "batchName", "value": "", "description": "Batch name (null for all batches)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8c6043b8-ab0e-4f0a-97a8-cca78e9b6176", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "batchName", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"request\": {\n \"caseId\": \"09f166a30f5e430db01d2f7b67f5ec27\",\n \"query\": \"item-set:0d2e7cc9-8e6d-4f44-9054-3c0d8642acbc\",\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": 2,\n \"deduplicate\": null,\n \"metadataProfile\": \"Default\",\n \"fieldList\": [],\n \"customMetadataList\": null,\n \"propertyList\": null,\n \"itemParameterizedFields\": null,\n \"sortField\": null,\n \"sortOrder\": null,\n \"s\": 0,\n \"p\": 2\n },\n \"metadataItems\": [\n \"Name\",\n \"File Type\",\n \"Path Name\"\n ],\n \"localizedMetadataItems\": [\n \"Name\",\n \"File Type\",\n \"Path Name\"\n ],\n \"metadataItemDetails\": [\n {\n \"name\": \"Name\",\n \"localisedName\": \"Name\",\n \"type\": \"String\"\n },\n {\n \"name\": \"File Type\",\n \"localisedName\": \"File Type\",\n \"type\": \"String\"\n },\n {\n \"name\": \"Path Name\",\n \"localisedName\": \"Path Name\",\n \"type\": \"String\"\n }\n ],\n \"resultList\": [\n {\n \"File Type\": \"Zip-Compressed File\",\n \"Name\": \"first-zip.zip\",\n \"Path Name\": \"/4c8c2d2c-2fa3-476f-ac61-77631c370219/api\",\n \"guid\": \"dc8cceb2-45df-4914-859e-8453e11a01ba\"\n },\n {\n \"File Type\": \"Directory\",\n \"Name\": \"jquery\",\n \"Path Name\": \"/4c8c2d2c-2fa3-476f-ac61-77631c370219/api\",\n \"guid\": \"269f78c6-bcc2-4805-ad32-28b826b8df22\"\n }\n ],\n \"count\": 204566,\n \"deduplicatedCount\": 204566\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae0a028b-296e-49d0-8f84-ad4d1f7a998b", "name": "Adds items to an item set", "request": { "name": "Adds items to an item set", "description": { "content": "Use this operation to add items to an existing item set in a case.\nEach addition of items to the set is classified as a batch which facilitates\nrolling deduplication, whereby more items are added to a set and deduplicated\nagainst the existing set members.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"batchName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ae8bc2de-1e26-45f5-b701-ba46897b4c3b", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"batchName\": \"MyBatchName\",\n \"query\": \"file-extension:html\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\",\n \"location\": \"http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3014749b-d98d-438c-bbec-90fb28c11aa4", "name": "Removes items from an item set", "request": { "name": "Removes items from an item set", "description": { "content": "Use this operation to remove items from an existing item set in a case. When removing items from an item set with family-level deduplication, operations on top-level originals are applied to their families (removal or re-assignment) but operations on individual descendants and duplicates are applied to those items only.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"removeDuplicates\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8a71acdf-f557-4aa8-93c6-6f1faa1504b1", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"removeDuplicates\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bfe7091-f539-468b-a99b-30efdd1432c2", "name": "Add or delete items to an item set in bulk.", "request": { "name": "Add or delete items to an item set in bulk.", "description": { "content": "Use this operation to add items to or delete items from an existing item set in a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"addItems\": [\n {\n \"query\": \"\",\n \"batchName\": \"\"\n },\n {\n \"query\": \"\",\n \"batchName\": \"\"\n }\n ],\n \"removeItems\": [\n {\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"removeDuplicates\": true\n },\n {\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"removeDuplicates\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "737d34a6-18c4-4a2e-b9b5-391745ceb2b1", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addItems\": [\n {\n \"batchName\": \"myBatch\",\n \"query\": \"*\"\n }\n ],\n \"removeItems\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"results\": [\n {\n \"query\": \"*\",\n \"itemSetName\": \"MyItemSet\",\n \"operationType\": \"ADD\",\n \"failedItemGuidList\": [],\n \"successfulItemGuidList\": [\n \"d7f6abcd-0555-4a4f-ad52-09a27490061f\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1c00856-1e2a-496d-ad27-0e56a5f1fd36", "name": "Returns the batches in this item set", "request": { "name": "Returns the batches in this item set", "description": { "content": "Use this operation to view batches associated with this item set. Batches are a subset of items within an item set that were added to the set at the same time. Item sets are grouped in a batch by date.

Batch load details objects store the settings and items from a processing session. These include the operating system, architecture, case evidence settings, data processing settings, parallel processing settings, batch load items, and the date and time the batch was loaded.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "82962950-7f00-4a7e-8074-6b5f31f9eb52", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemSets", ":itemSetNameOrGuid", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemSetNameOrGuid", "description": "(Required) The item set name or GUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"batchName\": \"MyBatchName\",\n \"createdOn\": 1656442334287\n },\n {\n \"batchName\": \"22/06/28 14:30:25 EDT\",\n \"createdOn\": 1656441025778\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3a69b451-a9fe-4f87-901a-5700a505fa9f", "name": "Export", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b9782d4a-df43-4f2d-b98e-0cb1d1bd38bb", "name": "Generates thumbnails for a case.", "request": { "name": "Generates thumbnails for a case.", "description": { "content": "Use this operation to generate thumbnails for a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "thumbnails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) case identifier token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"dimensions\": [\n {\n \"height\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0fbd337b-df8a-4a35-9a6c-091115cd7776", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "thumbnails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) case identifier token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"dimensions\": [\n {\n \"height\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"width\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e2c3fbb-b078-407d-b34c-28cef69d3cf3", "name": "Deletes the case's thumbnails folder, containing all generated media.", "request": { "name": "Deletes the case's thumbnails folder, containing all generated media.", "description": { "content": "Use this operation to delete the case's thumbnails folder containing all generated media.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "thumbnails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ba2fd2fd-02a4-43f8-99dd-f35b28c9d737", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "thumbnails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb29bcd5-bb15-4b1d-ae95-b51b3868ad81", "name": "Promotes a list of items to Nuix Discover®", "request": { "name": "Promotes a list of items to Nuix Discover®", "description": { "content": "Use this operation to promote a list of items to Nuix Discover®", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "promoteToDiscover", ":discoverCaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "discoverCaseId", "description": "(Required) Nuix Discover Case ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"apiAccessToken\": \"\",\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"discoverDeduplication\": \"\",\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "16add01d-6afd-43ac-ab72-61d84d05766e", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "promoteToDiscover", ":discoverCaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "discoverCaseId", "description": "(Required) Nuix Discover Case ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"*\",\n \"deduplicated\": false,\n \"discoverDeduplication\": false,\n \"apiAccessToken\": \"YOUR_NUIX_DISCOVER_API_ACCESS_TOKEN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"e0319b96-5c84-40f4-adce-2f3d6aa0465a\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/e0319b96-5c84-40f4-adce-2f3d6aa0465a\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "559ccc4e-b874-4cf9-876a-5576d221d6d7", "name": "Exports production sets and items from a case", "request": { "name": "Exports production sets and items from a case", "description": { "content": "Use this operation to export production sets and items from a\ncase. You can perform two types of exports: legal or item. Legal exports create\na load file during export.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"path\": \"\",\n \"id\": \"\",\n \"productionSets\": [\n \"\",\n \"\"\n ],\n \"productTypes\": [\n \"native\"\n ],\n \"loadFileTypes\": [\n \"\",\n \"\"\n ],\n \"queries\": [\n \"\",\n \"\"\n ],\n \"exportType\": \"item\",\n \"exportOptions\": {\n \"productOptions\": {\n \"key_0\": \"\"\n },\n \"loadFileOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"imagingOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"numberingOptions\": {\n \"key_0\": \"\"\n },\n \"stampingOptions\": {\n \"key_0\": \"\"\n },\n \"traversalOptions\": {\n \"key_0\": \"\"\n },\n \"skipNativesSlipsheetedItems\": \"\",\n \"nearDuplicateOptions\": {\n \"key_0\": \"\"\n },\n \"promoteToDiscoverOptions\": {\n \"key_0\": \"\"\n }\n },\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "78efcbdf-d388-451f-b503-9f37628a41d9", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"path\": \"\",\n \"id\": \"\",\n \"productionSets\": [\n \"\",\n \"\"\n ],\n \"productTypes\": [\n \"native\"\n ],\n \"loadFileTypes\": [\n \"\",\n \"\"\n ],\n \"queries\": [\n \"\",\n \"\"\n ],\n \"exportType\": \"item\",\n \"exportOptions\": {\n \"productOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"loadFileOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"imagingOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"numberingOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"stampingOptions\": {\n \"key_0\": \"\"\n },\n \"traversalOptions\": {\n \"key_0\": \"\"\n },\n \"skipNativesSlipsheetedItems\": \"\",\n \"nearDuplicateOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"promoteToDiscoverOptions\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b06fe4b-3fbd-4b37-94fa-a4899fc858e6", "name": "Generates Slipsheets for items in a case", "request": { "name": "Generates Slipsheets for items in a case", "description": { "content": "Use this operation to generate slipsheets for items in a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "slipsheets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"metadataProfile\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "024dc4b9-593c-46ea-93b9-1f40b582ab06", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "slipsheets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"metadataProfile\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47fd48bb-3fd1-4cbe-8ef2-1ba28816a7bf", "name": "Populate stores", "request": { "name": "Populate stores", "description": { "content": "Use this operation to populate stores for items in a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"itemGuids\": [\n \"\",\n \"\"\n ],\n \"imagingProfileName\": \"\",\n \"overwriteExisting\": \"\",\n \"populateBinaryStores\": \"\",\n \"populatePrintedImageStores\": \"\",\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d716b6f5-f0a1-4597-a407-8d50b55a3919", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"itemGuids\": [\n \"706e8a5e-3457-437a-b0c7-49d3dfa8736f\",\n \"806e8a5e-3457-437a-b0c7-49d3dfa8736g\",\n \"906e8a5e-3457-437a-b0c7-49d3dfa8736h\"\n ],\n \"imagingProfileName\": \"Default\",\n \"overwriteExisting\": true,\n \"populateBinaryStores\": true,\n \"populatePrintedImageStores\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"Response with Zero failures\": {\n \"itemGuids\": [\n \"706e8a5e-3457-437a-b0c7-49d3dfa8736f\",\n \"9581abc8-4f92-4b1f-bc65-7ff6445c449b\"\n ],\n \"failedItemGuids\": []\n },\n \"Response with some failures\": {\n \"itemGuids\": [\n \"706e8a5e-3457-437a-b0c7-49d3dfa8736f\",\n \"9581abc8-4f92-4b1f-bc65-7ff6445c449b\"\n ],\n \"failedItemGuids\": [\n \"706e8a5e-3457-437a-b0c7-49d3dfa8736f\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9dc83e3-96a8-4ba5-9a2b-a90c90229764", "name": "Invalid Property", "originalRequest": { "url": { "path": [ "cases", ":caseId", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"itemGuids\": [\n \"706e8a5e-3457-437a-b0c7-49d3dfa8736f\",\n \"806e8a5e-3457-437a-b0c7-49d3dfa8736g\",\n \"906e8a5e-3457-437a-b0c7-49d3dfa8736h\"\n ],\n \"imagingProfileName\": \"Default\",\n \"overwriteExisting\": true,\n \"populateBinaryStores\": true,\n \"populatePrintedImageStores\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"INVALID_REQUEST_FORMAT\",\n \"developerMessage\": \"Both 'populatePrintedImageStores' and `populateBinaryStores` can not be false.\",\n \"userMessage\": null,\n \"additionalInfo\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1985056-5bbd-4e63-bacc-f59dd7cc850c", "name": "Downloads an item from a case", "request": { "name": "Downloads an item from a case", "description": { "content": "Use this operation to download a specific item from a case. This API uses the original file name to determine the best format to download the item. The item is downloaded by streaming its binary content using its original file name and MIME type. This content is returned in the response body.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "overwriteExisting", "value": "false", "description": "Overwrite Existing; this value is treated as always true for PDFs" }, { "disabled": false, "key": "populateBinaryStores", "value": "false", "description": "If true, the binary store will be regenerated for this item." }, { "disabled": false, "key": "populatePrintedImageStores", "value": "false", "description": "If true, the printed image store will be regenerated for this item." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": null }, "response": [ { "id": "7fb0efd0-6c3f-497b-86b0-a93da79b7610", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "overwriteExisting", "value": "false" }, { "key": "populateBinaryStores", "value": "false" }, { "key": "populatePrintedImageStores", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7bd0779-f500-48d4-9114-24f72ab133de", "name": "Downloads an item from a case", "request": { "name": "Downloads an item from a case", "description": { "content": "Use this operation to download a specific item from a case. This API uses the original file name to determine the best format to download the item. The item is downloaded by streaming its binary content using its original file name and MIME type. This content is returned in the response body.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "overwriteExisting", "value": "false", "description": "Overwrite Existing; this value is treated as always true for PDFs" }, { "disabled": false, "key": "populateBinaryStores", "value": "false", "description": "If true, the binary store will be regenerated for this item." }, { "disabled": false, "key": "populatePrintedImageStores", "value": "false", "description": "If true, the printed image store will be regenerated for this item." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "HEAD", "auth": null }, "response": [ { "id": "362afa66-db29-4fd3-b3ff-8a94ce17dedc", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "overwriteExisting", "value": "false" }, { "key": "populateBinaryStores", "value": "false" }, { "key": "populatePrintedImageStores", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "HEAD", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0040c80c-640e-4814-96cb-310a34a0fe69", "name": "Streams an item binary from a case if it is available", "request": { "name": "Streams an item binary from a case if it is available", "description": { "content": "Use this operation to stream a specific item binary from a case if the item binary is available.This API uses the original file name to determine the best format to download the item.The item is downloaded by streaming its binary content using its original file name and MIME type.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemBinaries", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": null }, "response": [ { "id": "89d2c646-a9ff-4245-b60d-dddf88a2ee7e", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemBinaries", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b600d43-dbcd-4d7c-b0c2-3cdfabcbb2ef", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemBinaries", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"ENGINE_EXCEPTION\",\n \"developerMessage\": \"Error getting byte region\",\n \"userMessage\": \"Could not export item as binary\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"java.io.IOException\",\n \"rootExceptionMessage\": \"Source data missing for item: 3d4ad678-4127-423a-aea1-956de9ed2d21/item.pdf/ (image/jpeg) {cd6f8bd9-3b7e-450e-afd3-2f1be82a3bdf}\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "905b360c-f474-400e-bf64-94c6fdc69353", "name": "Streams an item binary from a case if it is available", "request": { "name": "Streams an item binary from a case if it is available", "description": { "content": "Use this operation to stream a specific item binary from a case if the item binary is available.This API uses the original file name to determine the best format to download the item.The item is downloaded by streaming its binary content using its original file name and MIME type.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemBinaries", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "method": "HEAD", "auth": null }, "response": [ { "id": "1fd30d70-72e3-42d1-95d0-c559b090b2cb", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemBinaries", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "HEAD", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24622b64-fd7e-4d9b-be6d-2b35e1e986bf", "name": "error response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemBinaries", ":itemGuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "HEAD", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6bcb6dd-8e08-4138-9765-a0505d468e36", "name": "Enables you to view a case item", "request": { "name": "Enables you to view a case item", "description": { "content": "Use this operation to view a case item. The REST API uses the original file name to determine the best format to view the item. This endpoint returns the binary data with the MIME type set in the Content-Type header so you are viewing the actual item.

For example, you can use this endpoint to view a case item in a web browser. The API will determine the best format to view this item in the browser.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "view" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "overwriteExisting", "value": "false", "description": "Overwrite Existing" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "multipart/form-data" } ], "method": "GET", "auth": null }, "response": [ { "id": "400f4497-4030-46c2-8741-d6bf92cd0502", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "view" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "overwriteExisting", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "multipart/form-data" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fb0bb06-ec55-451c-a56b-75c7b9d98a70", "name": "Enables you to view a case item", "request": { "name": "Enables you to view a case item", "description": { "content": "Use this operation to view a case item. The REST API uses the original file name to determine the best format to view the item. This endpoint returns the binary data with the MIME type set in the Content-Type header so you are viewing the actual item.

For example, you can use this endpoint to view a case item in a web browser. The API will determine the best format to view this item in the browser.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "view" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "overwriteExisting", "value": "false", "description": "Overwrite Existing" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "HEAD", "auth": null }, "response": [ { "id": "ad84135b-0cd1-4d5f-833e-47a8667e4216", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", ":itemGuid", "view" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "overwriteExisting", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "HEAD", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e96859e4-1de5-4c7a-a959-f1b67b9a538a", "name": "Returns all production sets for a case", "request": { "name": "Returns all production sets for a case", "description": { "content": "Use this operation to view all the production sets for a case. You can use this to see a list of which production sets are available for export.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "productionSets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "summary", "value": "false", "description": "If set to true, will only retrieve name and GUID." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bb0caee4-e014-4338-8ef6-b490abff78f0", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "summary", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"MyProductionSet\",\n \"description\": \"This is a production set\",\n \"guid\": \"1ecbbbc9-e093-497b-a92f-e9c58f00fb2f\",\n \"frozen\": false,\n \"nextDocumentNumber\": null,\n \"prefix\": null,\n \"nextDocumentId\": null,\n \"firstDocumentNumber\": null,\n \"itemCount\": 0\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ffbbb0d-ce03-411a-8625-520a00c632ee", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "summary", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9589784b-23a9-4115-b1a8-c85b0beca216", "name": "Creates a production set", "request": { "name": "Creates a production set", "description": { "content": "Use this operation to create a production set in a case. Production sets allow you to manage a set of grouped items for export.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "productionSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"productionProfileName\": \"\",\n \"imagingProfileName\": \"\",\n \"query\": \"\",\n \"deduplication\": \"none\",\n \"relationType\": \"\",\n \"includeFamily\": false,\n \"familyQuery\": \"\",\n \"includeDuplicates\": false,\n \"duplicatesQuery\": \"\",\n \"includeNearDuplicates\": false,\n \"nearDuplicatesQuery\": \"\",\n \"nearDuplicatesThreshold\": 0.5,\n \"threadsQuery\": \"\",\n \"skipNativesSlipsheetedItems\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4d1ac454-d132-45d1-9539-627f31d82b3c", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"MyProductionSet\",\n \"description\": \"This is a production set\",\n \"query\": \"kind:document\",\n \"productionProfileName\": \"Default\",\n \"imagingProfileName\": \"Default\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b69b4053-8bc2-4acb-a384-57e0ff1b94b0", "name": "Creates a production set", "request": { "name": "Creates a production set", "description": { "content": "Use this operation to create a production set in a case. Production sets allow you to manage a set of grouped items for export.", "type": "text/plain" }, "url": { "path": [ "v1", "cases", ":caseId", "productionSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"startingNumber\": \"\",\n \"query\": \"\",\n \"includeFamilies\": false,\n \"markupSets\": [\n \"\",\n \"\"\n ],\n \"applyRedactions\": true,\n \"applyHighlights\": true,\n \"generatePdfStores\": false,\n \"pdfStoresQuery\": \"\",\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1e95635b-9dd4-4291-9ea2-331eec8f4b39", "name": "default response", "originalRequest": { "url": { "path": [ "v1", "cases", ":caseId", "productionSets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"MyProductionSet\",\n \"description\": \"This is a production set\",\n \"query\": \"kind:document\",\n \"includeFamilies\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c479c48a-d7d3-4295-8c9c-d9bfe59d5a15", "name": "Returns a print preview for an item in the production set", "request": { "name": "Returns a print preview for an item in the production set", "description": { "content": "Use this operation to return a print preview of the item. If a print preview isn't present on the item, it will be generated.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "item", ":itemGuid", "printPreview" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "pageNumber", "value": "", "description": "(Required) The page number to be printed" }, { "disabled": false, "key": "generateNew", "value": "false", "description": "Force regeneration of print preview" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "77dacec3-f3cd-46be-a836-c9c0932360a2", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "item", ":itemGuid", "printPreview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pageNumber", "value": "" }, { "key": "generateNew", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf317bc0-22b7-49ca-acd9-674ca34c0979", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "item", ":itemGuid", "printPreview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pageNumber", "value": "" }, { "key": "generateNew", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" }, { "disabled": false, "type": "any", "value": "", "key": "itemGuid", "description": "(Required) Item GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af583483-c170-4889-832c-0691d7048b23", "name": "Returns the items in this production set", "request": { "name": "Returns the items in this production set", "description": { "content": "This is a shortcut for using the search endpoint with a production-set-guid:[guid] query", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startIndex", "value": "", "description": "Start index, defaults to 0" }, { "disabled": false, "key": "numberOfRecordsRequested", "value": "", "description": "Number of records to return, defaults to 100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "48ebfa2c-9533-4870-b7d2-856d321baa41", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startIndex", "value": "" }, { "key": "numberOfRecordsRequested", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"request\": {\n \"caseId\": \"219f69f5eee14cf6b8c8c15d7cc2dd1e\",\n \"query\": \"production-set-guid:1ecbbbc9-e093-497b-a92f-e9c58f00fb2f\",\n \"sortField\": null,\n \"sortOrder\": null,\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": 1,\n \"deduplicate\": null,\n \"metadataProfile\": null,\n \"fieldList\": [],\n \"customMetadataList\": [],\n \"propertyList\": [],\n \"itemParameterizedFields\": [],\n \"showAvailableThumbnails\": false,\n \"useCache\": false,\n \"forceCacheDelete\": false,\n \"searchRetry\": 0,\n \"relationType\": null,\n \"entities\\\"\": [],\n \"s\": 0,\n \"p\": 1,\n \"customMetadataField\": [],\n \"property\": [],\n \"field\": [],\n \"startedOn\": 1589459144928,\n \"completedOn\": 1589459145042,\n \"elapsedTimeForSearch\": 90,\n \"elapsedTimeForSort\": 0,\n \"elapsedTimeForMarshal\": 24,\n \"elapsedTimeForDeduplicate\": 0,\n \"elapsedTotal\": 114,\n \"metadataItems\": [],\n \"localizedMetadataItems\": [],\n \"metadataItemDetails\": [],\n \"resultList\": [\n {\n \"customMetadata\": {},\n \"entities\": {},\n \"guid\": \"fd772326-87f2-40d2-8d6a-b6009c79cc49\",\n \"properties\": {},\n \"count\": 1,\n \"deduplicatedCount\": 1\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5554e6be-a67e-489c-aea3-9e1083f84d6e", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startIndex", "value": "" }, { "key": "numberOfRecordsRequested", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9a57af6-9f6f-4c30-b6a2-c4ac84b00e1b", "name": "Adds items to a production set", "request": { "name": "Adds items to a production set", "description": { "content": "Use this operation to add items to an existing production set in a case. Production sets allow you to manage a set of grouped items for export.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"startingNumber\": \"\",\n \"query\": \"\",\n \"includeFamilies\": false,\n \"markupSets\": [\n \"\",\n \"\"\n ],\n \"applyRedactions\": true,\n \"applyHighlights\": true,\n \"generatePdfStores\": false,\n \"pdfStoresQuery\": \"\",\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "edf470f6-a9e7-4b5f-a340-6f543414730d", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"kind:document\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c39f7ab5-eb13-483a-8ded-4659e31b9d36", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"kind:document\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a5b6c93-9ece-45cc-ab12-de4ab35513d5", "name": "Generates print previews for items in the production set", "request": { "name": "Generates print previews for items in the production set", "description": { "content": "Use this operation to generate print previews for all items in the production set.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "printPreview" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "allItems", "value": "false", "description": "Generate all print previews, or only generate previews that don't already exist" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null }, "response": [ { "id": "97a4bf03-2565-4729-ac0e-cf1357f4c9cf", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "printPreview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "allItems", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"MyProductionSet\",\n \"description\": \"This is a production set\",\n \"guid\": \"1ecbbbc9-e093-497b-a92f-e9c58f00fb2f\",\n \"frozen\": false,\n \"nextDocumentNumber\": \"nuix000000002\",\n \"prefix\": \"nuix\",\n \"nextDocumentId\": \"2,\",\n \"firstDocumentNumber\": \"nuix000000001\",\n \"itemCount\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c03556a-3414-4a7b-9b04-8748768775ed", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId", "printPreview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "allItems", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5e21bde-0af0-4823-b9f2-5ca130d90adc", "name": "Returns details for a specific production set", "request": { "name": "Returns details for a specific production set", "description": { "content": "Use this operation to view information about a production set. Details include set name, item count, description, and document numbering. You can use this information to determine if this production set is ready for export.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "summary", "value": "false", "description": "If true returns a production set summary. The summary includes guid and name of the production set only." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5fe3fa0c-eec1-4d09-a800-95a2543f11d8", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "summary", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"MyProductionSet\",\n \"description\": \"This is a production set\",\n \"guid\": \"1ecbbbc9-e093-497b-a92f-e9c58f00fb2f\",\n \"frozen\": false,\n \"nextDocumentNumber\": null,\n \"prefix\": null,\n \"nextDocumentId\": null,\n \"firstDocumentNumber\": null,\n \"itemCount\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86721f4e-6d7e-42cc-be6c-93dcef8a0f2e", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "summary", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73868d4c-db64-4ac6-aca4-c09195fc86ce", "name": "Deletes a production set from a case", "request": { "name": "Deletes a production set from a case", "description": { "content": "Use this operation to delete a specific production set from a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "5488f529-d8c7-4c9b-a23e-2a38f6adbcb3", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"MyProductionSet\",\n \"description\": \"This is a production set\",\n \"guid\": \"1ecbbbc9-e093-497b-a92f-e9c58f00fb2f\",\n \"frozen\": false,\n \"nextDocumentNumber\": null,\n \"prefix\": null,\n \"nextDocumentId\": null,\n \"firstDocumentNumber\": null,\n \"itemCount\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c688013e-95f3-42b6-a2e5-6d553afc2285", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60cc68a2-c29a-4c97-b926-c638f3a8defe", "name": "Deletes a production set from a case", "request": { "name": "Deletes a production set from a case", "description": { "content": "Use this operation to delete a specific production set from a case.", "type": "text/plain" }, "url": { "path": [ "v2", "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "eec9ccd5-db47-47f2-b5a9-b183849308c9", "name": "default response", "originalRequest": { "url": { "path": [ "v2", "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73a8e497-f483-4568-b830-eb81e228adea", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "v2", "cases", ":caseId", "productionSets", ":productionSetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "productionSetId", "description": "(Required) Production set GUID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1c1ead82-ee4f-47d1-ab10-ef3441ba8977", "name": "Inventory", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "beb4aab3-aa36-4eb2-9ac8-ff9428f16b5b", "name": "Returns the top-level information for a case", "request": { "name": "Returns the top-level information for a case", "description": { "content": "Use this operation to view the top-level information associated with a case. Top-level case information returns case property content like the following: case ID, name, path, description, investigator time zone, investigator, and whether the case is simple or compound.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "determineAdditionalAttributes", "value": "false", "description": "Returns extended case attributes. These attributes are hasExclusions, hasProductionSets, hasCalculatedAuditSize, and hasNuixSystemTags." }, { "disabled": false, "key": "calculateCaseSize", "value": "false", "description": "Should size of case on disk be calculated? Defaults to false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "92e5b308-a642-45c1-85aa-c3e67e27698c", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "determineAdditionalAttributes", "value": "false" }, { "key": "calculateCaseSize", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"caseId\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"description\": \"string\",\n \"investigator\": \"string\",\n \"creationDate\": 1937,\n \"compound\": true,\n \"elastic\": true,\n \"binaryStoreLocation\": \"string\",\n \"indexId\": \"string\",\n \"caseSize\": 8180,\n \"casePathParent\": \"string\",\n \"caseInvestigationTimeZone\": \"string\",\n \"hasExclusions\": true,\n \"hasNuixSystemTags\": false,\n \"hasProductionSets\": true,\n \"hasCalculatedAuditSize\": true,\n \"caseName\": \"string\",\n \"casePath\": \"string\",\n \"caseDescription\": \"string\",\n \"caseCreationDate\": 2847,\n \"caseInvestigator\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7db897db-6536-4b96-92c6-85b7193c72b5", "name": "Deletes a case", "request": { "name": "Deletes a case", "description": { "content": "Use this operation to delete a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "deleteAllDescendants", "value": "false", "description": "Delete child cases of a compound case" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "8facdbee-956e-4172-82d3-47de2359fdbd", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "deleteAllDescendants", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"caseId\": \"string\",\n \"success\": true,\n \"errorMessage\": \"string\",\n \"childCases\": [\n {\n \"caseId\": \"string\",\n \"success\": true,\n \"errorMessage\": \"string\",\n \"childCases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"caseId\": \"string\",\n \"success\": false,\n \"errorMessage\": \"string\",\n \"childCases\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc335e99-dff3-4001-9c87-fd6372ac26a7", "name": "Adds a child case to a compound case", "request": { "name": "Adds a child case to a compound case", "description": { "content": "Use this operation to add a single child case to a compound case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "childCases", ":childCaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "childCaseId", "description": "(Required) Case ID for the child case" } ] }, "method": "PUT", "auth": null }, "response": [ { "id": "1eacbe89-6639-4f30-a3c7-a0a78050c097", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "childCases", ":childCaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "childCaseId", "description": "(Required) Case ID for the child case" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15490a94-c6f1-4dbf-911e-660802510218", "name": "Returns a list of child cases for a compound case", "request": { "name": "Returns a list of child cases for a compound case", "description": { "content": "Use this operation to view the child cases, or simple cases, associated with a compound case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "childCases" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "determineAdditionalAttributes", "value": "false", "description": "Returns extended case attributes. These attributes are hasExclusions, hasProductionSets, hasCalculatedAuditSize, and hasNuixSystemTags." }, { "disabled": false, "key": "calculateCaseSize", "value": "false", "description": "Should size of each child case on disk be calculated? Defaults to false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "771e482b-4ac2-4346-a11b-88f01b721f43", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "childCases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "determineAdditionalAttributes", "value": "false" }, { "key": "calculateCaseSize", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"caseId\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"description\": \"string\",\n \"investigator\": \"string\",\n \"creationDate\": 9205,\n \"compound\": false,\n \"elastic\": true,\n \"binaryStoreLocation\": \"string\",\n \"indexId\": \"string\",\n \"caseSize\": 6507,\n \"casePathParent\": \"string\",\n \"caseInvestigationTimeZone\": \"string\",\n \"hasExclusions\": false,\n \"hasNuixSystemTags\": true,\n \"hasProductionSets\": false,\n \"hasCalculatedAuditSize\": true,\n \"caseName\": \"string\",\n \"casePath\": \"string\",\n \"caseDescription\": \"string\",\n \"caseCreationDate\": 9443,\n \"caseInvestigator\": \"string\"\n },\n {\n \"caseId\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"description\": \"string\",\n \"investigator\": \"string\",\n \"creationDate\": 4510,\n \"compound\": true,\n \"elastic\": true,\n \"binaryStoreLocation\": \"string\",\n \"indexId\": \"string\",\n \"caseSize\": 8243,\n \"casePathParent\": \"string\",\n \"caseInvestigationTimeZone\": \"string\",\n \"hasExclusions\": false,\n \"hasNuixSystemTags\": true,\n \"hasProductionSets\": false,\n \"hasCalculatedAuditSize\": false,\n \"caseName\": \"string\",\n \"casePath\": \"string\",\n \"caseDescription\": \"string\",\n \"caseCreationDate\": 4674,\n \"caseInvestigator\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ea4005f-8b59-44f6-a785-88e7ae05c5b4", "name": "Adds child cases to a compound case", "request": { "name": "Adds child cases to a compound case", "description": { "content": "Use this operation to add multiple child cases to a compound case at once.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "childCases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "985d8ee0-e462-4904-a521-69de6a518840", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "childCases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a528598-cc14-4ef4-80f0-ca8278ca8d5e", "name": "Closes a case", "request": { "name": "Closes a case", "description": { "content": "Use this operation to close a case in a user session. Cases should be closed when not in use or they will remain locked.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null }, "response": [ { "id": "930f84f0-427a-471a-85a1-cf636d523719", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b73de016-e551-41ae-9849-2a0636e317a4", "name": "Creates a case", "request": { "name": "Creates a case", "description": { "content": "Use this operation to create a case. You can create a simple or\ncompound case, which is a collection of simple cases. You can declare that\na simple case be processed via ElasticSearch by defining the elasticSearchSettings\nattribute. Compound cases cannot be processed via ElasticSearch.\n\nWhen you create a case, the location of the CaseCreateRequest should be an inventory location (inventory0, \ninventory1, inventoryx) or a path relative to an inventory location. Absolute paths within an inventory location\nwill be created at the desired location but absolute paths outside an inventory location will be appended \nto the first inventory location.\n\nThe following are examples of locations and the absolute paths where those cases will be created given\ntwo inventory locations that have been configured at /cases and /elasticsearchCases.\n\n| Location | Case Name | Absolute Path |\n| ----------- | --------- | ------------------- |\n| inventory0 | MyCase | /cases/MyCase |\n| inventory1 | MyElasticCase | /elasticsearchCases/MyElasticCase |\n| /my/path | Case1 | /cases/my/path/Case1 |\n| my/path | Case2 | /cases/my/path/Case2 |\n| inventory0/my/path | Case3 | /cases/my/path/Case3 |\n| inventory1/my/path | Case4 | /elasticsearchCases/my/path/Case4 |\n| /cases | Case5 | /cases/Case5 |\n| /cases/another/path | Case6 | /cases/another/path/Case6 |\n\nInventory locations let the REST server administrator control where cases are created and provide a layer\nof security between the server and the user.\n", "type": "text/plain" }, "url": { "path": [ "cases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"compound\": false,\n \"location\": \"inventory0\",\n \"description\": \"\",\n \"investigator\": \"\",\n \"elasticSearchSettings\": {\n \"cluster.name\": \"\",\n \"nuix.transport.hosts\": [\n \"\",\n \"\"\n ],\n \"additionalSettings\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"index.number_of_shards\": \"\",\n \"index.number_of_replicas\": \"\",\n \"index.refresh_interval\": \"\",\n \"nuix.index.auto_close\": \"\",\n \"nuix.http.hosts\": [\n \"\",\n \"\"\n ],\n \"xpack.security.user\": \"\",\n \"xpack.security.password\": \"\",\n \"xpack.security.transport.ssl.enabled\": \"\",\n \"xpack.security.transport.ssl.truststore.path\": \"\",\n \"xpack.security.transport.ssl.truststore.type\": \"\",\n \"xpack.security.transport.ssl.keystore.path\": \"\",\n \"xpack.security.transport.ssl.keystore.type\": \"\",\n \"xpack.security.transport.ssl.verification_mode\": \"\",\n \"xpack.security.http.ssl.enabled\": \"\",\n \"xpack.security.http.ssl.key\": \"\",\n \"xpack.security.http.ssl.key_passphrase\": \"\",\n \"xpack.security.http.ssl.keystore.key_password\": \"\",\n \"xpack.security.http.ssl.keystore.path\": \"\",\n \"xpack.security.http.ssl.keystore.type\": \"\",\n \"xpack.security.http.ssl.keystore.password\": \"\",\n \"xpack.security.http.ssl.truststore.path\": \"\",\n \"xpack.security.http.ssl.truststore.type\": \"\",\n \"xpack.security.http.ssl.certificate\": \"\",\n \"xpack.security.http.ssl.certificate_authorities\": \"\",\n \"nuix.auth.username\": \"\",\n \"nuix.auth.password\": \"\",\n \"searchguard.ssl.transport.keystore_filepath\": \"\",\n \"searchguard.ssl.transport.keystore_password\": \"\",\n \"searchguard.ssl.transport.truststore_filepath\": \"\",\n \"searchguard.ssl.transport.truststore_password\": \"\"\n },\n \"binaryStoreLocation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0c21c9b6-0398-42b0-b82f-d0a71a19cf1e", "name": "default response", "originalRequest": { "url": { "path": [ "cases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"SimpleCase\",\n \"location\": \"inventory0\",\n \"description\": \"About My simple Case\",\n \"compound\": false,\n \"investigator\": \"Inspector Gadget\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"functionKey\": \"e0319b96-5c84-40f4-adce-2f3d6aa0465a\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/e0319b96-5c84-40f4-adce-2f3d6aa0465a\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a64bb2a6-3094-4959-b5cc-35a6d25fdcfe", "name": "Creates a case subset", "request": { "name": "Creates a case subset", "description": { "content": "Use this operation to create a case subset. When you create a case, the location must be a relative path, or an absolute path that is within\na configured inventory location. You must include the `elasticSearchSettings` field in the `caseMetadata` in order to case subset to Elasticsearch.\nOtherwise, the default case subset will be a standard Lucene/Derby case.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "subset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"location\": \"inventory0\",\n \"evidenceStoreCount\": 1,\n \"includeFamilies\": false,\n \"copyTags\": false,\n \"copyComments\": false,\n \"copyCustodians\": false,\n \"copyItemSets\": false,\n \"copyClassifiers\": false,\n \"copyMarkupSets\": false,\n \"copyProductionSets\": false,\n \"copyClusters\": false,\n \"copyCustomMetadata\": false,\n \"caseMetadata\": {\n \"name\": \"\",\n \"description\": \"\",\n \"investigator\": \"\",\n \"elasticSearchSettings\": {\n \"cluster.name\": \"\",\n \"nuix.transport.hosts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"additionalSettings\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"index.number_of_shards\": \"\",\n \"index.number_of_replicas\": \"\",\n \"index.refresh_interval\": \"\",\n \"nuix.index.auto_close\": \"\",\n \"nuix.http.hosts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"xpack.security.user\": \"\",\n \"xpack.security.password\": \"\",\n \"xpack.security.transport.ssl.enabled\": \"\",\n \"xpack.security.transport.ssl.truststore.path\": \"\",\n \"xpack.security.transport.ssl.truststore.type\": \"\",\n \"xpack.security.transport.ssl.keystore.path\": \"\",\n \"xpack.security.transport.ssl.keystore.type\": \"\",\n \"xpack.security.transport.ssl.verification_mode\": \"\",\n \"xpack.security.http.ssl.enabled\": \"\",\n \"xpack.security.http.ssl.key\": \"\",\n \"xpack.security.http.ssl.key_passphrase\": \"\",\n \"xpack.security.http.ssl.keystore.key_password\": \"\",\n \"xpack.security.http.ssl.keystore.path\": \"\",\n \"xpack.security.http.ssl.keystore.type\": \"\",\n \"xpack.security.http.ssl.keystore.password\": \"\",\n \"xpack.security.http.ssl.truststore.path\": \"\",\n \"xpack.security.http.ssl.truststore.type\": \"\",\n \"xpack.security.http.ssl.certificate\": \"\",\n \"xpack.security.http.ssl.certificate_authorities\": \"\",\n \"nuix.auth.username\": \"\",\n \"nuix.auth.password\": \"\",\n \"searchguard.ssl.transport.keystore_filepath\": \"\",\n \"searchguard.ssl.transport.keystore_password\": \"\",\n \"searchguard.ssl.transport.truststore_filepath\": \"\",\n \"searchguard.ssl.transport.truststore_password\": \"\"\n },\n \"binaryStoreLocation\": \"\"\n },\n \"processingSettings\": {\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e6f19015-dada-4d2e-b098-f0512f1d5409", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "subset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"*\",\n \"location\": \"inventory0\",\n \"caseMetadata\": {\n \"name\": \"MyCase\",\n \"description\": \"Simple case subset\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e860247-40b8-4358-86b7-4e734bfae487", "name": "Returns metadata fields available for a case", "request": { "name": "Returns metadata fields available for a case", "description": { "content": "Use this operation to view the metadata fields associated with a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "metadataFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a0e500c1-e0c7-4f4f-8cb9-8815f83ebf13", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "metadataFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"type\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b484988e-afe2-4957-9ea1-8bc0d9445951", "name": "Case functions", "request": { "name": "Case functions", "description": { "content": "Use this operation to list functions that are available to be run against this case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "caseFunctions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ba95ae23-59cb-4153-916b-56d2286c3c5b", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "caseFunctions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"MIGRATE\",\n \"MIGRATE\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5cc3f58-73a8-4042-9b2e-40b5238cd9b7", "name": "Perform a function against a case", "request": { "name": "Perform a function against a case", "description": { "content": "Use this operation to perform some function against a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "caseFunctions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"method\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b7858b2a-bb87-4fe8-9b3b-bb605fab73f1", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "caseFunctions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"method\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "058a6972-36bd-446c-9c0c-581671dbf740", "name": "Returns the set of inventory locations", "request": { "name": "Returns the set of inventory locations", "description": { "content": "Use this operation to view the list of normalized inventory locations. Any case placed in any location in this list will be added to the case inventory during the next scheduled inventory scan.", "type": "text/plain" }, "url": { "path": [ "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "73d2da60-331d-4ad1-9842-442b036f8c6a", "name": "default response", "originalRequest": { "url": { "path": [ "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f78c077-0d80-4eaf-851a-8c9238c8b0a0", "name": "Rescans your inventory", "request": { "name": "Rescans your inventory", "description": { "content": "Use this operation to rescan your inventory. The inventory is scanned on startup by default and at a predefined regular interval.", "type": "text/plain" }, "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null }, "response": [ { "id": "df3007a5-0bd5-4462-802b-92b3a4191fff", "name": "default response", "originalRequest": { "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31eb2f37-a9db-4da8-9844-f4270aa83b65", "name": "Returns the digest information for a case", "request": { "name": "Returns the digest information for a case", "description": { "content": "Use this operation to view the case digest for a given case, which is obtained without opening the case.", "type": "text/plain" }, "url": { "path": [ "inventory", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6b526efe-1db8-4205-a610-8f12adabc0e4", "name": "default response", "originalRequest": { "url": { "path": [ "inventory", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"caseId\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"description\": \"string\",\n \"investigator\": \"string\",\n \"creationDate\": 4803,\n \"compound\": false,\n \"elastic\": true,\n \"binaryStoreLocation\": \"string\",\n \"indexId\": \"string\",\n \"productName\": \"string\",\n \"version\": \"string\",\n \"isOpen\": false,\n \"childCases\": [\n \"string\",\n \"string\"\n ],\n \"url\": \"string\",\n \"serverId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76bfc3b0-2594-44a8-9f75-7a1618a177ee", "name": "Returns the set of case digests for all inventory locations", "request": { "name": "Returns the set of case digests for all inventory locations", "description": { "content": "Use this operation to view the set of case digests for all inventory locations.", "type": "text/plain" }, "url": { "path": [ "inventory", "digest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3ea5631c-fe75-4ab5-924d-6bc81b213b08", "name": "default response", "originalRequest": { "url": { "path": [ "inventory", "digest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"caseId\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"description\": \"string\",\n \"investigator\": \"string\",\n \"creationDate\": 2020,\n \"compound\": false,\n \"elastic\": true,\n \"binaryStoreLocation\": \"string\",\n \"indexId\": \"string\",\n \"productName\": \"string\",\n \"version\": \"string\",\n \"isOpen\": true,\n \"childCases\": [\n \"string\",\n \"string\"\n ],\n \"url\": \"string\",\n \"serverId\": \"string\"\n },\n {\n \"caseId\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"description\": \"string\",\n \"investigator\": \"string\",\n \"creationDate\": 5878,\n \"compound\": false,\n \"elastic\": false,\n \"binaryStoreLocation\": \"string\",\n \"indexId\": \"string\",\n \"productName\": \"string\",\n \"version\": \"string\",\n \"isOpen\": true,\n \"childCases\": [\n \"string\",\n \"string\"\n ],\n \"url\": \"string\",\n \"serverId\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd964278-8b6b-4915-8f72-dca8f049681f", "name": "Deletes a case asynchronously", "request": { "name": "Deletes a case asynchronously", "description": { "content": "Use this operation to delete a case asynchronously. This operation returns immediately with an async function key that can be used to monitor the deletion progress.", "type": "text/plain" }, "url": { "path": [ "v2", "cases", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "deleteAllDescendants", "value": "false", "description": "Delete child cases of a compound case" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "02b53920-1189-4eb3-afd5-164a390f6935", "name": "Async function response with key and location for monitoring progress", "originalRequest": { "url": { "path": [ "v2", "cases", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "deleteAllDescendants", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"12451c5f-eaf9-4089-9a90-3df32944e5fc\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/12451c5f-eaf9-4089-9a90-3df32944e5fc\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d4a8e7a-24af-4f2c-b2d5-9ef469eeaa08", "name": "Case does not exist", "originalRequest": { "url": { "path": [ "v2", "cases", ":caseId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "deleteAllDescendants", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"userMessage\": \"The resource of type 'CASE' and identifier 'ef61c666296e4fc8a0a79288ab697348' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "490bf2c3-a00a-4e38-a166-a282570c0c89", "name": "Licensing", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "86e46646-79e4-4b6f-b63f-50054929aa4a", "name": "Returns an audit report file", "request": { "name": "Returns an audit report file", "description": { "content": "Returns an audit report file as an attachment for an audited case. The audit report file is the file that is uploaded to the Nuix portal for audited cases.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "auditReportFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "auth": null }, "response": [ { "id": "388fd6ca-5f48-4e3a-9c99-715ba3bfd23b", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "auditReportFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16a1b47f-b42d-496a-9dde-dca0ba97c487", "name": "Uploads an audit verification file", "request": { "name": "Uploads an audit verification file", "description": { "content": "Use this operation to upload an audit verification file to a case. The audit verification file is the file that is downloaded from the Nuix portal after uploading an audit report.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "auditVerificationFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "uploadFile", "type": "file", "description": "" } ] } }, "response": [ { "id": "45df0ace-feaf-43f1-912d-43c9145f06f4", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "auditVerificationFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "uploadFile", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58d64ece-2f59-4e68-934c-0074481e5029", "name": "Deletes all audit reports and audit verification files for a specified case", "request": { "name": "Deletes all audit reports and audit verification files for a specified case", "description": { "content": "Use this operation to delete all audit reports and audit verification files for the specified case. You may want to do this if an incorrect audit verification file has been uploaded for a case. This will allow the Nuix Engine to generate a new audit file.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "auditFiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "ce3b0413-e75b-4b21-985a-b7a758f36fd5", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "auditFiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ac57d72-a0bd-4147-8cd5-a9c72b42712e", "name": "Returns the audit status for a case", "request": { "name": "Returns the audit status for a case", "description": { "content": "Use this operation to check the audit status for a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "auditStatus" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6660c087-3f89-48c8-b65a-26d6f57ef65e", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "auditStatus" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"unverifiedAuditReport\": true,\n \"verifiedAuditReports\": [\n \"string\",\n \"string\"\n ],\n \"auditReportFilename\": \"string\",\n \"creationDate\": 6526\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44957871-80e8-4f40-bdb5-4086c643dd0f", "name": "Update and persist license server credentials", "request": { "name": "Update and persist license server credentials", "description": { "content": "Updates and attempts to persist the license server credentials. This endpoint will validate the credentials provided, persist, and encrypt the user credentials.", "type": "text/plain" }, "url": { "path": [ "licenseServer", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"workers\": \"\",\n \"licenceShortName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6cd6497e-1255-4c28-9a41-e5b1c073e6ca", "name": "The REST configuration change response object.", "originalRequest": { "url": { "path": [ "licenseServer", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"username\": \"user1\",\n \"password\": \"mysecurepassword\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"message\": \"Success.\",\n \"status\": \"PERSISTENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70441d1f-86ad-4350-b8f2-470c9559047f", "name": "Returns a list of available licences", "request": { "name": "Returns a list of available licences", "description": { "content": "Use this operation to view a list of your available licences. This information comes from the Nuix Management Server (NMS) or Cloud License Server (CLS).", "type": "text/plain" }, "url": { "path": [ "licenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b219543c-bfd4-4847-8c76-1105b1dcf87e", "name": "default response", "originalRequest": { "url": { "path": [ "licenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"shortname\": \"enterprise-workstation\",\n \"count\": 8,\n \"configuredCount\": 10,\n \"description\": \"Nuix eDiscovery Workstation\",\n \"workers\": 6,\n \"configuredWorkers\": 10,\n \"audited\": false,\n \"auditThreshold\": 0,\n \"source\": null,\n \"type\": null,\n \"location\": null,\n \"expiry\": null,\n \"legalHoldHoldCountLimit\": null,\n \"concurrentUserLimit\": null,\n \"canChooseWorkers\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "943784c6-a3aa-47aa-9161-0c5276a24313", "name": "Monitoring", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d0da2f80-57a3-4e4d-8046-2e6e4ed4611e", "name": "Returns asynchronous function statuses", "request": { "name": "Returns asynchronous function statuses", "description": { "content": "Use this operation to view the status of asynchronous functions. All asynchronous functions that have been run and that are currently running are returned.

NOTE: This endpoint has been deprecated and replaced with the /v1/asyncFunctionsQueue and /v2/asyncFunctions endpoints.", "type": "text/plain" }, "url": { "path": [ "v1", "asyncFunctions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "activeWindowInSeconds", "value": "0", "description": "The time in seconds within which non-queue functions must have been active to be returned. Numbers less than 0 will return all windows." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9d623cdb-d758-42f5-adec-9aeab313225b", "name": "default response", "originalRequest": { "url": { "path": [ "v1", "asyncFunctions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "activeWindowInSeconds", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"executeImmediate\": [\n {\n \"done\": true,\n \"cancelled\": false,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 1188.4542951994315,\n \"total\": 1053.573376805912,\n \"percentComplete\": 5138.936264900539,\n \"updatedOn\": 2918,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 3638,\n \"startTime\": 3951,\n \"finishTime\": 216,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {}\n },\n \"participatingInCaseFunctionQueue\": false,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": {\n \"value\": \"\"\n },\n \"developerMessage\": {\n \"value\": \"\"\n },\n \"userMessage\": {\n \"value\": \"\"\n },\n \"additionalInfo\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"done\": false,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 4920.863881195756,\n \"total\": 9091.65215717186,\n \"percentComplete\": 6028.551113214599,\n \"updatedOn\": 7105,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 2752,\n \"startTime\": 4510,\n \"finishTime\": 7524,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": false,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"participatingInCaseFunctionQueue\": false,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": {\n \"value\": \"\"\n },\n \"developerMessage\": {\n \"value\": \"\"\n },\n \"userMessage\": {\n \"value\": \"\"\n },\n \"additionalInfo\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"singleItemQueue\": [\n {\n \"done\": false,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 8157.9120035925,\n \"total\": 7662.395298025621,\n \"percentComplete\": 5995.657608468013,\n \"updatedOn\": 926,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 4751,\n \"startTime\": 8581,\n \"finishTime\": 1111,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": false,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"participatingInCaseFunctionQueue\": false,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": {\n \"value\": \"\"\n },\n \"developerMessage\": {\n \"value\": \"\"\n },\n \"userMessage\": {\n \"value\": \"\"\n },\n \"additionalInfo\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"done\": false,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 4735.691397800846,\n \"total\": 8099.862118912939,\n \"percentComplete\": 2504.8127809102793,\n \"updatedOn\": 2934,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 1324,\n \"startTime\": 4132,\n \"finishTime\": 4535,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": false,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {}\n },\n \"participatingInCaseFunctionQueue\": false,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": {\n \"value\": \"\"\n },\n \"developerMessage\": {\n \"value\": \"\"\n },\n \"userMessage\": {\n \"value\": \"\"\n },\n \"additionalInfo\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"paused\": false,\n \"pausedBy\": \"string\",\n \"pausedUntil\": 7729,\n \"caseQueues\": [\n {\n \"caseId\": \"string\",\n \"queue\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"caseId\": \"string\",\n \"queue\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"totalRunningFunctions\": 2401\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc129312-4740-4180-a202-44794140f953", "name": "Returns asynchronous function statuses", "request": { "name": "Returns asynchronous function statuses", "description": { "content": "Use this operation to view the status of asynchronous functions. All asynchronous functions that have been run and that are currently running are returned.", "type": "text/plain" }, "url": { "path": [ "asyncFunctionsQueue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "activeWindowInSeconds", "value": "0", "description": "The time in seconds within which non-queue functions must have been active to be returned. Numbers less than 0 will return all windows." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "967f8a93-168f-47de-9a50-c5f01b5ebc29", "name": "default response", "originalRequest": { "url": { "path": [ "asyncFunctionsQueue" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "activeWindowInSeconds", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"executeImmediate\": [\n {\n \"done\": true,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 6781.5643854262835,\n \"total\": 2434.153169025902,\n \"percentComplete\": 7484.812958520053,\n \"updatedOn\": 3167,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 8497,\n \"startTime\": 1063,\n \"finishTime\": 575,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"participatingInCaseFunctionQueue\": true,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": {\n \"value\": \"\"\n },\n \"developerMessage\": {\n \"value\": \"\"\n },\n \"userMessage\": {\n \"value\": \"\"\n },\n \"additionalInfo\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"done\": false,\n \"cancelled\": false,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 922.6264916162097,\n \"total\": 6201.936353011677,\n \"percentComplete\": 8052.746532719978,\n \"updatedOn\": 4950,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 5915,\n \"startTime\": 6744,\n \"finishTime\": 4903,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": false,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {}\n },\n \"participatingInCaseFunctionQueue\": false,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": {\n \"value\": \"\"\n },\n \"developerMessage\": {\n \"value\": \"\"\n },\n \"userMessage\": {\n \"value\": \"\"\n },\n \"additionalInfo\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"singleItemQueue\": [\n {\n \"done\": false,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 2879.8656359279607,\n \"total\": 3807.641727008283,\n \"percentComplete\": 5995.959490164467,\n \"updatedOn\": 5962,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 3102,\n \"startTime\": 1381,\n \"finishTime\": 2316,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"participatingInCaseFunctionQueue\": true,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": {\n \"value\": \"\"\n },\n \"developerMessage\": {\n \"value\": \"\"\n },\n \"userMessage\": {\n \"value\": \"\"\n },\n \"additionalInfo\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"done\": true,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 5160.040158272386,\n \"total\": 4280.665853141718,\n \"percentComplete\": 967.4992118805859,\n \"updatedOn\": 885,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 1889,\n \"startTime\": 6944,\n \"finishTime\": 7518,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"participatingInCaseFunctionQueue\": false,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": {\n \"value\": \"\"\n },\n \"developerMessage\": {\n \"value\": \"\"\n },\n \"userMessage\": {\n \"value\": \"\"\n },\n \"additionalInfo\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"paused\": true,\n \"pausedBy\": \"string\",\n \"pausedUntil\": 6119,\n \"caseQueues\": [\n {\n \"caseId\": \"string\",\n \"queue\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"caseId\": \"string\",\n \"queue\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"totalRunningFunctions\": 4255\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16ac1833-7805-4639-8361-f58c9148e5c9", "name": "Returns asynchronous function statuses", "request": { "name": "Returns asynchronous function statuses", "description": { "content": "Use this operation to view the status of asynchronous functions. Functions can be filtered based on caseId and friendlyName.", "type": "text/plain" }, "url": { "path": [ "asyncFunctions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "caseId", "value": "", "description": "The case to filter functions returned on." }, { "disabled": false, "key": "friendlyName", "value": "", "description": "The type of function to filter on." }, { "disabled": false, "key": "activeWindowInSeconds", "value": "0", "description": "Unused for version 2 of the endpoint." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8bd0f0f4-6b72-49d0-afc5-6fc77a8c9708", "name": "default response", "originalRequest": { "url": { "path": [ "asyncFunctions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "caseId", "value": "" }, { "key": "friendlyName", "value": "" }, { "key": "activeWindowInSeconds", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "[\n {\n \"done\": false,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 4519.597710449744,\n \"total\": 9401.734771036783,\n \"percentComplete\": 2345.768411058237,\n \"updatedOn\": 1373,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 9019,\n \"startTime\": 8933,\n \"finishTime\": 4286,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"participatingInCaseFunctionQueue\": true,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"errorCode\": \"METHOD_NOT_ALLOWED\"\n }\n },\n {\n \"done\": false,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 7895.873296769644,\n \"total\": 1851.6062860760053,\n \"percentComplete\": 6346.556472609688,\n \"updatedOn\": 5139,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 0,\n \"startTime\": 3284,\n \"finishTime\": 4657,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"participatingInCaseFunctionQueue\": true,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"errorCode\": \"RESPONSE_TOO_LARGE\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d271e34-c410-4680-b0c9-ce8b3a0d1806", "name": "Returns the status of an asynchronous function", "request": { "name": "Returns the status of an asynchronous function", "description": { "content": "Use this operation to view the status of an asynchronous function. This is useful when you want to check on the status of a function.", "type": "text/plain" }, "url": { "path": [ "asyncFunctions", ":key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key", "description": "(Required) Async function key" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f85f9d68-8dcb-440a-b616-25a1765f58c9", "name": "default response", "originalRequest": { "url": { "path": [ "asyncFunctions", ":key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key", "description": "(Required) Async function key" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"done\": true,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 7234.522820984351,\n \"total\": 6627.552641865234,\n \"percentComplete\": 7835.484747047697,\n \"updatedOn\": 6389,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 6583,\n \"startTime\": 9864,\n \"finishTime\": 2493,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"participatingInCaseFunctionQueue\": true,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {}\n },\n \"errorCode\": \"REQUIRED_ARGUMENT_MISSING\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1606eb0-aa7a-4e06-bdc6-825119da1b41", "name": "Cancels an asynchronous function.", "request": { "name": "Cancels an asynchronous function.", "description": { "content": "Use this operation to cancel an asynchronous function.", "type": "text/plain" }, "url": { "path": [ "asyncFunctions", ":key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key", "description": "(Required) Async function key" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "5643851b-3a7f-4eb5-a7e7-7ed51289e199", "name": "default response", "originalRequest": { "url": { "path": [ "asyncFunctions", ":key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key", "description": "(Required) Async function key" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"done\": true,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 7234.522820984351,\n \"total\": 6627.552641865234,\n \"percentComplete\": 7835.484747047697,\n \"updatedOn\": 6389,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 6583,\n \"startTime\": 9864,\n \"finishTime\": 2493,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"participatingInCaseFunctionQueue\": true,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {}\n },\n \"errorCode\": \"REQUIRED_ARGUMENT_MISSING\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "002ec41e-c8df-45b8-a608-59d772a0273b", "name": "Cancels a processing job.", "request": { "name": "Cancels a processing job.", "description": { "content": "Use DELETE /asyncFunctions/{key} or PUT /asyncFunctions/{key}/status \n\n---\n\nIf canResume is true, any future processing jobs will finish processing the data from this job.\n", "type": "text/plain" }, "url": { "path": [ "asyncFunctions", "processingJobs", ":key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "canResume", "value": "false", "description": "Can this processing job be resumed" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key", "description": "(Required) Async function key" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e49e5b0c-6734-4e17-8da0-d1bd8222e219", "name": "default response", "originalRequest": { "url": { "path": [ "asyncFunctions", "processingJobs", ":key" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "canResume", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key", "description": "(Required) Async function key" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"done\": true,\n \"cancelled\": true,\n \"result\": {},\n \"token\": \"string\",\n \"functionKey\": \"string\",\n \"progress\": 7234.522820984351,\n \"total\": 6627.552641865234,\n \"percentComplete\": 7835.484747047697,\n \"updatedOn\": 6389,\n \"status\": \"string\",\n \"statusId\": \"string\",\n \"requestTime\": 6583,\n \"startTime\": 9864,\n \"finishTime\": 2493,\n \"caseId\": \"string\",\n \"caseName\": \"string\",\n \"hasSuccessfullyCompleted\": true,\n \"friendlyName\": \"string\",\n \"caseLocation\": \"string\",\n \"requestor\": \"string\",\n \"licenseShortName\": \"string\",\n \"action\": \"string\",\n \"options\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"participatingInCaseFunctionQueue\": true,\n \"processedBy\": \"string\",\n \"error\": {\n \"serverId\": \"string\",\n \"developerMessage\": \"string\",\n \"userMessage\": \"string\",\n \"additionalInfo\": {\n \"key_0\": {}\n },\n \"errorCode\": \"REQUIRED_ARGUMENT_MISSING\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "805c8f81-28c0-41b3-956a-edc803e6fb2f", "name": "Sets the status of an asynchronous function.", "request": { "name": "Sets the status of an asynchronous function.", "description": { "content": "Use this operation to set the status of an asynchronous function. This is useful if you want to pause, resume, cancel, or stop a job.", "type": "text/plain" }, "url": { "path": [ "asyncFunctions", ":key", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key", "description": "(Required) Async function key" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "048c7a71-5dc6-4aae-8fea-29b9d2171916", "name": "OK", "originalRequest": { "url": { "path": [ "asyncFunctions", ":key", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key", "description": "(Required) Async function key" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"PAUSED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"done\": \"true,\",\n \"cancelled\": \"true,\",\n \"token\": \"YOURTOKEN,\",\n \"functionKey\": \"81510747-e4e7-4ead-b9dc-6c80f05c83e8\",\n \"progress\": 0,\n \"total\": 1,\n \"percentComplete\": \"0.0000,\",\n \"updatedOn\": \"1673458472807,\",\n \"status\": \"CANCELLED,\",\n \"hasSuccessfullyCompleted\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c46a5d08-f291-432b-a814-5bd33742e925", "name": "Processing", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "daeafe25-f1c1-4c01-9a0f-81c4dc33dfab", "name": "Returns a list of keystore files available for a case", "request": { "name": "Returns a list of keystore files available for a case", "description": { "content": "Returns a list of keystore files available for a case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "keyStores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "27654fda-4054-4018-b87d-855b55d057e8", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "keyStores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"mykeystore\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1f5c54a-225a-4487-9c36-26e3cfdd4a9b", "name": "Adds a keystore to a case", "request": { "name": "Adds a keystore to a case", "description": { "content": "Uploads a keystore file to the cases directory.Currently supported key files are: PGP keyrings and collections - ACSII-armoured and binary (used for PGP decryption), PKCS#12 (used for S/MIME decryption), and Lotus Notes ID files which are associated with NSF files found in evidence", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "keyStores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "keystoreFile", "type": "file", "description": "" } ] } }, "response": [ { "id": "1807af68-94ec-4d79-9baf-cef47c6d5215", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "keyStores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "keystoreFile", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e10ec192-7cb3-487a-8b3b-7e33b6105329", "name": "A keystore file with the same filename already exists.", "originalRequest": { "url": { "path": [ "cases", ":caseId", "keyStores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "keystoreFile", "value": "", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"userMessage\": \"A keystore file with that name was already uploaded to this case.\",\n \"additionalInfo\": null,\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\",\n \"developerMessage\": \"A user attempted to upload a file, while another file with this name already existed.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10611361-5e81-402a-9c07-5a0d228d4348", "name": "The size of the request exceeds the maximum size.", "originalRequest": { "url": { "path": [ "cases", ":caseId", "keyStores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "keystoreFile", "value": "", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"FILE_TOO_LARGE\",\n \"developerMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\",\n \"userMessage\": null,\n \"additionalInfo\": {\n \"rootExceptionClass\": \"org.springframework.web.multipart.MultipartException\",\n \"rootExceptionMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d948b7b2-fb6a-493a-8e15-f558357b5392", "name": "Deletes the requested keystore from the case's keystore directory", "request": { "name": "Deletes the requested keystore from the case's keystore directory", "description": { "content": "Deletes the requested keystore from the case's keystore directory. All keystores are deleted if the fileToDeleteRegex query parameter is not included.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "keyStores" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fileToDeleteRegex", "value": ".*", "description": "fileToDeleteRegex" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "92f5ab2c-e4c0-4cdd-bf38-471bfa517818", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "keyStores" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fileToDeleteRegex", "value": ".*" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b9359f5-0f6e-48e4-a3f2-52c5ca6b6035", "name": "Ingests a new repository and/or supported containers into a simple case", "request": { "name": "Ingests a new repository and/or supported containers into a simple case", "description": { "content": "Use this operation to ingest different types of data during a single\nprocessing session. This operation is useful to ingest multiple containers\nusing one call rather than having to call multiple operations for each individual\ncontainer.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"repositories\": [\n {\n \"path\": \"\",\n \"custodianLevel\": -1,\n \"evidenceContainerNaming\": \"content\",\n \"evidenceContainerNamingPrefix\": \"\",\n \"timeZone\": \"\",\n \"charset\": \"\",\n \"language\": \"\",\n \"countryCode\": \"\"\n },\n {\n \"path\": \"\",\n \"custodianLevel\": -1,\n \"evidenceContainerNaming\": \"content\",\n \"evidenceContainerNamingPrefix\": \"\",\n \"timeZone\": \"\",\n \"charset\": \"\",\n \"language\": \"\",\n \"countryCode\": \"\"\n }\n ],\n \"containers\": [\n {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"exchangeMailboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"s3Buckets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sqlServers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"oracleServers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enterpriseVaults\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sharepointSites\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"mailStores\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"loadFiles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"centeraClusters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"splitFiles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dropboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sshServers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"twitterLocations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"documentumServers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"ms365Locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"slackLocations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"exchangeMailboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"s3Buckets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sqlServers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"oracleServers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enterpriseVaults\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sharepointSites\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"mailStores\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"loadFiles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"centeraClusters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"splitFiles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dropboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sshServers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"twitterLocations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"documentumServers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"ms365Locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"slackLocations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c2ad0686-60d4-4de6-a450-784374b3623d", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"processingProfile\": \"Default\",\n \"containers\": [\n {\n \"files\": [\n {\n \"path\": \"/mnt/raw-data/singleFile.txt\"\n },\n {\n \"path\": \"/mnt/raw-data/directory\"\n }\n ],\n \"s3Buckets\": [\n {\n \"access\": \"AWSACCESSKEY\",\n \"bucket\": \"my.aws.bucket/bucketFolder\",\n \"endpoint\": \"\",\n \"secret\": \"AWSSECRETACCESSKEY\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "586e13c7-55f1-40ed-85da-9201e30c9995", "name": "Ingests a directory and creates a repository in a simple case", "request": { "name": "Ingests a directory and creates a repository in a simple case", "description": { "content": "Use this operation to ingest a single directory into a simple case\nas an evidence repository. Adding evidence as a repository allows the evidence\nto be re-scanned at a future point and any new files added to the repository\nto be indexed in addition to the originally indexed evidence.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "repository" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"repository\": {\n \"path\": \"\",\n \"custodianLevel\": -1,\n \"evidenceContainerNaming\": \"content\",\n \"evidenceContainerNamingPrefix\": \"\",\n \"timeZone\": \"\",\n \"charset\": \"\",\n \"language\": \"\",\n \"countryCode\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1f357da3-ff65-4a9c-bc27-e35eb84c41fd", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "repository" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"repository\": {\n \"path\": \"/mnt/repositories\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1004579-59cb-4a64-90b4-4b92c63ad794", "name": "Ingests a new file/directory target into a container in a simple case", "request": { "name": "Ingests a new file/directory target into a container in a simple case", "description": { "content": "Use this operation to ingest a single file or directory during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"path\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0b5b92bb-aaca-4758-8e4d-75ee008467f5", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"path\": \"/mnt/raw-data/singleFile.txt\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4261edee-a2f2-4146-872c-ea10b94adc5d", "name": "Ingests a new load file target into a container within a simple case", "request": { "name": "Ingests a new load file target into a container within a simple case", "description": { "content": "Use this operation to ingest a single type of data from a single\nsource during a processing session. This endpoint currently supports loadfiles\nin CSV format.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "loadFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"csvFile\": \"\",\n \"idxFile\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a4da1dee-14ce-4cc6-8432-e6590367a77b", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "loadFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"path\": \"/mnt/loadfile.csv\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eed7091f-7dc9-4cf2-9bc4-89fc66066642", "name": "Ingests a new mail target into a container in a simple case", "request": { "name": "Ingests a new mail target into a container in a simple case", "description": { "content": "Use this operation to ingest an individual mail store into a simple case. This is useful when you want to ingest non-Microsoft Exchange targets.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "mail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"protocol\": \"\",\n \"host\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "233c351d-8679-4d2b-8c6e-02605082f515", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "mail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"protocol\": \"imap\",\n \"host\": \"imap.gmail.com\",\n \"port\": 993,\n \"username\": \"myuser\",\n \"password\": \"mypassword\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6440af1b-2c90-4813-a39a-edab53b355cc", "name": "Ingests a new Exchange target into a container in a simple case", "request": { "name": "Ingests a new Exchange target into a container in a simple case", "description": { "content": "Use this operation to ingest an Exchange account or a Microsoft Exchange email mailbox into a simple case.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"username\": \"\",\n \"password\": \"\",\n \"uri\": \"\",\n \"domain\": \"\",\n \"to\": \"\",\n \"from\": \"\",\n \"mailbox\": \"\",\n \"impersonating\": \"\",\n \"mailboxRetrieval\": [\n \"\",\n \"\"\n ]\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c3bb0142-6682-4e2a-b99c-10330be4b5d6", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "exchange" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"mailboxRetrieval\": [\n \"mailbox\"\n ],\n \"uri\": \"https://outlook.office365.com/ews/exchange.asmx\",\n \"username\": \"yourusername\",\n \"password\": \"yourpassword\",\n \"impersonating\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d27ba6c-7440-4e7c-a68a-9738e4487652", "name": "Ingests a new SharePoint target into a container within a simple case", "request": { "name": "Ingests a new SharePoint target into a container within a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "sharepoint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"domain\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"uri\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "85b5f676-0d00-4901-9564-b2222f05acbc", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "sharepoint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"domain\": \"mydomain.sharepoint.com\",\n \"username\": \"myuser\",\n \"password\": \"mypassword\",\n \"uri\": \"domain.sharepoint.com/sites/mypage\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c58f621-d8b6-4283-88c0-05a43cb6e72e", "name": "Ingests a new SQL target into a container in a simple case", "request": { "name": "Ingests a new SQL target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "sql" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"domain\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"computer\": \"\",\n \"instance\": \"\",\n \"query\": \"\",\n \"maxRowsPerTable\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5f0fbfe5-76f0-42f4-be15-26a7929e8b6e", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "sql" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"username\": \"myuser\",\n \"password\": \"mypassword\",\n \"computer\": \"myServerAddress\",\n \"instance\": \"myDatabase\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3e9070a-6f6f-4c47-98c0-db6a7bbf5432", "name": "Ingests a new Oracle target into a container in a simple case", "request": { "name": "Ingests a new Oracle target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "oracle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"username\": \"\",\n \"password\": \"\",\n \"database\": \"\",\n \"query\": \"\",\n \"driverType\": \"\",\n \"role\": \"\",\n \"maxRowsPerTable\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8a3b5515-30fa-46f3-ab7a-eaec749851a0", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "oracle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"driverType\": \"thin\",\n \"password\": \"mypassword\",\n \"username\": \"myusername\",\n \"database\": \"host:port\",\n \"role\": \"SYSDBA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c89f7ff-b132-4820-9323-bcac76b7fc73", "name": "Ingests a new enterprise vault target into a container in a simple case", "request": { "name": "Ingests a new enterprise vault target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from a Enterprise\nVault archiving system. Enterprise Vault is an on-premise data archiving platform\nproduced by Symantec Corporation.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "ev" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"computer\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"vault\": \"\",\n \"archive\": \"\",\n \"custodian\": \"\",\n \"keywords\": \"\",\n \"flag\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2e67f229-2b3b-45e9-9351-74fecfe901be", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "ev" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"computer\": \"MyEnterpriseVaultServer\",\n \"vault\": \"MyVaultId\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e80570e-048a-48bf-9bad-f60953da1969", "name": "Ingests a new S3 target into a container in a simple case", "request": { "name": "Ingests a new S3 target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "s3" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"access\": \"\",\n \"secret\": \"\",\n \"bucket\": \"\",\n \"endpoint\": \"\",\n \"useCredentialDiscovery\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8820f825-545a-470c-8054-5550ea28535e", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "s3" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"access\": \"AWSACCESSKEY\",\n \"bucket\": \"my.aws.bucket/bucketFolder\",\n \"endpoint\": \"\",\n \"secret\": \"AWSSECRETACCESSKEY\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1172d976-1347-4038-b312-81d01226ca32", "name": "Ingests a new Centera target into a container in a simple case", "request": { "name": "Ingests a new Centera target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from a Centera archiving system. Centera is a content-addressable storage platform for data archiving produced by EMC Corporation.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "centera" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"ipsFile\": \"\",\n \"clipsFile\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a2e41e70-6b61-491b-b97d-9ba8c318f76c", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "centera" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"ipsFile\": \"/mnt/centera/ipsFile\",\n \"clipsFile\": \"/mnt/centera/clipsFile\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae30373b-a1d1-4fc6-a322-a53223154791", "name": "Ingests a new split file list target into a container in a simple case", "request": { "name": "Ingests a new split file list target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session. This can be used to load files which have been split using ordinary splitting tools, which is common for raw (\"dd\") disk images.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "splitFiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"files\": [\n \"\",\n \"\"\n ]\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "83bbf215-8eaf-4016-95c2-0a3376d1ae86", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "splitFiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"files\": [\n \"/mnt/splitFile1\",\n \"/mnt/splitFile2\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0222be09-b1fc-4c7a-831f-8c93dc65fb93", "name": "Ingests a new Dropbox target into a container in a simple case", "request": { "name": "Ingests a new Dropbox target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "dropbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"authCode\": \"\",\n \"team\": \"\",\n \"accessToken\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "eb0ec4a7-3bb7-4319-8efe-e52c675ed2a1", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "dropbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"authCode\": \"DROPBOXAUTHCODE\",\n \"team\": true,\n \"accessToken\": \"DROPBOXACCESSTOKEN\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34956440-d945-4536-9877-49d8adf71c42", "name": "Ingests a new SSH-based target into a container in a simple case", "request": { "name": "Ingests a new SSH-based target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "ssh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"username\": \"\",\n \"password\": \"\",\n \"computer\": \"\",\n \"sudoPassword\": \"\",\n \"keyFolder\": \"\",\n \"portNumber\": \"\",\n \"hostFingerprint\": \"\",\n \"remoteFolder\": \"\",\n \"accessingRemoteDisks\": \"\",\n \"initialLocation\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6546fa7b-7774-4b10-bf8f-3b84f2ed4eea", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "ssh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"computer\": \"MyServerName\",\n \"username\": \"myUserName\",\n \"password\": \"myPassword\",\n \"port\": 22,\n \"remoteFolder\": \"/mnt/data\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "013d5ffc-7643-4189-9f2c-fb84493a2c4c", "name": "Ingests a new historical twitter target into a container in a simple case", "request": { "name": "Ingests a new historical twitter target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "twitter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"accessToken\": \"\",\n \"accessTokenSecret\": \"\",\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8ae194fd-36fa-4bdb-9cce-63424a98ef2a", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "twitter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"consumerKey\": \"consumerKey\",\n \"consumerSecret\": \"consumerSecret\",\n \"accessToken\": \"accessToken\",\n \"accessTokenSecret\": \"accessTokenSecret\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84731274-0d64-4e16-8306-e266f4c79b09", "name": "Ingests a new Microsoft 365 target into a container in a simple case", "request": { "name": "Ingests a new Microsoft 365 target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "ms365" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"tenantId\": \"\",\n \"clientId\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"clientSecret\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"certificateStorePath\": \"\",\n \"certificateStorePassword\": \"\",\n \"retrievals\": [\n \"\",\n \"\"\n ],\n \"mailFolderRetrievals\": [\n \"\",\n \"\"\n ],\n \"mailboxRetrievals\": [\n \"MAILBOX\"\n ],\n \"teamNames\": [\n \"\",\n \"\"\n ],\n \"userPrincipalNames\": [\n \"\",\n \"\"\n ],\n \"versionFilters\": {\n \"versionRetrievalEnabled\": false,\n \"versionRetrievalLimit\": \"\"\n },\n \"licenseModel\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "adfd1dda-9a3e-4cf6-bf73-244e6961771d", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "ms365" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"tenantId\": \"tenantId\",\n \"clientId\": \"clientId\",\n \"clientSecret\": \"clientSecret\",\n \"from\": \"2021-01-01\",\n \"to\": \"2021-04-30\",\n \"username\": \"username\",\n \"password\": \"password\",\n \"userPrincipalNames\": [\n \"userprincipal@domain.com\"\n ],\n \"retrievals\": [\n \"USERS_CONTACTS\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f3115ef-9417-42b6-94be-5f172c8820f5", "name": "Ingests a new Slack target into a container in a simple case", "request": { "name": "Ingests a new Slack target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "slack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"tempAuthCode\": \"\",\n \"storedCredentialName\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ]\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aaf4d81c-9adb-40d2-afec-1203aa896581", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "slack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"tempAuthCode\": \"23432421\",\n \"storedCredentialName\": null,\n \"from\": \"2021-01-01\",\n \"to\": \"2021-04-30\",\n \"userIds\": [\n \"1244\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9159742-005f-40ef-8c02-4386cd536a44", "name": "Ingests a new Documentum target into a container in a simple case", "request": { "name": "Ingests a new Documentum target into a container in a simple case", "description": { "content": "Use this operation to ingest a single type of data from one source during a processing session.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "evidence", "documentum" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"target\": {\n \"domain\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"port\": 1489,\n \"query\": \"\",\n \"server\": \"\",\n \"docBase\": \"\",\n \"propertyFile\": \"\"\n },\n \"container\": {\n \"name\": \"\",\n \"customMetadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"encoding\": \"\",\n \"custodian\": \"\",\n \"timeZone\": \"\",\n \"description\": \"\",\n \"locale\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "49605ec7-3ea1-4903-b043-8bdcdc506488", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "evidence", "documentum" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": {\n \"username\": \"myuser\",\n \"password\": \"mypassword\",\n \"domain\": \"domain\",\n \"port\": 1489,\n \"query\": \"query\",\n \"server\": \"server\",\n \"docBase\": \"docBaseRepository\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe20313c-f048-41fc-8407-9648af070a3a", "name": "Reloads items from source based on a query in a simple case", "request": { "name": "Reloads items from source based on a query in a simple case", "description": { "content": "Use this operation to reload items from source.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"processorSettings\": {\n \"processText\": true,\n \"traversalScope\": \"\",\n \"processLooseFileContents\": true,\n \"processForensicImages\": true,\n \"analysisLanguage\": \"en\",\n \"stopWords\": false,\n \"stemming\": false,\n \"enableExactQueries\": false,\n \"extractNamedEntities\": false,\n \"extractNamedEntitiesFromText\": false,\n \"extractNamedEntitiesFromProperties\": false,\n \"extractNamedEntitiesFromTextStripped\": false,\n \"extractNamedEntitiesFromTextCommunications\": false,\n \"extractShingles\": true,\n \"processTextSummaries\": true,\n \"calculateSSDeepFuzzyHash\": false,\n \"calculatePhotoDNARobustHash\": false,\n \"detectFaces\": false,\n \"classifyImagesWithDeepLearning\": false,\n \"imageClassificationModelUrl\": \"\",\n \"extractFromSlackSpace\": false,\n \"carveFileSystemUnallocatedSpace\": false,\n \"carveUnidentifiedData\": false,\n \"carvingBlockSize\": \"\",\n \"recoverDeletedFiles\": true,\n \"extractEndOfFileSlackSpace\": false,\n \"smartProcessRegistry\": false,\n \"identifyPhysicalFiles\": true,\n \"createThumbnails\": true,\n \"skinToneAnalysis\": false,\n \"calculateAuditedSize\": false,\n \"storeBinary\": false,\n \"maxStoredBinarySize\": 250000000,\n \"maxDigestSize\": 250000000,\n \"digests\": [\n \"MD5\"\n ],\n \"addBccToEmailDigests\": false,\n \"addCommunicationDateToEmailDigests\": false,\n \"reuseEvidenceStores\": false,\n \"processFamilyFields\": false,\n \"hideEmbeddedImmaterialData\": false,\n \"reportProcessingStatus\": \"none\",\n \"enableCustomProcessing\": [\n \"\",\n \"\"\n ],\n \"workerItemCallback\": \"\",\n \"workerItemCallbacks\": [\n \"\",\n \"\"\n ],\n \"performOcr\": false,\n \"ocrProfileName\": \"Default\",\n \"createPrintedImage\": false,\n \"imagingProfileName\": \"Processing Default\",\n \"exportMetadata\": false,\n \"metadataExportProfileName\": \"\",\n \"namedEntities\": [\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"regularExpression\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"mimeTypeProcessorSettings\": [\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"mimeType\": \"\",\n \"settings\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"processEmbedded\": {\n \"value\": \"\"\n },\n \"processText\": {\n \"value\": \"\"\n },\n \"textStrip\": {\n \"value\": \"\"\n },\n \"processNamedEntities\": {\n \"value\": \"\"\n },\n \"processImages\": {\n \"value\": \"\"\n },\n \"storeBinary\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n },\n \"keystoreKeyParameters\": [\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n },\n {\n \"filePassword\": \"\",\n \"keyPasswords\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"target\": \"\",\n \"keystoreName\": \"\"\n }\n ],\n \"rescanEvidenceRepositories\": \"\",\n \"rescanEvidenceRepositoriesSettings\": {\n \"depth\": \"\"\n },\n \"passwordDiscoverySettings\": {\n \"mode\": \"\",\n \"wordList\": \"\"\n },\n \"configurationProfile\": \"\",\n \"processingProfile\": \"\",\n \"query\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b3421c3c-8abd-4920-89db-6c27188e8739", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"query\": \"*\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd0f3be3-a506-4419-b65b-d14806bd7e14", "name": "Performs OCR on query items", "request": { "name": "Performs OCR on query items", "description": { "content": "Use this operation to perform bulk optical character recognition\n(OCR) on items returned from a query. This is done using OCR and imaging options.\nThe Nuix OCR add-on must be installed. For example, you can OCR an image with\na query to extract item text.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "items", "ocr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"ocrOptions\": {\n \"regeneratePdfs\": false,\n \"updatePdf\": true,\n \"updateText\": true,\n \"textModification\": \"append\",\n \"quality\": \"\",\n \"rotation\": \"auto\",\n \"deskew\": true,\n \"clearOcrCache\": true,\n \"outputDirectory\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"timeout\": 90,\n \"updateDuplicates\": false,\n \"ocrProfileName\": \"\"\n },\n \"ocrImagingOptions\": {\n \"imageExcelSpreadsheets\": false,\n \"slipSheetContainers\": false,\n \"excelExportingEngine\": \"\",\n \"excelPrintHiddenRows\": \"\",\n \"excelPrintHiddenColumns\": \"\",\n \"excelPrintHiddenWorksheets\": \"SHEET_VERY_HIDDEN\",\n \"excelPrintComments\": \"\",\n \"excelPrintNotes\": \"\",\n \"excelPaperSize\": \"\",\n \"excelPageOrientation\": \"\",\n \"excelPageZoom\": \"\",\n \"excelFitToPagesTall\": \"\",\n \"excelFitToPagesWide\": \"\",\n \"excelWorksheetPrintArea\": \"\",\n \"excelPageNumberLimit\": \"\",\n \"excelPrintGridlines\": true,\n \"excelPrintHeadings\": true,\n \"wordExportingEngine\": \"INTERNAL\",\n \"wordShowMarkup\": \"\",\n \"wordShowHiddenText\": \"\",\n \"powerpointExportEngine\": \"INTERNAL\",\n \"powerPointPrintOutputType\": \"PRINT_OUTPUT_SLIDES\",\n \"slipSheetMetadataProfile\": \"\"\n },\n \"ocrProfile\": \"\",\n \"imagingProfile\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"parallelProcessingSettings\": {\n \"workerCount\": \"\",\n \"workerMemory\": \"\",\n \"workerTemp\": \"\",\n \"embedBroker\": true,\n \"brokerMemory\": 4096,\n \"workerBrokerAddress\": \"\",\n \"useRemoteWorkers\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1c238e31-9ab8-4d9c-af21-b07722cd0f10", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "items", "ocr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"query\": \"kind: spreadsheet\",\n \"ocrOptions\": {\n \"quality\": \"document_archiving_speed\",\n \"ocrImagingOptions\": {\n \"excelExportingEngine\": \"MS_OFFICE\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "882d7daf-054a-488a-8a64-1420e290edb0", "name": "Resources", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ac6d64f3-13f1-409e-93ac-6e4c656d2451", "name": "Returns all item kinds", "request": { "name": "Returns all item kinds", "description": { "content": "Use this operation to view the item kinds currently available with this API. A kind is a collection of types which are similar and grouped together. These are not case specific. This is useful for analysis.", "type": "text/plain" }, "url": { "path": [ "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f8da19c1-0956-4c70-a04f-cac85396409c", "name": "The list of item kinds.", "originalRequest": { "url": { "path": [ "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"email\",\n \"localisedName\": \"Email\"\n },\n {\n \"name\": \"calendar\",\n \"localisedName\": \"Calendar\"\n },\n {\n \"name\": \"document\",\n \"localisedName\": \"Documents\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d388dc9e-4153-4c61-a357-a28c41f05374", "name": "Returns all search macros names and expansions", "request": { "name": "Returns all search macros names and expansions", "description": { "content": "Use this operation to view the search macros names and expansions for all cases. If there aren't any search macros available, the returned list will be empty. Macros are used to identify relevant items and screen them for information. These are useful when the screening process needs to be repeated regularly.", "type": "text/plain" }, "url": { "path": [ "searchMacros" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5115b6a7-9ad4-46e2-85c9-45d5b12e0c57", "name": "Structured search macro response.", "originalRequest": { "url": { "path": [ "searchMacros" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"files\": null,\n \"folders\": {\n \"Context Groups\": {\n \"files\": null,\n \"folders\": {\n \"Device Access\": {\n \"files\": [\n {\n \"name\": \"USB Devices\",\n \"expansion\": \"(properties:\\\"registryvalue friendlyname\\\" AND (mime-type:application/vnd.ms-registry-key) AND (path-name:usb)) OR (properties:(\\\"Event ID:2100\\\" OR \\\"Event ID:2102\\\" OR \\\"Event ID:157\\\")) \"\n },\n {\n \"name\": \"Mounted Devices\",\n \"expansion\": \"((mime-type:application/vnd.ms-registry-key) AND (name:MountedDevices)) \"\n }\n ]\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f33b5c2f-2570-4b89-98b4-3aaa2484c8ec", "name": "Returns all shingle list names and expansions", "request": { "name": "Returns all shingle list names and expansions", "description": { "content": "Use this operation to view the shingle list names and expansions for all cases. If there aren't any shingle lists available in the shingle lists store, the returned list will be empty.", "type": "text/plain" }, "url": { "path": [ "shingleLists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c1367913-e661-4075-9fd1-660674a42aa7", "name": "An array of shingle list names.", "originalRequest": { "url": { "path": [ "shingleLists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"MyShingleList.shlist\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fa10b48-c6d9-498c-aa34-8c76639f21e6", "name": "Returns all word list names", "request": { "name": "Returns all word list names", "description": { "content": "Use this operation to view the word list names for all cases. If there aren't any word lists available, the returned list will be empty.", "type": "text/plain" }, "url": { "path": [ "wordLists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "11716b87-c5f6-4c2c-a27d-84c0d1c1cc40", "name": "An array of word lists.", "originalRequest": { "url": { "path": [ "wordLists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"MyWordList\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01cf4f6a-8e59-4594-8a99-51b55aed0e24", "name": "Returns all fuzzy hash list names", "request": { "name": "Returns all fuzzy hash list names", "description": { "content": "Use this operation to view all fuzzy hash list names. If there aren't any fuzzy hash lists available, the returned list will be empty.", "type": "text/plain" }, "url": { "path": [ "fuzzyHashLists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "26eb89a7-e584-454d-b4ca-c040ba778aa5", "name": "An array of fuzzy has lists.", "originalRequest": { "url": { "path": [ "fuzzyHashLists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"MyFuzzyHashList\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c7656b2-aebb-49b2-97f4-fbc12dd45973", "name": "Returns all metadata profile names", "request": { "name": "Returns all metadata profile names", "description": { "content": "Use this operation to view the metadata profile names for all cases. These represent the item data that should be displayed in a query, including fields and properties. The metadata profile names are returned as a set of strings.", "type": "text/plain" }, "url": { "path": [ "metadataProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d001b14a-dc1c-40f5-b1cc-1336756f723b", "name": "The list of metadata profile names.", "originalRequest": { "url": { "path": [ "metadataProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"Context\",\n \"Default\",\n \"Discover\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d971965-da9c-4e1c-8d5e-210f3f522ee4", "name": "Returns all item types", "request": { "name": "Returns all item types", "description": { "content": "Use this operation to view the item types currently available with this API. Types correspond to MIME types where possible.", "type": "text/plain" }, "url": { "path": [ "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5a7e33d5-78ce-443e-ae46-316c453759d8", "name": "An array of item types.", "originalRequest": { "url": { "path": [ "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"application/vnd.ms-excel\",\n \"localisedName\": \"Microsoft Excel Spreadsheet\",\n \"preferredExtension\": \"xls\",\n \"kind\": \"spreadsheet\",\n \"count\": null\n },\n {\n \"name\": \"application/vnd.ms-word\",\n \"localisedName\": \"Microsoft Word Document\",\n \"preferredExtension\": \"doc\",\n \"kind\": \"document\",\n \"count\": null\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f53db817-e071-48a4-98d4-83e960a457bc", "name": "Returns all configuration profile names", "request": { "name": "Returns all configuration profile names", "description": { "content": "Use this operation to view the configuration profiles on the system.", "type": "text/plain" }, "url": { "path": [ "configurationProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d3d04d7a-f859-4c75-9081-0ddba53b7108", "name": "The list of configuration profile names.", "originalRequest": { "url": { "path": [ "configurationProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"MyConfigurationProfile\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1cfaef9f-9c64-4e9a-b557-396e72026871", "name": "Returns all digest list names", "request": { "name": "Returns all digest list names", "description": { "content": "Use this operation to view all digest list names. If there aren't any digest lists available, the returned list will be empty.", "type": "text/plain" }, "url": { "path": [ "digestLists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b81840b9-bdd1-490e-a6c6-696c55a2e55c", "name": "The list of available digests.", "originalRequest": { "url": { "path": [ "digestLists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"NSRLFile\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5538c28-1b65-46c6-b8cf-5bb32d818bfe", "name": "Uploads a digest list to a user data directory", "request": { "name": "Uploads a digest list to a user data directory", "description": { "content": "When no user data directory is provided, the first one found in 'nuix.engine.userDataDirs' will be used. If the file already exists in the user data directory it will be replaced.", "type": "text/plain" }, "url": { "path": [ "digestLists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "userDataDir", "value": "", "description": "User data directory" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "digestList", "value": "[\"\",\"\"]", "type": "text", "description": "" } ] } }, "response": [ { "id": "716e9552-8e7d-4b6b-a583-47aff17cef1f", "name": "File upload response.", "originalRequest": { "url": { "path": [ "digestLists" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userDataDir", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "digestList", "value": "[\"\",\"\"]", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"fileUploads\": [\n {\n \"success\": true,\n \"filePath\": \"/opt/nuix/nuix-restful-service/engines/8.4.0.251/user-data/Digest Lists/NSRLFile.txt\",\n \"size\": 875193726\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704e5272-ffe8-467b-bab3-df2e5818cebe", "name": "The size of the request exceeds the maximum size.", "originalRequest": { "url": { "path": [ "digestLists" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userDataDir", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "digestList", "value": "[\"\",\"\"]", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"FILE_TOO_LARGE\",\n \"developerMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\",\n \"userMessage\": null,\n \"additionalInfo\": {\n \"rootExceptionClass\": \"org.springframework.web.multipart.MultipartException\",\n \"rootExceptionMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae7cd6d3-1f99-40b7-987c-7b618d4ebd86", "name": "Returns all imaging profile names", "request": { "name": "Returns all imaging profile names", "description": { "content": "Use this operation to view the imaging profiles on the system.", "type": "text/plain" }, "url": { "path": [ "imagingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "675fccf7-872e-45fd-982a-0268a929feb2", "name": "The list of all imaging profiles", "originalRequest": { "url": { "path": [ "imagingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"Default\",\n \"MyImagingProfile\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "922c23b9-66d8-4be7-879b-1be2e0f92f18", "name": "Upload an imaging profile", "request": { "name": "Upload an imaging profile", "description": { "content": "Use this operation to add an imaging profile to the system. This operation will fail if a profile with the same name already exists.", "type": "text/plain" }, "url": { "path": [ "imagingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "profile", "type": "file", "description": "" } ] } }, "response": [ { "id": "226279d7-9fb7-4866-9b9c-bc0629da7f00", "name": "Imaging Profile created and uploaded.", "originalRequest": { "url": { "path": [ "imagingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "value": "", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "The URL of the uploaded imaging profile.", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c229e8c-5f8b-4acc-acd0-7c9fa93a8dbc", "name": "A imaging profile with the same filename already exists.", "originalRequest": { "url": { "path": [ "imagingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "value": "", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"userMessage\": \"A Imaging Profile named imagingAutomation.xml already exists.\",\n \"additionalInfo\": null,\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\",\n \"developerMessage\": \"A user attempted to upload a file, while another file with this name already existed.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b018fcbd-1699-47d8-ba5c-5daf434fa23a", "name": "The size of the request exceeds the maximum size.", "originalRequest": { "url": { "path": [ "imagingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "value": "", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"FILE_TOO_LARGE\",\n \"developerMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\",\n \"userMessage\": null,\n \"additionalInfo\": {\n \"rootExceptionClass\": \"org.springframework.web.multipart.MultipartException\",\n \"rootExceptionMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e06d4971-fcc4-4aba-b346-d24926bdb19c", "name": "Unsupported file type.", "originalRequest": { "url": { "path": [ "imagingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "value": "", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"additionalInfo\": {\n \"supportedMediaTypes\": [\n \"application/xml\"\n ]\n },\n \"errorCode\": \"MEDIA_TYPE_NOT_SUPPORTED\",\n \"developerMessage\": \"The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method. See 'supportedMediaTypes' in 'additionalInfo' for a list of supported types\\n\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5e39981-19a3-4ddb-844e-fdf941275700", "name": "Downloads an imaging profile by name", "request": { "name": "Downloads an imaging profile by name", "description": { "content": "Use this operation to export an imaging profile from the system.", "type": "text/plain" }, "url": { "path": [ "imagingProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the imaging profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "key": "Accept", "value": "application/xml" } ], "method": "GET", "auth": null }, "response": [ { "id": "cacb1980-c9f4-4b27-a5a3-f4f9dbd26804", "name": "The imaging profile download.", "originalRequest": { "url": { "path": [ "imagingProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the imaging profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/xml" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": "\n(string)", "cookie": [], "_postman_previewlanguage": "xml" }, { "id": "a2dd88d9-2a14-4092-b599-de1b1eb5bb44", "name": "A imaging profile with the name provided could not be found.", "originalRequest": { "url": { "path": [ "imagingProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the imaging profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'IMAGING_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"userMessage\": \"The resource of type 'IMAGING_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48cd5db3-0d2a-4bc4-9092-5f27d91bdce7", "name": "Returns all production profile names", "request": { "name": "Returns all production profile names", "description": { "content": "Use this operation to view the production profiles on the system.", "type": "text/plain" }, "url": { "path": [ "productionProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "53edd10f-ed27-4644-88e8-f0c49f1cc456", "name": "The list of all production profiles", "originalRequest": { "url": { "path": [ "productionProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"MyProductionProfile\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb1f1f14-b0dd-4d53-be9b-0c8e47373fc1", "name": "Upload a production profile", "request": { "name": "Upload a production profile", "description": { "content": "Use this operation to add a production profile to the system. This operation will fail if a profile with the same name already exists.", "type": "text/plain" }, "url": { "path": [ "productionProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "profile", "type": "file", "description": "" } ] } }, "response": [ { "id": "1279f24b-feb4-445c-a1d5-179a08c66755", "name": "Production Profile created and uploaded.", "originalRequest": { "url": { "path": [ "productionProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "The URL of the uploaded production profile.", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3249401-d37d-4792-9fc1-21b572655414", "name": "A production profile with the same filename already exists.", "originalRequest": { "url": { "path": [ "productionProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"userMessage\": \"A Production Profile named productionAutomation.xml already exists.\",\n \"additionalInfo\": null,\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\",\n \"developerMessage\": \"A user attempted to upload a file, while another file with this name already existed.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63061e7f-d5be-4e9f-8acf-80436b6838a9", "name": "The size of the request exceeds the maximum size.", "originalRequest": { "url": { "path": [ "productionProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"FILE_TOO_LARGE\",\n \"developerMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\",\n \"userMessage\": null,\n \"additionalInfo\": {\n \"rootExceptionClass\": \"org.springframework.web.multipart.MultipartException\",\n \"rootExceptionMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6feadd5f-22e5-4eac-9b91-f637c77d9a66", "name": "Unsupported file type.", "originalRequest": { "url": { "path": [ "productionProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"additionalInfo\": {\n \"supportedMediaTypes\": [\n \"application/xml\"\n ]\n },\n \"errorCode\": \"MEDIA_TYPE_NOT_SUPPORTED\",\n \"developerMessage\": \"The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method. See 'supportedMediaTypes' in 'additionalInfo' for a list of supported types\\n\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b5c0a94-f56f-4f56-9b54-aac5bec199f4", "name": "Downloads a production profile by name", "request": { "name": "Downloads a production profile by name", "description": { "content": "Use this operation to export a production profile from the system.", "type": "text/plain" }, "url": { "path": [ "productionProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the production profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "key": "Accept", "value": "application/xml" } ], "method": "GET", "auth": null }, "response": [ { "id": "294eedc8-beb9-421c-98dc-acb30021918a", "name": "The production profile download.", "originalRequest": { "url": { "path": [ "productionProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the production profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/xml" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": "\n(string)", "cookie": [], "_postman_previewlanguage": "xml" }, { "id": "bcd1eabd-c3f6-4d80-a124-1626d7154fbb", "name": "A production profile with the name provided could not be found.", "originalRequest": { "url": { "path": [ "productionProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the production profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'PRODUCTION_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"userMessage\": \"The resource of type 'PRODUCTION_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17dbaff9-3649-470a-89e5-f9bc2db3e64c", "name": "Returns all processing profile names", "request": { "name": "Returns all processing profile names", "description": { "content": "Use this operation to view the processing profiles on the system.", "type": "text/plain" }, "url": { "path": [ "processingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fb55e29b-27dc-479d-8095-4973bd8e791b", "name": "The list of all Processing profiles", "originalRequest": { "url": { "path": [ "processingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"Default\",\n \"Default_Mobile\",\n \"MyProcessingProfile\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1356c4de-50a0-446b-9a05-9d905ad23c86", "name": "Upload a processing profile", "request": { "name": "Upload a processing profile", "description": { "content": "Use this operation to add a processing profile to the system. This operation will fail if a profile with the same name already exists.", "type": "text/plain" }, "url": { "path": [ "processingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "profile", "type": "file", "description": "" } ] } }, "response": [ { "id": "0347643d-d034-4fe2-a404-af2fafffffce", "name": "Processing Profile created and uploaded.", "originalRequest": { "url": { "path": [ "processingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "The URL of the uploaded processing profile.", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbb3fcee-09b7-4fe6-b435-9e841a6e27fa", "name": "A processing profile with the same filename already exists.", "originalRequest": { "url": { "path": [ "processingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"userMessage\": \"A Processing Profile named processingAutomation.xml already exists.\",\n \"additionalInfo\": null,\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\",\n \"developerMessage\": \"A user attempted to upload a file, while another file with this name already existed.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef8a0682-1ea2-4d32-a432-55d0d5e5f829", "name": "The size of the request exceeds the maximum size.", "originalRequest": { "url": { "path": [ "processingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"FILE_TOO_LARGE\",\n \"developerMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\",\n \"userMessage\": null,\n \"additionalInfo\": {\n \"rootExceptionClass\": \"org.springframework.web.multipart.MultipartException\",\n \"rootExceptionMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab428e4b-5c68-4ebc-a004-235c9953c818", "name": "Unsupported file type.", "originalRequest": { "url": { "path": [ "processingProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"additionalInfo\": {\n \"supportedMediaTypes\": [\n \"application/xml\"\n ]\n },\n \"errorCode\": \"MEDIA_TYPE_NOT_SUPPORTED\",\n \"developerMessage\": \"The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method. See 'supportedMediaTypes' in 'additionalInfo' for a list of supported types\\n\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa702c2f-e0fa-4237-8a40-ae1ceca36e7b", "name": "Downloads a processing profile by name", "request": { "name": "Downloads a processing profile by name", "description": { "content": "Use this operation to export a processing profile from the system.", "type": "text/plain" }, "url": { "path": [ "processingProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the processing profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "key": "Accept", "value": "application/xml" } ], "method": "GET", "auth": null }, "response": [ { "id": "de88bc17-e108-4b79-8dcd-53e61e06461c", "name": "The processing profile download.", "originalRequest": { "url": { "path": [ "processingProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the processing profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/xml" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": "\n(string)", "cookie": [], "_postman_previewlanguage": "xml" }, { "id": "e360b0bc-8b03-4436-bbaf-483514f5d006", "name": "A processing profile with the name provided could not be found.", "originalRequest": { "url": { "path": [ "processingProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the processing profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'PROCESSING_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"userMessage\": \"The resource of type 'PROCESSING_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30fcfb7b-185b-4a3b-96e5-9db8af7bcbd8", "name": "Returns all OCR profile names", "request": { "name": "Returns all OCR profile names", "description": { "content": "Use this operation to view the OCR profiles on the system.", "type": "text/plain" }, "url": { "path": [ "ocrProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e6441797-f79a-49a7-a078-39cbdedbfcb6", "name": "The list of all OCR profiles", "originalRequest": { "url": { "path": [ "ocrProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"Default\",\n \"MyOcrAutomation\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "608335e5-fb4e-483a-b3b3-08f15719ebd9", "name": "Upload an OCR profile", "request": { "name": "Upload an OCR profile", "description": { "content": "Use this operation to add an OCR profile to the system. This operation will fail if a profile with the same name already exists.", "type": "text/plain" }, "url": { "path": [ "ocrProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "profile", "type": "file", "description": "" } ] } }, "response": [ { "id": "e23cb652-664b-4d99-bacc-b6df280847c6", "name": "OCR Profile created and uploaded.", "originalRequest": { "url": { "path": [ "ocrProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "The URL of the uploaded OCR profile.", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4061efc1-c11a-4087-92cb-daa17cfa3ad1", "name": "An OCR profile with the same filename already exists.", "originalRequest": { "url": { "path": [ "ocrProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"userMessage\": \"An OCR Profile named ocrAutomation.xml already exists.\",\n \"additionalInfo\": null,\n \"errorCode\": \"FOLDER_ALREADY_EXISTS\",\n \"developerMessage\": \"A user attempted to upload a file, while another file with this name already existed.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b94f4dc0-25db-4b80-8359-cb60346a9f9d", "name": "The size of the request exceeds the maximum size.", "originalRequest": { "url": { "path": [ "ocrProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"FILE_TOO_LARGE\",\n \"developerMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\",\n \"userMessage\": null,\n \"additionalInfo\": {\n \"rootExceptionClass\": \"org.springframework.web.multipart.MultipartException\",\n \"rootExceptionMessage\": \"Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3260299650) exceeds the configured maximum (10485760)\\\"\\n\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4c96c92-f803-4432-9b3b-514f1ecffb47", "name": "Unsupported file type.", "originalRequest": { "url": { "path": [ "ocrProfiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "profile", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"additionalInfo\": {\n \"supportedMediaTypes\": [\n \"application/xml\"\n ]\n },\n \"errorCode\": \"MEDIA_TYPE_NOT_SUPPORTED\",\n \"developerMessage\": \"The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method. See 'supportedMediaTypes' in 'additionalInfo' for a list of supported types\\n\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26ef8bd0-639d-401d-8466-cdd4a6754a62", "name": "Downloads an OCR profile by name", "request": { "name": "Downloads an OCR profile by name", "description": { "content": "Use this operation to export an OCR profile from the system.", "type": "text/plain" }, "url": { "path": [ "ocrProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the OCR profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "key": "Accept", "value": "application/xml" } ], "method": "GET", "auth": null }, "response": [ { "id": "fc3f41f6-c5ef-49af-850e-48e9bfcd50ae", "name": "The OCR profile download.", "originalRequest": { "url": { "path": [ "ocrProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the OCR profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/xml" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": "\n(string)", "cookie": [], "_postman_previewlanguage": "xml" }, { "id": "f9750105-5c5e-45eb-a460-18cc5fee85ac", "name": "An OCR profile with the name provided could not be found.", "originalRequest": { "url": { "path": [ "ocrProfiles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the OCR profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'OCR_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"userMessage\": \"The resource of type 'OCR_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2e4307d-cbd9-4367-a316-012ca8ce89c0", "name": "Returns the OCR profile template details.", "request": { "name": "Returns the OCR profile template details.", "description": { "content": "Use this operation to get the OCR profile template details.", "type": "text/plain" }, "url": { "path": [ "ocrProfiles", ":name", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the OCR profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1e7656fe-fc75-4258-a955-aa8e3a6d24d0", "name": "The OCR profile template details.", "originalRequest": { "url": { "path": [ "ocrProfiles", ":name", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the OCR profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"id\": \"1eec3145-f3a6-4cce-8e32-c07cb2141438\",\n \"name\": \"Default\",\n \"description\": null,\n \"appendText\": true,\n \"updateText\": true,\n \"updatePdf\": true,\n \"pageRotation\": \"AUTO\",\n \"textRotations\": [\n \"AUTO\"\n ],\n \"multiProcessingMode\": \"SEQUENTIAL\",\n \"languages\": [\n \"English\"\n ],\n \"deskew\": true,\n \"autoPageRotationEnabled\": true,\n \"customPageRotationEnabled\": false,\n \"noPageRotationEnabled\": false,\n \"clockwisePageRotationEnabled\": false,\n \"counterClockwisePageRotationEnabled\": false,\n \"oneEightyPageRotationEnabled\": false,\n \"ocrProcessingProfile\": \"DOCUMENT_ARCHIVING_ACCURACY\",\n \"timeout\": 90,\n \"printedImageRotation\": \"AUTO\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b734a0f-c17d-451b-b784-3448ef15e20d", "name": "An OCR profile with the name provided could not be found.", "originalRequest": { "url": { "path": [ "ocrProfiles", ":name", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) The name of the OCR profile as defined in the name field of the XML file. This should not be confused with the filename and the path value should not contain the file extension.\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'OCR_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"userMessage\": \"The resource of type 'OCR_PROFILE' and identifier 'InvalidProfile' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "89d03083-a446-4e90-8d7b-59ccc029ea09", "name": "Scripting", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f36e55c7-9c3c-4d05-b0b9-77dc0e6d9abf", "name": "Executes a user script on a case", "request": { "name": "Executes a user script on a case", "description": { "content": "Use this operation to execute a script that is in the user scripts\ndirectory. This is useful for extending the Nuix REST API to fit your needs.\n\nEach script is injected with several common local variables, all of which are available both\nwith and without a leading dollar sign (**$**):\n\n* **current_case** (also as **currentCase**): This is the Java nuix.Case object. It is only\navailable in the case-specific endpoint.x\n\n* **utilities**: This is the Java nuix.Utilities object for the current environment.\n\n* **request**: This is the Java HttpServletRequest object. It is only available in version 1 of the endpoint.\nThis variable is not available in version 2 of the endpoint. Use custom_arguments instead.\n\n* **response**: This provides methods for customising the object that is returned from the server.\nThese methods are:\n * **setStatus(int httpStatusCode)**: This sets the HTTP status code.\n * **addHeader(String headerName, String headerValue)**: This adds a header to the actual HTTP response that comes back from the server.\n * **setBody(Object body)**: This sets the payload of the response.\n\n* **progress** : This provides methods for updating the progress of the script when run in an asynchronous\nmanner. These methods are:\n\n * **setStatus(String status)**: This sets an arbitrary status value. This will be reflected\n in the ''status'' variable in the AsyncFunctionStatus response.\n * **setEstimatedFinalValue(long value))**: This sets an estimate for the final progress value. This will\n be reflected in the ''total'' variable in the AsyncFunctionStatus response,\n and will be used as the denominator when calculating percent complete.\n * **setCurrentValue(long value)**: This sets the current progress value. This will be reflected in\n the ''progress'' variable in the AsyncFunctionStatus response, and will be\n used as the numerator when calculating percent complete.\n* **custom_arguments** (also as **customArguments**): This is the map of provided custom arguments.\n\n\nFor scripts run asynchronously, the following JSON variables will be available\nin the *result* section when retrieving function status:\n\n* **status**: This is the HTTP status code as set by **response.setStatus(httpStatusCode)**\n(see above), or 200 if not explicitly set.\n\n* **headers**: These are HTTP headers as set by **response.addHeader(headerName, headerValue)**(see above).\n\n* **body**: This is the payload as set by **response.setBody(body)**\n(see above).\n\n* **output**: This is the result of any print statement (or equivalent) executed by the script. Newlines will most likely be encoded.\n\n* **result**: This is the return value from the script, if any.\n\nFor scripts run synchronously, the HTTP response code, headers, and body will reflect the use of the **response** variable. Version 1 of the\nendpoint is not able to run in a cluster.\n\n*NOTE: Version 2 endpoints are always asynchronous and can run in a cluster. *\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "userScripts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"fileName\": \"\",\n \"script\": \"\",\n \"language\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"relativeOutputDirectory\": \"\",\n \"customArguments\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"writeOutputToFileSystem\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "89e0807e-c1bd-48c1-98ea-714de647631f", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "userScripts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"Ruby User Script\",\n \"name\": \"Ruby User Script\",\n \"script\": \"$response.setStatus(200)\\n$response.setBody(\\\"result\\\":\\\"hello world\\\")\",\n \"language\": \"RUBY\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"functionKey\": \"c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f66cd8c6-6c26-46b0-8ea8-ee390618dfc0", "name": "Retrieves the list of existing user scripts", "request": { "name": "Retrieves the list of existing user scripts", "description": { "content": "Use this operation to view the list of existing user scripts.", "type": "text/plain" }, "url": { "path": [ "userScripts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "239b3ebd-1d53-45fa-8e8e-b980cce78b21", "name": "default response", "originalRequest": { "url": { "path": [ "userScripts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22751069-e8e0-4ea1-91cb-9dbf5aa6c338", "name": "Executes a user script", "request": { "name": "Executes a user script", "description": { "content": "Use this operation to execute a script that is in the user scripts\ndirectory. This is useful for extending the Nuix REST API to fit your needs.\nVersion 1 of this endpoint has been *deprecated*.\n\nEach script is injected with several common local variables, all of which are available both\nwith and without a leading dollar sign (**$**):\n\n* **current_case** (also as **currentCase**): This is the Java nuix.Case object. It is only\navailable in the case-specific endpoint.\n\n* **utilities**: This is the Java nuix.Utilities object for the current environment.\n\n* **request**: This is the Java HttpServletRequest object. It is only available in version 1 of the endpoint.\nThis variable is not available in version 2 of the endpoint. Use custom_arguments instead.\n\n* **response**: This provides methods for customising the object that is returned from the server.\nThese methods are:\n * **setStatus(inthttpStatusCode)**: This sets the HTTP status code.\n * **addHeader(String headerName, String headerValue)**: This adds a header to the actual HTTP response that comes back from the server.\n * **setBody(Object body)**: This sets the payload of the response.\n\n* **progress** : This provides methods for updating the progress of the script when run in an asynchronous\nmanner. These methods are:\n\n * **setStatus(String status)**: This sets an arbitrary status value. This will be reflected\n in the ''status'' variable in the AsyncFunctionStatus response.\n * **setEstimatedFinalValue(long value))**: This sets an estimate for the final progress value. This will\n be reflected in the ''total'' variable in the AsyncFunctionStatus response,\n and will be used as the denominator when calculating percent complete.\n * **setCurrentValue(long value)**: This sets the current progress value. This will be reflected in\n the ''progress'' variable in the AsyncFunctionStatus response, and will be\n used as the numerator when calculating percent complete.\n* **custom_arguments** (also as **customArguments**): This is the map of provided custom arguments.\n\n\nFor scripts run asynchronously, the following JSON variables will be available\nin the *result* section when retrieving function status:\n\n* **status**: This is the HTTP status code as set by **response.setStatus(httpStatusCode)**\n(see above), or 200 if not explicitly set.\n\n* **headers**: These are HTTP headers as set by **response.addHeader(headerName, headerValue)**(see above).\n\n* **body**: This is the payload as set by **response.setBody(body)**\n(see above).\n\n* **output**: This is the result of any print statement (or equivalent) executed by the script. Newlines will most likely be encoded.\n\n* **result**: This is the return value from the script, if any.\n\n\nFor scripts run synchronously, the HTTP response code, headers, and body will reflect the use of the **response** variable. Version 1 of the\nendpoint is not able to run in a cluster.\n\n*NOTE: Version 2 endpoints are always asynchronous and can run in a cluster.*\n", "type": "text/plain" }, "url": { "path": [ "userScripts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"fileName\": \"\",\n \"script\": \"\",\n \"language\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"relativeOutputDirectory\": \"\",\n \"customArguments\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"writeOutputToFileSystem\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fca7c3ef-f2a9-43bd-817f-91e3792e69e9", "name": "default response", "originalRequest": { "url": { "path": [ "userScripts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"Ruby User Script\",\n \"name\": \"Ruby User Script\",\n \"script\": \"$response.setStatus(200)\\n$response.setBody(\\\"result\\\":\\\"hello world\\\")\",\n \"language\": \"RUBY\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"functionKey\": \"c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5af76606-613d-4912-a980-c5ceb9fd9192", "name": "Search", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c655f039-12c3-4a6e-9e63-14bc61ff6d13", "name": "Returns a list of values for the specified property.", "request": { "name": "Returns a list of values for the specified property.", "description": { "content": "Use this operation to retrieve a list of values for the specified property. Property values will be returned for items matching the query.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "itemProperties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) Name of the property to retrieve values for" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"distinct\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a78a247b-b1a4-49e8-89ab-62505ed57e8e", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "itemProperties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" }, { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) Name of the property to retrieve values for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"distinct\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a47c48f-ba27-4521-a7f6-8cc5c29f2051", "name": "Performs a search", "request": { "name": "Performs a search", "description": { "content": "Use this operation to search a case. For large query strings, use the POST method.\n\nUse the following supported fields in the fieldList:\n\n* `all` - Returns all fields for the item.\n* `auditedSize` - Returns the item''s audited size.\n* `children` - Returns a list of the item''s children.\n* `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.\n* `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.\n* `comment` - Returns item comments.\n* `communication` - If the item is a communication, this returns item communication information.\n* `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.\n* `custodian` - Returns the custodian assigned to an item.\n* `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.\n* `date` - Returns the item date.\n* `descendants` - Gets the list of items which are descendants of this item.\n* `digests` - Returns a map of the computed digests for an item.\n* `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.\n* `duplicates` - Returns duplicates of this item.\n* `evidenceMetadata` - Returns custom evidence metadata for the item.\n* `exclusion` - Returns the reason for an item''s exclusion.\n* `family` - Returns a list of items in the same family.\n* `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.\n* `fileType` - Returns the name of the file type.\n* `guid` - Returns the item''s globally unique identifier (GUID).\n* `history` - Returns the item''s history in ascending order by date.\n* `id` - Returns the item''s ID.\n* `isAudited` - Tests whether the item is considered audited and returns true or false.\n* `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it. This returns\n true if the item had binary data at processing time that was not stored. This\n differs from isStored() as this method returns true if the item had binary\n data at processing time that was not stored.\n* `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned\n if stored binary exists. In this case, the source data isn''t required for\n binary export.\n* `isChatMessage` - Tests whether the item is a chat message.\n* `isChatConversation` - Tests whether the item is a chat conversation.\n* `isDeleted` - Tests whether the item was marked as deleted and returns true or false.\n* `isEmailThreadMember` - Tests whether the item is part of an email thread.\n* `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.\n* `isExcluded` - Tests whether the item was marked as excluded.\n* `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).\n* `isIncluded` - Tests whether the item is included and returns true or false.\n* `isLooseFile` - Tests whether the item is a loose file and returns true or false.\n* `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.\n* `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field\n is useful when you only need to know if a printed image exists for this item.\n This is faster and uses fewer resources than requesting the printedImageInfo\n field.\n* `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.\n* `isTextStored` - Tests hether the item has text stored against it in the database. In the event\n where you only want to know if the item had text but didn''t need the text\n this field is considerably faster and more conservative of resources than\n isTextAvailable.\n* `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.\n* `isTopLevel` - Tests whether this is a top-level item and returns true or false.\n* `itemCategory` - Returns the item category.\n* `kind` - Returns the item kind.\n* `language` - Returns the language identified by the item.\n* `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])\n if the name is blank.\n* `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.\n* `name` - Returns the item name.\n* `originalExtension` - Returns the original extension listed on the source file.\n* `parent` - Returns the parent of this item.\n* `path` - Returns an item list which represents the path from the root evidence container to the item.\n* `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.\n* `pathNames` - Returns a list of item names on the path from the root evidence container to the item.\n* `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.\n* `printedImageInfo` - Returns information about the printed image.\n* `properties` - Returns item properties.\n* `root` - Returns the root item. If this item is the root, the item itself is returned.\n* `rootUri` - Returns the item''s root URI as a string.\n* `tags` - Returns the item tags.\n* `text` - Returns the text of the item as a string.\n* `textHtml` - Returns the text of the item escaped for HTML.\n* `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.\n* `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.\n* `threadItems` - Returns items that are in the same discussion thread as this item.\n* `topLevelItem` - Returns the associated top-level item.\n* `topLevelItemDate` - Returns the associated top-level item date.\n* `type` - Returns the type name.\n* `typeLocalisedName` - Returns the type name, localised appropriately for display to users.\n* `uri` - Returns the item''s uniform resource identifier (URI) as a string.\n", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "query", "value": "", "description": "Identifies what items should be returned. If a query is not supplied it defaults to an empty string, which returns all items." }, { "disabled": false, "key": "s", "value": "", "description": "The index of the first record that should be returned. Defaults to 0. Maintained for backward compatibility." }, { "disabled": false, "key": "p", "value": "", "description": "The number of records that should be returned. Defaults to 100 records. Maintained for backward compatibility." }, { "disabled": false, "key": "startIndex", "value": "", "description": "The index of the first record that should be returned. Defaults to 0." }, { "disabled": false, "key": "numberOfRecordsRequested", "value": "", "description": "The number of records that should be returned per page. Defaults to 100 records." }, { "disabled": false, "key": "limit", "value": "", "description": "The maximum number of results to return." }, { "disabled": false, "key": "deduplication", "value": "", "description": "Deduplicate content based on the Value field selection. The default is none, no deduplication." }, { "disabled": false, "key": "maintainDeduplicatedSearchOrder", "value": "true", "description": "Specifies whether the original search result order based on the query should be maintained for deduplicated results. Default is true. Setting this field to false may improve deduplication performance especially for Elasticsearch cases. This field is ignored if a sort field has been specified." }, { "disabled": false, "key": "metadataProfile", "value": "", "description": "Defines the metadata profile to be appied to the results. Needed to get custom metadata. Defaults to no metadata profile." }, { "disabled": false, "key": "fieldList", "value": "", "description": "List of fields to be returned for each item in the results." }, { "disabled": false, "key": "fieldList", "value": "", "description": "List of fields to be returned for each item in the results." }, { "disabled": false, "key": "customMetadataField", "value": "", "description": "List of custom metadata to be returned for each item in the results. Maintained for backward compatibility." }, { "disabled": false, "key": "customMetadataField", "value": "", "description": "List of custom metadata to be returned for each item in the results. Maintained for backward compatibility." }, { "disabled": false, "key": "propertyList", "value": "", "description": "List of properties to be returned for each item in the results." }, { "disabled": false, "key": "propertyList", "value": "", "description": "List of properties to be returned for each item in the results." }, { "disabled": false, "key": "itemParameterizedFields", "value": "", "description": "Specifies parameterized fields in a key/value pair separated by a colon. * `entities` - corresponds to item.getEntities. (e.g., \"entities:company\") * `serializedItem` - returns a serialized copy of the item. (e.g., \"seralizedItem:topLevelItem\") * `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., \"textTruncated:10000\") * `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., \"thumbnail:200x200\") * `nearDupeThreshold` - (e.g., \"nearDupeThreshold:0.9\") * `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., \"emailThreadCluster:cluster-1\")" }, { "disabled": false, "key": "itemParameterizedFields", "value": "", "description": "Specifies parameterized fields in a key/value pair separated by a colon. * `entities` - corresponds to item.getEntities. (e.g., \"entities:company\") * `serializedItem` - returns a serialized copy of the item. (e.g., \"seralizedItem:topLevelItem\") * `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., \"textTruncated:10000\") * `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., \"thumbnail:200x200\") * `nearDupeThreshold` - (e.g., \"nearDupeThreshold:0.9\") * `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., \"emailThreadCluster:cluster-1\")" }, { "disabled": false, "key": "entities", "value": "", "description": "List of entity names to include in response (e.g. company,email)" }, { "disabled": false, "key": "entities", "value": "", "description": "List of entity names to include in response (e.g. company,email)" }, { "disabled": false, "key": "showAvailableThumbnails", "value": "false", "description": "Show thumbnails that have been generated" }, { "disabled": false, "key": "useCache", "value": "false", "description": "Specifies whether the results should be loaded from and stored in cache." }, { "disabled": false, "key": "forceCacheDelete", "value": "false", "description": "Specifies whether the cached results should be deleted before performing the search." }, { "disabled": false, "key": "sortField", "value": "", "description": "Any field in the metadata profile which you want to sort by.\n\nUse the following supported fields in the sortFields:\nposition,kind,duplicates\n" }, { "disabled": false, "key": "sortOrder", "value": "", "description": "Sets the sort order for the results." }, { "disabled": false, "key": "relationType", "value": "", "description": "The relation to apply to the found items." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0341774b-8392-496d-af88-f82a437ee3eb", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "" }, { "key": "s", "value": "" }, { "key": "p", "value": "" }, { "key": "startIndex", "value": "" }, { "key": "numberOfRecordsRequested", "value": "" }, { "key": "limit", "value": "" }, { "key": "deduplication", "value": "" }, { "key": "maintainDeduplicatedSearchOrder", "value": "true" }, { "key": "metadataProfile", "value": "" }, { "key": "fieldList", "value": "" }, { "key": "fieldList", "value": "" }, { "key": "customMetadataField", "value": "" }, { "key": "customMetadataField", "value": "" }, { "key": "propertyList", "value": "" }, { "key": "propertyList", "value": "" }, { "key": "itemParameterizedFields", "value": "" }, { "key": "itemParameterizedFields", "value": "" }, { "key": "entities", "value": "" }, { "key": "entities", "value": "" }, { "key": "showAvailableThumbnails", "value": "false" }, { "key": "useCache", "value": "false" }, { "key": "forceCacheDelete", "value": "false" }, { "key": "sortField", "value": "" }, { "key": "sortOrder", "value": "" }, { "key": "relationType", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"request\": {\n \"caseId\": \"string\",\n \"query\": \"string\",\n \"sortField\": \"string\",\n \"sortOrder\": \"asc\",\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": 7043,\n \"limit\": 2613,\n \"deduplication\": \"none\",\n \"maintainDeduplicatedSearchOrder\": true,\n \"metadataProfile\": \"string\",\n \"fieldList\": [\n \"string\",\n \"string\"\n ],\n \"customMetadataList\": [\n \"string\",\n \"string\"\n ],\n \"propertyList\": [\n \"string\",\n \"string\"\n ],\n \"itemParameterizedFields\": [\n \"string\",\n \"string\"\n ],\n \"showAvailableThumbnails\": false,\n \"useCache\": false,\n \"forceCacheDelete\": false,\n \"searchRetry\": 7003,\n \"relationType\": \"topTypes\",\n \"entities\": [\n \"string\",\n \"string\"\n ],\n \"property\": [\n \"string\",\n \"string\"\n ],\n \"field\": [\n \"string\",\n \"string\"\n ],\n \"s\": 3274,\n \"p\": 1925,\n \"customMetadataField\": [\n \"string\",\n \"string\"\n ]\n },\n \"startedOn\": 4262,\n \"completedOn\": 3574,\n \"elapsedTimeForSearch\": 2456,\n \"elapsedTimeForSort\": 806,\n \"elapsedTimeForMarshal\": 2800,\n \"elapsedTimeForDeduplicate\": 311,\n \"elapsedTotal\": 5426,\n \"metadataItems\": [\n \"string\",\n \"string\"\n ],\n \"localizedMetadataItems\": [\n \"string\",\n \"string\"\n ],\n \"metadataItemDetails\": [\n {\n \"name\": \"string\",\n \"localisedName\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"localisedName\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"resultList\": [\n {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n {\n \"key_0\": {}\n }\n ],\n \"count\": 2352,\n \"deduplicatedCount\": 8021\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "904b38dd-3c25-402f-8ac3-19df10228974", "name": "Performs a large search", "request": { "name": "Performs a large search", "description": { "content": "Use this operation to perform a large search on a case. This operation doesn't have a maximum query string length.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"caseId\": \"\",\n \"query\": \"\",\n \"sortField\": \"\",\n \"sortOrder\": \"asc\",\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": \"\",\n \"limit\": \"\",\n \"deduplication\": \"\",\n \"maintainDeduplicatedSearchOrder\": true,\n \"metadataProfile\": \"\",\n \"fieldList\": [\n \"\",\n \"\"\n ],\n \"customMetadataList\": [\n \"\",\n \"\"\n ],\n \"propertyList\": [\n \"\",\n \"\"\n ],\n \"itemParameterizedFields\": [\n \"\",\n \"\"\n ],\n \"showAvailableThumbnails\": \"\",\n \"useCache\": false,\n \"forceCacheDelete\": false,\n \"searchRetry\": \"\",\n \"relationType\": \"\",\n \"entities\": [\n \"\",\n \"\"\n ],\n \"property\": [\n \"\",\n \"\"\n ],\n \"field\": [\n \"\",\n \"\"\n ],\n \"s\": \"\",\n \"p\": \"\",\n \"customMetadataField\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "365c1ebd-1ab8-4bc3-8f29-9450fa9051b1", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) Case identification token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"caseId\": \"\",\n \"query\": \"\",\n \"sortField\": \"\",\n \"sortOrder\": \"asc\",\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": \"\",\n \"limit\": \"\",\n \"deduplication\": \"\",\n \"maintainDeduplicatedSearchOrder\": true,\n \"metadataProfile\": \"\",\n \"fieldList\": [\n \"\",\n \"\"\n ],\n \"customMetadataList\": [\n \"\",\n \"\"\n ],\n \"propertyList\": [\n \"\",\n \"\"\n ],\n \"itemParameterizedFields\": [\n \"\",\n \"\"\n ],\n \"showAvailableThumbnails\": \"\",\n \"useCache\": false,\n \"forceCacheDelete\": false,\n \"searchRetry\": \"\",\n \"relationType\": \"\",\n \"entities\": [\n \"\",\n \"\"\n ],\n \"property\": [\n \"\",\n \"\"\n ],\n \"field\": [\n \"\",\n \"\"\n ],\n \"s\": \"\",\n \"p\": \"\",\n \"customMetadataField\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "body": "{\n \"request\": {\n \"caseId\": \"\",\n \"query\": \"\",\n \"sortField\": \"\",\n \"sortOrder\": \"asc\",\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": \"\",\n \"limit\": \"\",\n \"deduplication\": \"\",\n \"maintainDeduplicatedSearchOrder\": true,\n \"metadataProfile\": \"\",\n \"fieldList\": [\n \"\",\n \"\"\n ],\n \"customMetadataList\": [\n \"\",\n \"\"\n ],\n \"propertyList\": [\n \"\",\n \"\"\n ],\n \"itemParameterizedFields\": [\n \"\",\n \"\"\n ],\n \"showAvailableThumbnails\": \"\",\n \"useCache\": false,\n \"forceCacheDelete\": false,\n \"searchRetry\": \"\",\n \"relationType\": \"\",\n \"entities\": [\n \"\",\n \"\"\n ],\n \"property\": [\n \"\",\n \"\"\n ],\n \"field\": [\n \"\",\n \"\"\n ],\n \"s\": \"\",\n \"p\": \"\",\n \"customMetadataField\": [\n \"\",\n \"\"\n ]\n },\n \"startedOn\": 6838,\n \"completedOn\": 9661,\n \"elapsedTimeForSearch\": 4546,\n \"elapsedTimeForSort\": 4986,\n \"elapsedTimeForMarshal\": 3399,\n \"elapsedTimeForDeduplicate\": 7507,\n \"elapsedTotal\": 1393,\n \"metadataItems\": [\n \"string\",\n \"string\"\n ],\n \"localizedMetadataItems\": [\n \"string\",\n \"string\"\n ],\n \"metadataItemDetails\": [\n {\n \"name\": \"string\",\n \"localisedName\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"localisedName\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"resultList\": [\n {\n \"key_0\": {},\n \"key_1\": {}\n },\n {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {},\n \"key_3\": {}\n }\n ],\n \"count\": 8515,\n \"deduplicatedCount\": 1738\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e80cf1ba-562f-433c-a6a3-2308556b454d", "name": "Performs an asynchronous search", "request": { "name": "Performs an asynchronous search", "description": { "content": "Use this operation to perform an asynchronous search.", "type": "text/plain" }, "url": { "path": [ "cases", ":caseId", "asyncFunctions", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) caseId" } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"caseId\": \"\",\n \"query\": \"\",\n \"sortField\": \"\",\n \"sortOrder\": \"asc\",\n \"startIndex\": 0,\n \"numberOfRecordsRequested\": \"\",\n \"limit\": \"\",\n \"deduplication\": \"\",\n \"maintainDeduplicatedSearchOrder\": true,\n \"metadataProfile\": \"\",\n \"fieldList\": [\n \"\",\n \"\"\n ],\n \"customMetadataList\": [\n \"\",\n \"\"\n ],\n \"propertyList\": [\n \"\",\n \"\"\n ],\n \"itemParameterizedFields\": [\n \"\",\n \"\"\n ],\n \"showAvailableThumbnails\": \"\",\n \"useCache\": false,\n \"forceCacheDelete\": false,\n \"searchRetry\": \"\",\n \"relationType\": \"\",\n \"entities\": [\n \"\",\n \"\"\n ],\n \"property\": [\n \"\",\n \"\"\n ],\n \"field\": [\n \"\",\n \"\"\n ],\n \"s\": \"\",\n \"p\": \"\",\n \"customMetadataField\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb1a01f2-a3f4-42c9-bd11-04fd0b91f613", "name": "default response", "originalRequest": { "url": { "path": [ "cases", ":caseId", "asyncFunctions", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "caseId", "description": "(Required) caseId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"fieldList\": [\n \"name\",\n \"guid\",\n \"date\",\n \"fileSize\",\n \"isBinaryAvailable\",\n \"kind\",\n \"fileType\",\n \"pathNames\"\n ],\n \"useCache\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\",\n \"location\": \"http://localhost:8080/svc/v1/asyncFunctions/c2b5a20b-3cd1-4eb3-b600-6fa909ba0949\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c9827ef-8b15-42ed-b834-6430d1dcd91d", "name": "Validates a list of queries", "request": { "name": "Validates a list of queries", "description": { "content": "Use this operation to validate queries.", "type": "text/plain" }, "url": { "path": [ "validation", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "27591e97-03bb-4aa7-af9d-a7ca840e3085", "name": "default response", "originalRequest": { "url": { "path": [ "validation", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"valid\": false,\n \"query\": \"string\",\n \"exception\": \"string\"\n },\n {\n \"valid\": false,\n \"query\": \"string\",\n \"exception\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f6f66b96-4a2c-458e-904f-482ffb63a6cc", "name": "System", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "02c62b66-3fca-4924-9705-40a481d092e8", "name": "Detects whether OCR functionality is available", "request": { "name": "Detects whether OCR functionality is available", "description": { "content": "Use this operation to determine whether optical character recognition (OCR) functionality is available.", "type": "text/plain" }, "url": { "path": [ "resources", "ocr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "86b25a7b-88d3-4945-bacd-bacb6271896b", "name": "default response", "originalRequest": { "url": { "path": [ "resources", "ocr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70cf4676-8579-4637-8e57-a5f1e5a00267", "name": "Detects whether FFmpeg/FFprobe functionality is available", "request": { "name": "Detects whether FFmpeg/FFprobe functionality is available", "description": { "content": "Use this operation to determine whether FFmpeg and FFprobe functionality is available.", "type": "text/plain" }, "url": { "path": [ "resources", "ffmpeg" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "19a5e37d-5a20-437b-a6b0-d83fb924ff54", "name": "default response", "originalRequest": { "url": { "path": [ "resources", "ffmpeg" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "725c1325-7611-4a4e-a492-d075adbc8ae5", "name": "Detects whether Lotus Notes functionality is available", "request": { "name": "Detects whether Lotus Notes functionality is available", "description": { "content": "Use this operation to determine whether Lotus Notes functionality is available.", "type": "text/plain" }, "url": { "path": [ "resources", "lotusnotes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "260eb237-404a-4b0c-9df1-293e8b775937", "name": "default response", "originalRequest": { "url": { "path": [ "resources", "lotusnotes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93ea0c24-e6d7-443a-88a7-bec0dad1d85d", "name": "Provides a summary of third party dependencies and their availability.", "request": { "name": "Provides a summary of third party dependencies and their availability.", "description": { "content": "Use this operation to determine whether third party dependencies have been installed and what functionality is available.", "type": "text/plain" }, "url": { "path": [ "resources", "thirdparty" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b939c1fb-eee0-48bd-95d9-2c566985c84f", "name": "default response", "originalRequest": { "url": { "path": [ "resources", "thirdparty" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"description\": \"Lotus Notes\",\n \"version\": null,\n \"message\": \"Not found\",\n \"comment\": \"

Lotus notes was not found. Lotus Notes files will not be able to be processed.

Version 9.0 is required.

Due to licensing restrictions, this software cannot be redistributed; you will need to install it separately.

\",\n \"attentionRequired\": true\n },\n {\n \"description\": \"FFmpeg / FFprobe\",\n \"version\": \"0.1\",\n \"message\": \"Found\",\n \"comment\": \"

FFmpeg and FFprobe were found. Multimedia metadata will be extracted and video image data will be processed.

\",\n \"attentionRequired\": false\n },\n {\n \"description\": \"Nuix OCR\",\n \"version\": \"12.4.7\",\n \"message\": \"Found Version 12.4.7\",\n \"comment\": \"

The Nuix OCR add-on 12.4.7 was found on your system.

It will be possible to perform OCR.

\",\n \"attentionRequired\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfc425c8-9ec3-4194-a387-5c28981cd03b", "name": "Gets a Nuix system property", "request": { "name": "Gets a Nuix system property", "description": { "content": "Use this operation to get the value of a Nuix system property. This operation is limited to Nuix system properties only and the property must start with the string \"nuix.\"", "type": "text/plain" }, "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bc9d79af-3146-44e6-ad6a-d2916c1c445a", "name": "default response", "originalRequest": { "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"nuix.registry.servers\",\n \"value\": \"server.domain.com\",\n \"previousValue\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dc69920-19a0-4a96-98ad-099984f8b321", "name": "Invalid Property", "originalRequest": { "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"INVALID_REQUEST_FORMAT\",\n \"developerMessage\": \"badproperty is an unrecognized Nuix system property.\",\n \"userMessage\": null,\n \"additionalInfo\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec264200-6542-4825-be59-3258ce7e621e", "name": "Sets a Nuix system property", "request": { "name": "Sets a Nuix system property", "description": { "content": "Use this operation to set a Nuix system property. This operation is limited to Nuix system properties only and the value is not persisted between application restarts. You may want to do this if there is a specific Nuix system property required for an ingestion, export, or OCR operation. This is NOT threadsafe and could affect other users.", "type": "text/plain" }, "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "29e73775-5522-4e76-9adb-f05f2784bbdc", "name": "default response", "originalRequest": { "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"new_value\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"nuix.registry.servers\",\n \"value\": \"server.domain.com\",\n \"previousValue\": \"oldserver.domain.com\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e056785-f13f-424f-bfbe-5b54bf0aae55", "name": "Invalid Property", "originalRequest": { "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"value\": \"new_value\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"INVALID_REQUEST_FORMAT\",\n \"developerMessage\": \"badproperty is an unrecognized Nuix system property.\",\n \"userMessage\": null,\n \"additionalInfo\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ddeb4ef-ca0d-40a6-8bf7-8b0b71050a3f", "name": "Clears a Nuix system property", "request": { "name": "Clears a Nuix system property", "description": { "content": "Use this operation to clear a Nuix system property. This operation is limited to Nuix system properties only and the value is not persisted between application restarts. You may want to do this if you previously set a specific Nuix system property required for an ingestion, export, or OCR operation. This is NOT threadsafe and could affect other users.", "type": "text/plain" }, "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "546d1031-301a-47c1-a3eb-8f24b2113358", "name": "default response", "originalRequest": { "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"name\": \"nuix.registry.servers\",\n \"value\": null,\n \"previousValue\": \"oldserver.domain.com\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffe0b3dd-241e-4a66-bfb8-98a373725c8b", "name": "Invalid Property", "originalRequest": { "url": { "path": [ "system", "properties", ":propertyName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "propertyName", "description": "(Required) The name of the system property." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"INVALID_REQUEST_FORMAT\",\n \"developerMessage\": \"badproperty is an unrecognized Nuix system property.\",\n \"userMessage\": null,\n \"additionalInfo\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5757f5a9-511f-49c8-b33c-77e09031ba83", "name": "Generates a system diagnostics ZIP file", "request": { "name": "Generates a system diagnostics ZIP file", "description": { "content": "Use this operation to create a ZIP file with system diagnostics information. The diagnostics include log files, product versions, environment variables, system properties, licence properties, drive information, process information, JVM arguments and settings, and installed and not installed dependencies. Please note that when operating in a cluster this endpoint will return system diagnostics from ALL nodes in the cluster.", "type": "text/plain" }, "url": { "path": [ "system", "diagnostics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includeResourceDetails", "value": "false", "description": "Creates an additional diagnostics file that includes the engine version, search cache, system resources, function queue, and active user count." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": null }, "response": [ { "id": "52a06b44-992c-41d9-a03a-e309b77a7cc8", "name": "default response", "originalRequest": { "url": { "path": [ "system", "diagnostics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeResourceDetails", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f121c812-52df-48e4-b1c9-c429bd3ef511", "name": "Generates a system diagnostics ZIP file asyncronously.", "request": { "name": "Generates a system diagnostics ZIP file asyncronously.", "description": { "content": "Use this operation to create a ZIP file with system diagnostics information asyncronously. The diagnostics include log files, product versions, environment variables, system properties, licence properties, drive information, process information, JVM arguments and settings, and installed and not installed dependencies. The endpoint return an async function id which should be polled until complete. The result can be used to retrieve the download from the /downloads/{downloadId} endpoint. Please note that when operating in a cluster this endpoint will return diagnostics from ALL nodes in the cluster.", "type": "text/plain" }, "url": { "path": [ "system", "diagnostics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includeResourceDetails", "value": "false", "description": "Creates an additional diagnostics file that includes the engine version, search cache, system resources, function queue, and active user count." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "auth": null }, "response": [ { "id": "785e2b97-c65f-42a2-a1f6-6a6dcdc3e9ac", "name": "default response", "originalRequest": { "url": { "path": [ "system", "diagnostics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeResourceDetails", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"functionKey\": \"string\",\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "773afa25-6237-4181-8eb5-6a81bf75d93c", "name": "Downloads a file given an id.", "request": { "name": "Downloads a file given an id.", "description": { "content": "Use this endpoint to download a file from the server given a download id.", "type": "text/plain" }, "url": { "path": [ "downloads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The id of the download." } ] }, "header": [ { "key": "Accept", "value": "application/json,application/octet-stream" } ], "method": "GET", "auth": null }, "response": [ { "id": "76445713-c4f8-4ded-8549-c8148790112d", "name": "default response", "originalRequest": { "url": { "path": [ "downloads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The id of the download." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/json,application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json,application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a25eeb21-047a-4a19-958d-8051dd96c21c", "name": "Download does not exist", "originalRequest": { "url": { "path": [ "downloads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The id of the download." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"serverId\": \"nuix-restful-server-1\",\n \"errorCode\": \"RESOURCE_NOT_FOUND\",\n \"developerMessage\": \"The resource of type 'DOWNLOAD' and identifier 'c2284dc7-1ec4-47bf-b5c0-af91ae2e8087' could not be found.\",\n \"userMessage\": \"The resource of type 'DOWNLOAD' and identifier 'c2284dc7-1ec4-47bf-b5c0-af91ae2e8087' could not be found.\",\n \"additionalInfo\": {\n \"rootExceptionClass\": \"com.nuix.us.exception.i18n.I18nNotFoundException\",\n \"rootExceptionMessage\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee62680f-532e-4160-b065-e194c88ad431", "name": "Checks whether the REST server is running", "request": { "name": "Checks whether the REST server is running", "description": { "content": "Use this operation to ensure the RESTful services are working. This is a heartbeat test that checks whether the REST server is up and running.", "type": "text/plain" }, "url": { "path": [ "system", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f69a1fe7-946c-4ea3-b1e9-dec1afcd2a28", "name": "default response", "originalRequest": { "url": { "path": [ "system", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d85381b6-09c9-40de-818c-979469f53e4e", "name": "Retrieves information about Nuix RESTful services", "request": { "name": "Retrieves information about Nuix RESTful services", "description": { "content": "Use this operation to view version information about your Nuix RESTful services configuration. Authentication is optional for this endpoint. If the user is not authenticated then sensitive information about the service is not returned.\n", "type": "text/plain" }, "url": { "path": [ "about" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7d8faf6c-13f7-440c-b6d3-2a8e9f02efe1", "name": "default response", "originalRequest": { "url": { "path": [ "about" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v2+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v2+json" } ], "body": "{\n \"server\": \"http://localhost:8080\",\n \"serverId\": \"my-rest-server\",\n \"startupTime\": null,\n \"nuixRestfulVersion\": null,\n \"engineVersion\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4dcbf04-e234-41fb-9ef3-a29ead6508e2", "name": "Returns the list of charsets on the system.", "request": { "name": "Returns the list of charsets on the system.", "description": { "content": "Use this operation to view the list of system charsets.\n", "type": "text/plain" }, "url": { "path": [ "charsets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e1273c6d-6e97-4b1e-bec5-0e76fc193d93", "name": "A list of system charsets.", "originalRequest": { "url": { "path": [ "charsets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "nuix-auth-token", "value": "" }, { "key": "Accept", "value": "application/vnd.nuix.v1+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.nuix.v1+json" } ], "body": "[\n {\n \"name\": \"UTF-8\",\n \"displayName\": \"UTF-8\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "/nuix-restful-service/svc", "key": "baseUrl" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "nuix-auth-token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "6ce7ad26-15ab-4c0b-8ec0-1f5b088ea6b7", "name": "Nuix REST-API Reference", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Welcome to the Nuix REST API documentation. From here you can access all available REST APIs and execute queries against your running REST instance. \n\n# Authentication Changes\n\n The `nuix-auth-token` header is being deprecated in favor of standard JWT. The header will be removed in a\n future release. Until the removal of the header, the Nuix REST API will accept the JWT in either the\n `nuix-auth-token` header field or the `Authorization` header field prefixed by `Bearer`.\n\n\nContact Support:\n Name: Nuix", "type": "text/plain" } } }