Table of Contents

TemplateApi

All URIs are relative to http://localhost

Method Description
apply_template Apply the connection template applyTemplateParam on the connection connectionId in the project projectId.
create_con_template Create a template for the connection connectionId in the project projectId.
create_template_from_connection Create a reusable connection template from connectionId with structured metadata. Captures the connection's parametric design — operations, parameters, parametric links, analysis info, loads and clipping/section data — and returns it as a contemp payload alongside metadata inherited from the source connection (design code, version, manufacturing type, member typology, and operation/parameter/link counts).
delete Delete specific template.
delete_all Delete all templates in connection.
explode Explode specific template (delete parameters, keep operations).
explode_all Explode all templates (delete parameters, keep operations).
get_default_template_mapping Get the default mappings for the application of the connection template passed in templateToApply on connectionId in the project projectId.
get_template_common_operation_properties Get common properties for specific template.
get_template_in_connection Retrieves a specific template by its ID for a given connection within a project.
get_templates_in_connection Retrieves a list of templates associated with a specific connection within a project.
load_defaults Load parameter defaults for specific template.
update_template_common_operation_properties Set common properties for specific template.

apply_template

ConTemplateApplyResult apply_template(project_id, connection_id, con_template_apply_param=con_template_apply_param)

Apply the connection template applyTemplateParam on 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 apply the template.
con_template_apply_param ConTemplateApplyParam Template to apply. [optional]

Return type

