StateProcessResult¶
Example Json Object
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
📄 Description: Data transfer object representing the outcome of a state process, including its status, associated metadata, and relevant business context to facilitate decision-making and process management.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
success |
boolean |
false |
none |
Indicates whether the process completed successfully, providing essential feedback for operational decision-making. |
cancelled |
boolean |
false |
none |
Indicates whether the process has been cancelled, providing essential status information for tracking and reporting purposes. |
failureMessage |
string |
false |
none |
Descriptive message detailing the reason for a process failure, providing insights for troubleshooting and resolution. |
warningMessage |
string |
false |
none |
Contains a message indicating any warnings related to the state process result, providing users with essential insights for decision-making. |