n4.cuwo.messages.OperationFinished

Whenever an operation completes (successfully or not), the CUWO container will notify the workflow via an OperationFinished message.

The message has the following structure:

{
  "@type": "n4.cuwo.messages.OperationFinished",
  "id": "...",
  "status": {
    "@type": "n4.cuwo.OperationStatus",
    "value": "..."
  },
  "result": "...",
  "errorMessage": "...",
  "statusInformations": [...]
}

The various member provide the information necessary for the operation:

  • id - The ID of the operation that was finished.
  • status.value - The status of the operation.
  • result - The actual operation result value. May be available for status value "COMPLETED" and "FAILED".
  • errorMessage - An optional error message. May be available if status is other than "COMPLETED".
  • statusInformations - Optional list of instances of n4.apis.status.StatusInformation. May be available for status value "FAILED".

The status.value of the command is a string with the possible values:

  • "COMPLETED" - The operation was completed successfully
  • "CANCELLED_BY_USER" - The operation was cancelled by the user
  • "FAILED" - The operation failed

The result depends on the type of operation that was completed.