Nuix · Schema

AsyncFunctionStatusObject

Schema for AsyncFunctionStatusObject in Nuix REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name	Type	Description
done	boolean	True if the task is done. False otherwise.
cancelled	boolean	True if the task is cancelled. False otherwise.
result	object	The result of the task.
token	string	The user token for the task.
functionKey	string	The function key to use when querying status.
progress	number	Progress of the Async function
total	number	The total.
percentComplete	number	The percent complete.
updatedOn	integer	Date at which the Async function was last updated represented in milliseconds since the epoch.
status	string	Status of the Async function.
statusId	string	A status ID if available.
requestTime	integer	Date at which the Async function request was made represented in milliseconds since the epoch.
startTime	integer	Date at which the Async function request was started represented in milliseconds since the epoch.
finishTime	integer	Date at which the Async function request was finished represented in milliseconds since the epoch.
caseId	string	Case identification token
caseName	string	Name of the case on which the Async function was performed.
hasSuccessfullyCompleted	boolean	Indicated whether the Async function has successfully completed.
friendlyName	string	Friendly name for the Async function.
caseLocation	string	Location of the case on which the Async function was performed.
requestor	string	Username for user who requested the Async function.
licenseShortName	string	The license used when executing the Async fucntion.
action	string	Action if available.
options	object	Options used during the execution of the Async function.
participatingInCaseFunctionQueue	boolean	True if participating in the case function queue. False otherwise.
processedBy	string	The server ID that processed the task.
error	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-asyncfunctionstatusobject.json",
  "title": "AsyncFunctionStatusObject",
  "description": "Schema for AsyncFunctionStatusObject in Nuix REST API",
  "type": "object",
  "properties": {
    "done": {
      "type": "boolean",
      "description": "True if the task is done.  False otherwise."
    },
    "cancelled": {
      "type": "boolean",
      "description": "True if the task is cancelled.  False otherwise."
    },
    "result": {
      "type": "object",
      "description": "The result of the task."
    },
    "token": {
      "type": "string",
      "description": "The user token for the task."
    },
    "functionKey": {
      "type": "string",
      "description": "The function key to use when querying status."
    },
    "progress": {
      "type": "number",
      "description": "Progress of the Async function"
    },
    "total": {
      "type": "number",
      "description": "The total."
    },
    "percentComplete": {
      "type": "number",
      "description": "The percent complete."
    },
    "updatedOn": {
      "type": "integer",
      "description": "Date at which the Async function was last updated represented in milliseconds since the epoch."
    },
    "status": {
      "type": "string",
      "description": "Status of the Async function."
    },
    "statusId": {
      "type": "string",
      "description": "A status ID if available."
    },
    "requestTime": {
      "type": "integer",
      "description": "Date at which the Async function request was made represented in milliseconds since the epoch."
    },
    "startTime": {
      "type": "integer",
      "description": "Date at which the Async function request was started represented in milliseconds since the epoch."
    },
    "finishTime": {
      "type": "integer",
      "description": "Date at which the Async function request was finished represented in milliseconds since the epoch."
    },
    "caseId": {
      "type": "string",
      "description": "Case identification token"
    },
    "caseName": {
      "type": "string",
      "description": "Name of the case on which the Async function was performed."
    },
    "hasSuccessfullyCompleted": {
      "type": "boolean",
      "description": "Indicated whether the Async function has successfully completed."
    },
    "friendlyName": {
      "type": "string",
      "description": "Friendly name for the Async function."
    },
    "caseLocation": {
      "type": "string",
      "description": "Location of the case on which the Async function was performed."
    },
    "requestor": {
      "type": "string",
      "description": "Username for user who requested the Async function."
    },
    "licenseShortName": {
      "type": "string",
      "description": "The license used when executing the Async fucntion."
    },
    "action": {
      "type": "string",
      "description": "Action if available."
    },
    "options": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      },
      "description": "Options used during the execution of the Async function."
    },
    "participatingInCaseFunctionQueue": {
      "type": "boolean",
      "description": "True if participating in the case function queue.  False otherwise."
    },
    "processedBy": {
      "type": "string",
      "description": "The server ID that processed the task."
    },
    "error": {
      "$ref": "#/components/schemas/ClusteredRestErrorResponse"
    }
  }
}