Nuix · Schema

AboutResponseV1

Schema for AboutResponseV1 in Nuix REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name Type Description
server string The URL of the server as configured by the publicURL property.
nuixRestfulVersion string The version of the service.
engineVersion string The version of the Nuix engine the service is running.
startupTime string The startup time of the server in milliseconds.
serverId string The server ID as configured by the serverId property.
licenceSource object The license source. Note this is always server.
casePrivilegeSecurityEnabled boolean Unused and deprecated. Always false.
itemSecurityEnabled boolean Unused and deprecated. Always false.
specificLicenseRequiredAtLogin boolean Unused and deprecated. Always false.
userManagementUrl string Unused and deprecated. Always empty string.
textHighlightingEnabled boolean Unused and deprecated. Return value as configured based on the textHighlightingEnabled property.
phraseHighlightingEnabled boolean Unused and deprecated. Return value as configured based on the phraseHighlightingEnabled property.
View JSON Schema on GitHub

JSON Schema

nuix-rest-aboutresponsev1.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-aboutresponsev1.json",
  "title": "AboutResponseV1",
  "description": "Schema for AboutResponseV1 in Nuix REST API",
  "type": "object",
  "properties": {
    "server": {
      "type": "string",
      "description": "The URL of the server as configured by the publicURL property.",
      "deprecated": true
    },
    "nuixRestfulVersion": {
      "type": "string",
      "description": "The version of the service.",
      "deprecated": true
    },
    "engineVersion": {
      "type": "string",
      "description": "The version of the Nuix engine the service is running.",
      "deprecated": true
    },
    "startupTime": {
      "type": "string",
      "description": "The startup time of the server in milliseconds.",
      "deprecated": true
    },
    "serverId": {
      "type": "string",
      "description": "The server ID as configured by the serverId property.",
      "deprecated": true
    },
    "licenceSource": {
      "description": "The license source.  Note this is always server.",
      "deprecated": true
    },
    "casePrivilegeSecurityEnabled": {
      "type": "boolean",
      "description": "Unused and deprecated.  Always false.",
      "deprecated": true
    },
    "itemSecurityEnabled": {
      "type": "boolean",
      "description": "Unused and deprecated. Always false.",
      "deprecated": true
    },
    "specificLicenseRequiredAtLogin": {
      "type": "boolean",
      "description": "Unused and deprecated. Always false.",
      "deprecated": true
    },
    "userManagementUrl": {
      "type": "string",
      "description": "Unused and deprecated.  Always empty string.",
      "deprecated": true
    },
    "textHighlightingEnabled": {
      "type": "boolean",
      "description": "Unused and deprecated.  Return value as configured based on the textHighlightingEnabled property.",
      "deprecated": true
    },
    "phraseHighlightingEnabled": {
      "type": "boolean",
      "description": "Unused and deprecated.  Return value as configured based on the phraseHighlightingEnabled property.",
      "deprecated": true
    }
  }
}