Table of Contents

ClientApi

All URIs are relative to http://localhost

Method Description
connect_client Connects a client to the ConnectionRestApi service and returns a unique identifier for the client.
get_version Gets the IdeaStatica API assembly version.

connect_client

str connect_client()

Connects a client to the ConnectionRestApi service and returns a unique identifier for the client.

Parameters

This endpoint does not need any parameter.

Return type

str

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

For client instantiation instructions, refer to the [README] documentation.

def connect_clientExampleFunc(api_client):
    

    try:
        # Connects a client to the ConnectionRestApi service and returns a unique identifier for the client.
        api_response = api_client.client.connect_client()
        print("The response of ClientApi->connect_client:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling ClientApi->connect_client: %s\n" % e)

Code Samples

Looking for a code sample? request some help on our discussion page.

REST Usage

Http Request

All URIs are relative to http://localhost

GET /api/5/clients/connect-client

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 OK -
500 Internal Server Error -

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

get_version

str get_version()

Gets the IdeaStatica API assembly version.

Parameters

This endpoint does not need any parameter.

Return type

str

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

For client instantiation instructions, refer to the [README] documentation.

def get_versionExampleFunc(api_client):
    

    try:
        # Gets the IdeaStatica API assembly version.
        api_response = api_client.client.get_version()
        print("The response of ClientApi->get_version:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling ClientApi->get_version: %s\n" % e)

Code Samples

Looking for a code sample? request some help on our discussion page.

REST Usage

Http Request

All URIs are relative to http://localhost

GET /api/5/clients/idea-service-version

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
500 Internal Server Error -

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

Edit this page