Checking the Status of a Function

Learn how to check on the status of a running function.

When submitting requests to perform long running asynchronous tasks, a simple response like the following example is returned which includes a functionKey and location.

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

The functionKey is a unique identifier for the function that can be used to query its status. The location URL provides a direct request to the /asyncFunctions/{key} endpoint. Making calls to this endpoint with the returned functionKey will return details about the associated function.

While an asynchronous function is running, this endpoint can by queried to check the status of the function and eventually retrieve the final output of the request.

Last modified April 22, 2021