ConTemplateApplyResult

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_template_apply_param import ConTemplateApplyParam
from ideastatica_connection_api.models.con_template_apply_result import ConTemplateApplyResult
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def apply_templateExampleFunc(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 apply the template.
    con_template_apply_param = ideastatica_connection_api.ConTemplateApplyParam() # ConTemplateApplyParam | Template to apply. (optional)

    try:
        # Apply the connection template applyTemplateParam on the connection connectionId in the project projectId.
        api_response = api_client.template.apply_template(project_id, connection_id, con_template_apply_param=con_template_apply_param)
        print("The response of TemplateApi->apply_template:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling TemplateApi->apply_template: %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/5/projects/{projectId}/connections/{connectionId}/apply-template

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]

create_con_template

str create_con_template(project_id, connection_id)

Create a template 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 to be converted to a template.

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 create_con_templateExampleFunc(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 be converted to a template.

    try:
        # Create a template for the connection connectionId in the project projectId.
        api_response = api_client.template.create_con_template(project_id, connection_id)
        print("The response of TemplateApi->create_con_template:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling TemplateApi->create_con_template: %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/projects/{projectId}/connections/{connectionId}/get-template

Authorization

No authorization required

HTTP request headers

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

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]

create_template_from_connection

ConTemplateCreateResult create_template_from_connection(project_id, connection_id)

Create a reusable connection template from connectionId with structured metadata. Captures the connection's parametric design — operations, parameters, parametric links, analysis info, loads and clipping/section data — and returns it as a contemp payload alongside metadata inherited from the source connection (design code, version, manufacturing type, member typology, and operation/parameter/link counts).

Parameters

Name Type Description Notes
project_id str The unique identifier of the opened project in the ConnectionRestApi service.
connection_id int The source of the requested template.

Return type

ConTemplateCreateResult

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_template_create_result import ConTemplateCreateResult
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def create_template_from_connectionExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the opened project in the ConnectionRestApi service.
    connection_id = 56 # int | The source of the requested template.

    try:
        # Create a reusable connection template from connectionId with structured metadata.  Captures the connection's parametric design — operations, parameters, parametric links,  analysis info, loads and clipping/section data — and returns it as a contemp payload  alongside metadata inherited from the source connection (design code, version,  manufacturing type, member typology, and operation/parameter/link counts).
        api_response = api_client.template.create_template_from_connection(project_id, connection_id)
        print("The response of TemplateApi->create_template_from_connection:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling TemplateApi->create_template_from_connection: %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/5/projects/{projectId}/connections/{connectionId}/templates/create-from-connection

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 -
422 Unprocessable Content -
500 Internal Server Error -

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

delete

delete(project_id, connection_id, template_id)

Delete specific template.

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 containing the template.
template_id str The ID of the template to delete.

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 deleteExampleFunc(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 containing the template.
    template_id = 'template_id_example' # str | The ID of the template to delete.

    try:
        # Delete specific template.
        api_client.template.delete(project_id, connection_id, template_id)
    except Exception as e:
        print("Exception when calling TemplateApi->delete: %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/5/projects/{projectId}/connections/{connectionId}/templates/{templateId}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/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]

delete_all

delete_all(project_id, connection_id)

Delete all templates in 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 delete templates.

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_allExampleFunc(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 delete templates.

    try:
        # Delete all templates in connection.
        api_client.template.delete_all(project_id, connection_id)
    except Exception as e:
        print("Exception when calling TemplateApi->delete_all: %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/5/projects/{projectId}/connections/{connectionId}/templates

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/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]

explode

explode(project_id, connection_id, template_id)

Explode specific template (delete parameters, keep operations).

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 containing the template.
template_id str The ID of the template to explode.

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 explodeExampleFunc(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 containing the template.
    template_id = 'template_id_example' # str | The ID of the template to explode.

    try:
        # Explode specific template (delete parameters, keep operations).
        api_client.template.explode(project_id, connection_id, template_id)
    except Exception as e:
        print("Exception when calling TemplateApi->explode: %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/5/projects/{projectId}/connections/{connectionId}/templates/{templateId}/explode

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
204 No Content -
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]

explode_all

explode_all(project_id, connection_id)

Explode all templates (delete parameters, keep operations).

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 whose templates are to be exploded.

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 explode_allExampleFunc(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 whose templates are to be exploded.

    try:
        # Explode all templates (delete parameters, keep operations).
        api_client.template.explode_all(project_id, connection_id)
    except Exception as e:
        print("Exception when calling TemplateApi->explode_all: %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/5/projects/{projectId}/connections/{connectionId}/templates/explode

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
204 No Content -
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_default_template_mapping

TemplateConversions get_default_template_mapping(project_id, connection_id, con_template_mapping_get_param=con_template_mapping_get_param)

Get the default mappings for the application of the connection template passed in templateToApply on connectionId in the project projectId.

The result IdeaStatiCa.Api.Connection.Model.TemplateConversionsDefault mapping to apply the passed template. It can be modified by a user and used for the application of a template M:IdeaStatiCa.ConnectionRestApi.Controllers.TemplateController.ApplyConnectionTemplateAsync(System.Guid,System.Int32,IdeaStatiCa.Api.Connection.Model.ConTemplateApplyParam,System.Threading.CancellationToken) method.

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 get default mapping.
con_template_mapping_get_param ConTemplateMappingGetParam Data of the template to get default mapping. [optional]

Return type

TemplateConversions

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_template_mapping_get_param import ConTemplateMappingGetParam
from ideastatica_connection_api.models.template_conversions import TemplateConversions
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def get_default_template_mappingExampleFunc(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 get default mapping.
    con_template_mapping_get_param = ideastatica_connection_api.ConTemplateMappingGetParam() # ConTemplateMappingGetParam | Data of the template to get default mapping. (optional)

    try:
        # Get the default mappings for the application of the connection template passed in templateToApply  on connectionId in the project projectId.
        api_response = api_client.template.get_default_template_mapping(project_id, connection_id, con_template_mapping_get_param=con_template_mapping_get_param)
        print("The response of TemplateApi->get_default_template_mapping:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling TemplateApi->get_default_template_mapping: %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/5/projects/{projectId}/connections/{connectionId}/get-default-mapping

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_template_common_operation_properties

ConOperationCommonProperties get_template_common_operation_properties(project_id, connection_id, template_id)

Get common properties for specific template.

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 containing the template.
template_id str The ID of the template.

Return type

ConOperationCommonProperties

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_operation_common_properties import ConOperationCommonProperties
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def get_template_common_operation_propertiesExampleFunc(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 containing the template.
    template_id = 'template_id_example' # str | The ID of the template.

    try:
        # Get common properties for specific template.
        api_response = api_client.template.get_template_common_operation_properties(project_id, connection_id, template_id)
        print("The response of TemplateApi->get_template_common_operation_properties:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling TemplateApi->get_template_common_operation_properties: %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/projects/{projectId}/connections/{connectionId}/templates/{templateId}/common-properties

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]

get_template_in_connection

ConConnectionTemplate get_template_in_connection(project_id, connection_id, template_instance_id)

Retrieves a specific template by its ID for a given connection within a project.

Parameters

Name Type Description Notes
project_id str The unique identifier of the project containing the connection.
connection_id int The identifier of the connection.
template_instance_id int The instance identifier of the template to retrieve.

Return type

ConConnectionTemplate

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_connection_template import ConConnectionTemplate
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def get_template_in_connectionExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the project containing the connection.
    connection_id = 56 # int | The identifier of the connection.
    template_instance_id = 56 # int | The instance identifier of the template to retrieve.

    try:
        # Retrieves a specific template by its ID for a given connection within a project.
        api_response = api_client.template.get_template_in_connection(project_id, connection_id, template_instance_id)
        print("The response of TemplateApi->get_template_in_connection:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling TemplateApi->get_template_in_connection: %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/projects/{projectId}/connections/{connectionId}/templates/{templateInstanceId}

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]

get_templates_in_connection

List[ConConnectionTemplate] get_templates_in_connection(project_id, connection_id)

Retrieves a list of templates associated with a specific connection within a project.

This method fetches the templates applied to a connection within a project. Each template includes details such as its ID within the project, template id, members, operations, parameters, and associated common properties.

Parameters

Name Type Description Notes
project_id str The unique identifier of the project containing the connection.
connection_id int The identifier of the connection for which templates are to be retrieved.

Return type

List[ConConnectionTemplate]

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_connection_template import ConConnectionTemplate
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def get_templates_in_connectionExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the project containing the connection.
    connection_id = 56 # int | The identifier of the connection for which templates are to be retrieved.

    try:
        # Retrieves a list of templates associated with a specific connection within a project.
        api_response = api_client.template.get_templates_in_connection(project_id, connection_id)
        print("The response of TemplateApi->get_templates_in_connection:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling TemplateApi->get_templates_in_connection: %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/projects/{projectId}/connections/{connectionId}/templates

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]

load_defaults

ParameterUpdateResponse load_defaults(project_id, connection_id, template_id)

Load parameter defaults for specific template.

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 containing the template.
template_id str The ID of the template whose parameter defaults are loaded.

Return type

ParameterUpdateResponse

Example

Required Imports

import ideastatica_connection_api
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 load_defaultsExampleFunc(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 containing the template.
    template_id = 'template_id_example' # str | The ID of the template whose parameter defaults are loaded.

    try:
        # Load parameter defaults for specific template.
        api_response = api_client.template.load_defaults(project_id, connection_id, template_id)
        print("The response of TemplateApi->load_defaults:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling TemplateApi->load_defaults: %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/5/projects/{projectId}/connections/{connectionId}/templates/{templateId}/load-defaults

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 -
422 Unprocessable Content -
500 Internal Server Error -

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

update_template_common_operation_properties

update_template_common_operation_properties(project_id, connection_id, template_id, con_operation_common_properties=con_operation_common_properties)

Set common properties for specific template.

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 containing the template.
template_id str The ID of the template.
con_operation_common_properties ConOperationCommonProperties Common properties to apply (specify material IDs, or keep as null). [optional]

Return type

void (empty response body)

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_operation_common_properties import ConOperationCommonProperties
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

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

def update_template_common_operation_propertiesExampleFunc(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 containing the template.
    template_id = 'template_id_example' # str | The ID of the template.
    con_operation_common_properties = ideastatica_connection_api.ConOperationCommonProperties() # ConOperationCommonProperties | Common properties to apply (specify material IDs, or keep as null). (optional)

    try:
        # Set common properties for specific template.
        api_client.template.update_template_common_operation_properties(project_id, connection_id, template_id, con_operation_common_properties=con_operation_common_properties)
    except Exception as e:
        print("Exception when calling TemplateApi->update_template_common_operation_properties: %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/5/projects/{projectId}/connections/{connectionId}/templates/{templateId}/common-properties

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
204 No Content -
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]