Nuix · Schema
AsyncFunctionStatusesResponse
Schema for AsyncFunctionStatusesResponse in Nuix REST API
ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence
Properties
| Name | Type | Description |
|---|---|---|
| executeImmediate | array | List of AsyncFunctionStatus objects for Async functions which are queued to execute. |
| singleItemQueue | array | List of AsyncFunctionStatus object for Async functions which are in the single item queue. |
| paused | boolean | True if the task is paused. False otherwise. |
| pausedBy | string | The auth token of the user that paused the task. |
| pausedUntil | integer | The time the task is paused until. |
| caseQueues | array | List of queued case functions. |
| totalRunningFunctions | integer | The total number of running tasks. |
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-asyncfunctionstatusesresponse.json",
"title": "AsyncFunctionStatusesResponse",
"description": "Schema for AsyncFunctionStatusesResponse in Nuix REST API",
"type": "object",
"properties": {
"executeImmediate": {
"type": "array",
"description": "List of AsyncFunctionStatus objects for Async functions which are queued to execute.",
"items": {
"$ref": "#/components/schemas/AsyncFunctionStatusObject"
}
},
"singleItemQueue": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AsyncFunctionStatusObject"
},
"description": "List of AsyncFunctionStatus object for Async functions which are in the single item queue."
},
"paused": {
"type": "boolean",
"description": "True if the task is paused. False otherwise."
},
"pausedBy": {
"type": "string",
"description": "The auth token of the user that paused the task."
},
"pausedUntil": {
"type": "integer",
"format": "int64",
"description": "The time the task is paused until."
},
"caseQueues": {
"type": "array",
"description": "List of queued case functions.",
"items": {
"$ref": "#/components/schemas/CaseFunctionQueue"
}
},
"totalRunningFunctions": {
"type": "integer",
"format": "int32",
"description": "The total number of running tasks."
}
}
}