Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageRequest

Description

Requests result of a request, which previously ended by a "pending" exception and returned [RpcPendingExceptionData].
You can call this method periodically until you recieve the result or until failure is indicated in the response to this request.

Properties

Name	JsonSchemaType	Description
abort	boolean	If abort=true, this is a batch job and the result of last batch is available, then other batches are ignored, the request finishes and the results of processed batches is returned. If abort=true and this is a request, which supports internal abort (e.g. [RpcGenerateReportRequest]), then the request is aborted. Even with abort=true, it is necessary to call this method the same way as without it. I.e. call periodically until you recieve the result or until failure is indicated in the response to this request.
jobId	integer	ID of the job, returned previously in [RpcPendingExceptionData].

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageResponse

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageRequest",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageRequest"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageRequest": {
            "$ref": "#/definitions/RpcGetPendingMessageRequest"
        }
    },
    "definitions": {
        "RpcGetPendingMessageRequest": {
            "additionalProperties": false,
            "required": [
                "jobId"
            ],
            "type": "object",
            "properties": {
                "abort": {
                    "type": "boolean"
                },
                "jobId": {
                    "type": "integer"
                }
            }
        }
    }
}