Response types received when using EMXMLInvoker

The following table shows the types of responses you receive when using the EMXMLInvoker:

Response type

Description

response_operationName

EXAMPLE: response_unregister

This response is the final result of a successful synchronous request.

The first field is status and the value is OK except for response_track_jobs where it can also be PARTIAL_SUCCESS. For more information see the note in SOAP envelope for Control-M/EM requests and responses.

Asynchronous requests: The response contains the token ID that should be used to poll Control‑M/EM for the final result of the request.

fault_operationName

EXAMPLE: fault_unregister

Synchronous requests: This response indicates a failure.

Asynchronous requests: This response indicates a failure in sending the request to the Control-M/Server. For example, if the user is not authorized, Control‑M/Server is unavailable, does not have the right status, or the request has invalid values.

response_poll_operationName

EXAMPLE: response_poll_add_condition

This response is received as an answer to a polling request.

The first field is status.

A value of EXEC indicates that the request is still being processed by the Control-M/Server and the response has not yet arrived.

A value of either OK or PARTIAL_SUCCESS indicates the final response of an asynchronous request.

The value PARTIAL_SUCCESS can appear only in response_poll_order_force. For more information, see the note in SOAP envelope for Control-M/EM requests and responses.

fault_poll_operationName

EXAMPLE: fault_poll_add_condition

This is an error response, which is received from a polling request.

This response can be an error returned from Control‑M/Server. For example, an order request for a nonexistent table, or an error from the communication layer between Control‑M/EM and Control-M/Server, such as a request timeout or communication loss.

Parent Topic

Control-M/EM API requests