RcsApi

class ansys.hps.client.rcs.api.RcsApi(client)

Wraps around the RCS root endpoints.

Parameters:

clientClient

HPS client object.

Initialize the RmsApi object.

Methods

RcsApi.get_api_info()	Get information on the RMS API the client is connected to.
RcsApi.health_check()	Check the health of the RCS API.
RcsApi.register_instance(data)	Register an instance to RCS.
RcsApi.unregister_instance(data)	Unregister an instance from RCS.

Attributes

RcsApi.health	Health status of the RCS API.
RcsApi.url	URL of the API.
RcsApi.version	API version.