GetObjectIdListRequest#
| Attribute Name | Data Type | Description | 
|---|---|---|
| object_type | The type of objects to retrieve. To get all object ids, omit it. | |
| parent_no | int | Unique identifier of the parent object. Omit this parameter if the object type does not have a parent or you want to get result for all parent objects. | 
| model_id | Unique identifier of the model. If not specified, the active model is used. | 
Associated Data Types
BaseDataRequest#
GlobalSettingsTreeTable#
| Attribute Name | Data Type | Description | 
|---|---|---|
| rows | List[GlobalSettingsRow] | 
GlobalSettingsRow#
| Attribute Name | Data Type | Description | 
|---|---|---|
| key | str | |
| caption | str | |
| symbol | str | |
| value | ||
| unit | str | |
| rows | List[GlobalSettingsRow] | 
GetDesignSettingsRequest#
| Attribute Name | Data Type | Description | 
|---|---|---|
| addon | ||
| model_id | Unique identifier of the model. Active model is used if this field is not set. | 
SetDesignSettingsRequest#
| Attribute Name | Data Type | Description | 
|---|---|---|
| addon | ||
| global_settings_tree_table | ||
| model_id | Unique identifier of the model. Active model is used if this field is not set. | 
HasResultsRequest#
| Attribute Name | Data Type | Description | 
|---|---|---|
| loading | Allowed types: OBJECT_TYPE_CONSTRUCTION_STAGE, OBJECT_TYPE_DESIGN_SITUATION, OBJECT_TYPE_LOAD_CASE, OBJECT_TYPE_LOAD_COMBINATION, OBJECT_TYPE_RESULT_COMBINATION | |
| model_id | Unique identifier of the model. Active model is used if this field is not set. | 
GetResultTableRequest#
| Attribute Name | Data Type | Description | 
|---|---|---|
| table | ||
| loading | Allowed types: OBJECT_TYPE_CONSTRUCTION_STAGE, OBJECT_TYPE_DESIGN_SITUATION, OBJECT_TYPE_LOAD_CASE, OBJECT_TYPE_LOAD_COMBINATION, OBJECT_TYPE_RESULT_COMBINATION | |
| model_id | Unique identifier of the model. Active model is used if this field is not set. | |
| member_axes_system | Specifies Member Axes System of the results | |
| support_coordinate_system | Specifies Support Coordinate System of the results | 
CalculateSpecificRequest#
SaveModelAsRequest#
| Attribute Name | Data Type | Description | 
|---|---|---|
| model_id | Unique identifier of the model Active model is used if this field is not set. | |
| path | str | Path to the model | 
| results | bool | When enabled, the model is saved together with the calculated results | 
| printout_reports | bool | When enabled, the printout reports are saved |