getOperation

  • Asynchronous API methods use getOperation to check the status of an operation.

  • The getOperation method requires the operationId as a string in the GetOperationRequest.

  • CommonException is thrown if an error occurs during the operation.

  • Possible error codes include AUTHORIZATION_FAIL, INTERNAL_SERVER_ERROR, and INVALID_OPERATION_ID.

Asynchronous API methods return a result before the processing is complete. Use getOperation to retrieve the status of an asynchronous operation using its operationId.

Method signature

public Operation getOperation( GetOperationRequest request) throws CommonException;

GetOperationRequest

Property name Value Required Description
operationId string Yes The operation ID.

Error behavior

If an error occurs, the library throws a CommonException containing one of the following error codes:

Error code
AUTHORIZATION_FAIL (if the reseller doesn't own the operation)
INTERNAL_SERVER_ERROR
INVALID_OPERATION_ID