Skip to main content
GET
/
platform
/
admin
/
proposals
/
{proposalId}
/
execute
/
status
Get proposal execution status
curl --request GET \
  --url https://api.example.com/platform/admin/proposals/{proposalId}/execute/status
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Checks the current execution status of a transaction proposal on the blockchain, including transaction hash, confirmation status, and any execution errors. Use this endpoint to monitor the progress of blockchain transactions after execution has been initiated.

​
Input

  • proposalId (long, required) — The unique identifier of the transaction proposal.

​
Output

Returns a containing:
  • proposalId (long) — The proposal identifier.
  • executionStatus (string) — Current status (Submitted, Pending, Confirmed, Failed).
  • transactionHash (string) — Blockchain transaction hash if available.
  • confirmations (int) — Number of block confirmations received.
  • errorMessage (string) — Error details if execution failed.
  • executedDate (DateTime) — Timestamp when execution was initiated.

​
Examples

Request 
GET /api/platform/tenant/transaction-proposals/10001/execution-status
Response (200 OK) 
{
  "proposalId": 10001,
  "executionStatus": "Confirmed",
  "transactionHash": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef1234567890abcdef1234567890",
  "confirmations": 12,
  "errorMessage": null,
  "executedDate": "2024-11-03T15:45:00Z",
  "confirmedDate": "2024-11-03T15:50:00Z"
}

​
Errors

  • 400 Bad Request: Proposal ID is invalid or malformed.
  • 401 Unauthorized: Caller is not authenticated.
  • 403 Forbidden: Caller lacks permission to view execution status.
  • 404 Not Found: Proposal with specified ID does not exist or has not been executed.
  • 500 Internal Server Error: An unexpected error occurred.

​
Notes

Execution status updates as the blockchain transaction progresses through submission, pending, and confirmation stages. Poll this endpoint to track transaction finalization. Failed executions will include error details to help diagnose issues.

Path Parameters

​
proposalId
integer<int64>
required

The unique identifier of the transaction proposal.

Query Parameters

​
api-version
string | null

Response

Execution status retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.