ParameterApi

All URIs are relative to http://localhost

Method	Description
delete_parameters	Delete all parameters and parameter model links for the connection connectionId in the project projectId.
evaluate_expression	Evaluate the expression and return the result. For more details see documentation about parameters: https://developer.ideastatica.com/docs/api/api_parameters_getting_started.html or https://developer.ideastatica.com/docs/api/api_parameter_reference_guide.html
get_parameters	Gets all parameters defined for the specified project and connection.
update	Updates parameters for the specified connection in the project with the values provided.

delete_parameters

delete_parameters(project_id, connection_id)

Delete all parameters and parameter model links for the connection connectionId in the project projectId.

Parameters

Name	Type	Description	Notes
project_id	str	The unique identifier of the opened project in the ConnectionRestApi service.
connection_id	int	Id of the connection where to delete parameters.

Return type

void (empty response body)

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 delete_parametersExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the opened project in the ConnectionRestApi service.
    connection_id = 56 # int | Id of the connection where to delete parameters.

    try:
        # Delete all parameters and parameter model links for the connection connectionId in the project projectId.
        api_client.parameter.delete_parameters(project_id, connection_id)
    except Exception as e:
        print("Exception when calling ParameterApi->delete_parameters: %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

DELETE /api/4/projects/{projectId}/connections/{connectionId}/parameters

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
404	Not Found	-
500	Internal Server Error	-

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

evaluate_expression

str evaluate_expression(project_id, connection_id, body=body)

Evaluate the expression and return the result. For more details see documentation about parameters: https://developer.ideastatica.com/docs/api/api_parameters_getting_started.html or https://developer.ideastatica.com/docs/api/api_parameter_reference_guide.html

Parameters

Name	Type	Description	Notes
project_id	str	The unique identifier of the opened project in the ConnectionRestApi service.
connection_id	int	Id of the connection to use for evaluation expression.
body	str	Expression to evaluate. See the API documentation for supported syntax and examples: https://developer.ideastatica.com/docs/api/api_parameters_getting_started.html	[optional]

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 evaluate_expressionExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the opened project in the ConnectionRestApi service.
    connection_id = 56 # int | Id of the connection to use for evaluation expression.
    body = 'body_example' # str | Expression to evaluate. See the API documentation for supported syntax and examples: https://developer.ideastatica.com/docs/api/api_parameters_getting_started.html (optional)

    try:
        # Evaluate the expression and return the result.  For more details see documentation about parameters:  https://developer.ideastatica.com/docs/api/api_parameters_getting_started.html  or  https://developer.ideastatica.com/docs/api/api_parameter_reference_guide.html
        api_response = api_client.parameter.evaluate_expression(project_id, connection_id, body=body)
        print("The response of ParameterApi->evaluate_expression:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling ParameterApi->evaluate_expression: %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

POST /api/4/projects/{projectId}/connections/{connectionId}/evaluate-expression

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-
422	Unprocessable Content	-
500	Internal Server Error	-

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

get_parameters

List[IdeaParameter] get_parameters(project_id, connection_id, include_hidden=include_hidden)

Gets all parameters defined for the specified project and connection.

Parameters

Name	Type	Description	Notes
project_id	str	The unique identifier of the opened project in the ConnectionRestApi service.
connection_id	int	The ID of the connection from which to retrieve parameters.
include_hidden	bool	If true, includes hidden parameters in the result.	[optional] [default to False]

Return type

List[IdeaParameter]

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.idea_parameter import IdeaParameter
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def get_parametersExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the opened project in the ConnectionRestApi service.
    connection_id = 56 # int | The ID of the connection from which to retrieve parameters.
    include_hidden = False # bool | If true, includes hidden parameters in the result. (optional) (default to False)

    try:
        # Gets all parameters defined for the specified project and connection.
        api_response = api_client.parameter.get_parameters(project_id, connection_id, include_hidden=include_hidden)
        print("The response of ParameterApi->get_parameters:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling ParameterApi->get_parameters: %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/4/projects/{projectId}/connections/{connectionId}/parameters

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-
500	Internal Server Error	-

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

update

ParameterUpdateResponse update(project_id, connection_id, idea_parameter_update=idea_parameter_update)

Updates parameters for the specified connection in the project with the values provided.

Parameters

Name	Type	Description	Notes
project_id	str	The unique identifier of the opened project in the ConnectionRestApi service.
connection_id	int	The ID of the connection to update.
idea_parameter_update	List[IdeaParameterUpdate]	New values of parameters to apply.	[optional]

Return type

ParameterUpdateResponse

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.idea_parameter_update import IdeaParameterUpdate
from ideastatica_connection_api.models.parameter_update_response import ParameterUpdateResponse
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def updateExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the opened project in the ConnectionRestApi service.
    connection_id = 56 # int | The ID of the connection to update.
    idea_parameter_update = [ideastatica_connection_api.IdeaParameterUpdate()] # List[IdeaParameterUpdate] | New values of parameters to apply. (optional)

    try:
        # Updates parameters for the specified connection in the project with the values provided.
        api_response = api_client.parameter.update(project_id, connection_id, idea_parameter_update=idea_parameter_update)
        print("The response of ParameterApi->update:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling ParameterApi->update: %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

PUT /api/4/projects/{projectId}/connections/{connectionId}/parameters

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-
422	Unprocessable Content	-
500	Internal Server Error	-

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

Table of Contents

ParameterApi

delete_parameters

Parameters

Return type

Example

Code Samples

REST Usage

Http Request

Authorization

HTTP request headers

HTTP response details

evaluate_expression

Parameters

Return type

Example

Code Samples

REST Usage

Http Request

Authorization

HTTP request headers

HTTP response details

get_parameters

Parameters

Return type

Example

Code Samples

REST Usage

Http Request

Authorization

HTTP request headers

HTTP response details

update

Parameters

Return type

Example

Code Samples

REST Usage

Http Request

Authorization

HTTP request headers

HTTP response details