ExperimentalAsyncCallsResource Resource

Async calls REST API endpoint. (Experimental currently) Represents the status of launched asynchronous calls, including their progress, results and partial results. Please note that endpoints of this resource are expected to be changed in an incompatible way in any of the future releases.

GET /experimental-async-calls/ids

List of asynchronous call IDs.

Response Body
media type data type description
application/json array of string (JSON) List of allocated IDs

Example

Request
GET /experimental-async-calls/ids
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /experimental-async-calls/{id}

Status of an asynchronous call.

Request Parameters
name type description default constraints
id path ID of the asynchronous call. ID is assigned by the REST API endpoint used to launch the asynchronous task.    
need-partial-result query if true then result may contain partial result. false boolean
Response Body
media type data type description
application/json AsyncCallDto (JSON) Call status. The returned object's result and partialResult fields depend on the represented task. Type of these fields are determined by the REST API endpoint used to launch the task.

Example

Request
GET /experimental-async-calls/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : "...",
  "task" : {
    "id" : "...",
    "name" : "...",
    "totalWork" : 12345,
    "workUnit" : "...",
    "worked" : 12345,
    "done" : true,
    "cancelled" : true,
    "startTimeMs" : 12345,
    "runningDurationMs" : 12345
  },
  "result" : { },
  "partialResult" : { },
  "error" : {
    "statusCode" : 12345,
    "statusReasonPhrase" : "...",
    "statusClass" : "...",
    "message" : "...",
    "exceptionMessage" : "...",
    "exceptionStackTrace" : "..."
  }
}

POST /experimental-async-calls/{id}/cancel

Sets the cancel request state. NOTE: This does not guarantee that the call will be actually cancelled/terminated.

Request Parameters
name type description
id path ID of the asynchronous call. ID is assigned by the REST API endpoint used to launch the asynchronous task.

Example

Request
POST /experimental-async-calls/{id}/cancel
Content-Type: */*

                
...
Response
HTTP/1.1 201 Created