cm_client.ToolsResourceApi

All URIs are relative to https://localhost/api/v42

echo

ApiEcho echo(message=message)

Echoes the provided message back to the caller.

Echoes the provided message back to the caller.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ToolsResourceApi(cm_client.ApiClient(configuration))
message = 'Hello, World!' # str | The message to echo back (optional) (default to Hello, World!)

try:
    # Echoes the provided message back to the caller.
    api_response = api_instance.echo(message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ToolsResourceApi->echo: %s\n" % e)

Parameters

Return type

ApiEcho

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

echo_error

ApiEcho echo_error(message=message)

Throws an error containing the given input message.

Throws an error containing the given input message. This is what an error response looks like.

    {      "message": "An error message",      "causes": [ "A list of causes", "Potentially null" ]    }  

The message field contains a description of the error. The causes field, if not null, contains a list of causes for the error.

Note that this never returns an echoMessage. Instead, the result (and all error results) has the above structure.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ToolsResourceApi(cm_client.ApiClient(configuration))
message = 'Default error message' # str | The error message to echo (optional) (default to Default error message)

try:
    # Throws an error containing the given input message.
    api_response = api_instance.echo_error(message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ToolsResourceApi->echo_error: %s\n" % e)

Parameters

Return type

ApiEcho

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]